Inventory Client

Download schema

Update all reservation lines

PUT

https://api.entur.io/inventory

/v1/reservations/{reservationId}/reservation-lines

Update all reservation lines on a reservation

Update all reservation lines › path Parameters

reservationId

integer · int64 · required · style: simple

Id of the reservation to update lines on

Update all reservation lines › Headers

ET-Client-Name

string · style: simple

Entur Client Header. It is required that all consumers identify themselves by using this header. Entur will deploy strict rate-limiting policies on API-consumers who do not identify with a header and reserves the right to block unidentified consumers. The structure of ET-Client-Name should be: <company>-<application>.

X-Correlation-Id

string · style: simple

Correlation id

Update all reservation lines › Request Body

UpdatedReservationLine[]

List of updated reservation line specifications

Updated reservation line specification

UpdatedReservationLine

id

integer · int64 · required

productId

string · required

amount

integer · int32 · required

status

string · enum · required

Enum values:

DRAFT

CONFIRMED

EXPIRED

CANCELLED

DRAFT_CANCELLATION

CONFIRMED_CANCELLATION

RELEASING

Update all reservation lines › Responses

200

ReservationLineResponseV1[]

ReservationLineResponseV1

id

integer · int64 · required

productId

string · required

amount

integer · int32 · required

created

string · date-time · required

changed

string · date-time · required

status

string · enum · required

Enum values:

DRAFT

CONFIRMED

EXPIRED

CANCELLED

DRAFT_CANCELLATION

CONFIRMED_CANCELLATION

RELEASING

Add reservation line to reservation

POST

https://api.entur.io/inventory

/v1/reservations/{reservationId}/reservation-lines

Add a reservation line to an existing reservation.

Add reservation line to reservation › path Parameters

reservationId

integer · int64 · required · style: simple

Id of the reservation to add lines to

Add reservation line to reservation › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Add reservation line to reservation › Request Body

Updated spec of reservation line

ReservationLine

productId

string · required

amount

integer · int32 · required

status

string · enum · required

Enum values:

DRAFT

CONFIRMED

EXPIRED

CANCELLED

DRAFT_CANCELLATION

CONFIRMED_CANCELLATION

RELEASING

Add reservation line to reservation › Responses

Created

ReservationLineResponseV1

id

integer · int64 · required

productId

string · required

amount

integer · int32 · required

created

string · date-time · required

changed

string · date-time · required

status

string · enum · required

Enum values:

DRAFT

CONFIRMED

EXPIRED

CANCELLED

DRAFT_CANCELLATION

CONFIRMED_CANCELLATION

RELEASING

Update reservation line

PUT

https://api.entur.io/inventory

/v1/reservations/{reservationId}/reservation-lines/{reservationLineId}

Update a single reservation line

Update reservation line › path Parameters

reservationId

integer · int64 · required · style: simple

Id of the reservation to update a reservation line on.

reservationLineId

integer · int64 · required · style: simple

Id of the reservation line to update.

Update reservation line › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Update reservation line › Request Body

Updated spec of reservation line

ReservationLine

productId

string · required

amount

integer · int32 · required

status

string · enum · required

Enum values:

DRAFT

CONFIRMED

EXPIRED

CANCELLED

DRAFT_CANCELLATION

CONFIRMED_CANCELLATION

RELEASING

Update reservation line › Responses

200

ReservationLineResponseV1

id

integer · int64 · required

productId

string · required

amount

integer · int32 · required

created

string · date-time · required

changed

string · date-time · required

status

string · enum · required

Enum values:

DRAFT

CONFIRMED

EXPIRED

CANCELLED

DRAFT_CANCELLATION

CONFIRMED_CANCELLATION

RELEASING

Get available stock for a tripPattern

POST

https://api.entur.io/inventory

/v1/stock/query

Calculates available stock between a set of stopPlaces on separate DatedServiceJourneys

Get available stock for a tripPattern › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Get available stock for a tripPattern › Request Body

StockQuery[]

StockQuery

datedServiceJourney

string · required

origin

string · required

destination

string · required

Get available stock for a tripPattern › Responses

200

MultiStockResponse[]

MultiStockResponse

origin

string · required

destination

string · required

spannedDatedServiceJourneys

string[] · required

array · required

POST/v1/stock/query

curl https://api.entur.io/inventory/v1/stock/query \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '[
  {
    "datedServiceJourney": "datedServiceJourney",
    "origin": "origin",
    "destination": "destination"
  }
]'

Example Request Body

[
  {
    "datedServiceJourney": "datedServiceJourney",
    "origin": "origin",
    "destination": "destination"
  }
]

json

Example Responses

[
  {
    "origin": "origin",
    "destination": "destination",
    "spannedDatedServiceJourneys": [
      "string"
    ],
    "reservableStock": [
      {
        "aggregatedAvailability": 0,
        "nestingGroup": "nestingGroup",
        "priority": 0
      }
    ]
  }
]

json

application/json

Get reservations

GET

https://api.entur.io/inventory

/v1/reservations

Retrieves all registered reservations for an original dated service journey

Get reservations › query Parameters

datedServiceJourney

string · required · style: form · explode: true

The original dated service journey to find reservations for.

createdAfter

string · date-time · style: form · explode: true

Created after

changedAfter

string · date-time · style: form · explode: true

Changed after

origin

string · style: form · explode: true

origin

destination

string · style: form · explode: true

destination

product

string · style: form · explode: true

product

status

string · enum · style: form · explode: true

status

Enum values:

DRAFT

CONFIRMED

EXPIRED

CANCELLED

DRAFT_CANCELLATION

CONFIRMED_CANCELLATION

RELEASING

excludeInactiveReservations

boolean · style: form · explode: true

Exclude reservations that are not DRAFT nor CONFIRMED, defaults to false

Default: false

Get reservations › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Get reservations › Responses

200

ReservationResponseV1[]

ReservationResponseV1

id

integer · int64 · required

origin

string · required

destination

string · required

datedServiceJourney

string · required

created

string · date-time · required

changed

string · date-time · required

createdBy

string · required

ReservationLineResponseV1[] · required

orderId

string

Reserve stock

POST

https://api.entur.io/inventory

/v1/reservations

Reserves some amount of stock for use

Reserve stock › query Parameters

ownerOrganisationId

string · style: form · explode: true

Not applicable for Partners/operators. Used to filter between operator organisations

Reserve stock › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Reserve stock › Request Body

Specifies what should be reserved, in what quantity, and across what distance

Reservation

origin

string · required

destination

string · required

datedServiceJourneyId

string · required

ReservationLine[] · required

orderId

string

Reserve stock › Responses

Created

ReservationResponseV1

id

integer · int64 · required

origin

string · required

destination

string · required

datedServiceJourney

string · required

created

string · date-time · required

changed

string · date-time · required

createdBy

string · required

ReservationLineResponseV1[] · required

orderId

string

POST/v1/reservations

curl https://api.entur.io/inventory/v1/reservations \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "origin": "origin",
  "destination": "destination",
  "datedServiceJourneyId": "datedServiceJourneyId",
  "orderId": "orderId",
  "reservationLines": [
    {
      "productId": "productId",
      "amount": 0,
      "status": "DRAFT"
    }
  ]
}'

Example Request Body

{
  "origin": "origin",
  "destination": "destination",
  "datedServiceJourneyId": "datedServiceJourneyId",
  "orderId": "orderId",
  "reservationLines": [
    {
      "productId": "productId",
      "amount": 0,
      "status": "DRAFT"
    }
  ]
}

json

Example Responses

{
  "id": 0,
  "origin": "origin",
  "destination": "destination",
  "datedServiceJourney": "datedServiceJourney",
  "created": "2024-08-25T15:00:00Z",
  "changed": "2024-08-25T15:00:00Z",
  "createdBy": "createdBy",
  "orderId": "orderId",
  "reservationLines": [
    {
      "id": 0,
      "productId": "productId",
      "amount": 0,
      "created": "2024-08-25T15:00:00Z",
      "changed": "2024-08-25T15:00:00Z",
      "status": "DRAFT"
    }
  ]
}

json

application/json

Reserve stock for multiple legs

POST

https://api.entur.io/inventory

/v1/reservations/batch

Reserves some amount of stock for use

Reserve stock for multiple legs › query Parameters

ownerOrganisationId

string · style: form · explode: true

Not applicable for Partners/operators. Used to filter between operator organisations

Reserve stock for multiple legs › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Reserve stock for multiple legs › Request Body

Reservation[]

Specifies what should be reserved, in what quantity, and across what distance

Reservation

origin

string · required

destination

string · required

datedServiceJourneyId

string · required

ReservationLine[] · required

orderId

string

Reserve stock for multiple legs › Responses

Created

ReservationResponseV1[]

ReservationResponseV1

id

integer · int64 · required

origin

string · required

destination

string · required

datedServiceJourney

string · required

created

string · date-time · required

changed

string · date-time · required

createdBy

string · required

ReservationLineResponseV1[] · required

orderId

string

POST/v1/reservations/batch

curl https://api.entur.io/inventory/v1/reservations/batch \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '[
  {
    "origin": "origin",
    "destination": "destination",
    "datedServiceJourneyId": "datedServiceJourneyId",
    "orderId": "orderId",
    "reservationLines": [
      {
        "productId": "productId",
        "amount": 0,
        "status": "DRAFT"
      }
    ]
  }
]'

Example Request Body

[
  {
    "origin": "origin",
    "destination": "destination",
    "datedServiceJourneyId": "datedServiceJourneyId",
    "orderId": "orderId",
    "reservationLines": [
      {
        "productId": "productId",
        "amount": 0,
        "status": "DRAFT"
      }
    ]
  }
]

json

Example Responses

[
  {
    "id": 0,
    "origin": "origin",
    "destination": "destination",
    "datedServiceJourney": "datedServiceJourney",
    "created": "2024-08-25T15:00:00Z",
    "changed": "2024-08-25T15:00:00Z",
    "createdBy": "createdBy",
    "orderId": "orderId",
    "reservationLines": [
      {
        "id": 0,
        "productId": "productId",
        "amount": 0,
        "created": "2024-08-25T15:00:00Z",
        "changed": "2024-08-25T15:00:00Z",
        "status": "DRAFT"
      }
    ]
  }
]

json

application/json

Get available stock

GET

https://api.entur.io/inventory

/v1/stock

Calculates available stock between two stops of a dated service journey

Get available stock › query Parameters

datedServiceJourney

string · required · style: form · explode: true

origin

string · required · style: form · explode: true

destination

string · required · style: form · explode: true

Get available stock › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Get available stock › Responses

200

StockResponseV1

datedServiceJourney

string · required

origin

string · required

destination

string · required

organisationId

string · required

array · required

Get reservation by id

GET

https://api.entur.io/inventory

/v1/reservations/{id}

Retrieves a registered reservation.

Get reservation by id › path Parameters

id

integer · int64 · required · style: simple

Id of the reservation to get

Get reservation by id › Headers

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Get reservation by id › Responses

200

ReservationResponseV1

id

integer · int64 · required

origin

string · required

destination

string · required

datedServiceJourney

string · required

created

string · date-time · required

changed

string · date-time · required

createdBy

string · required

ReservationLineResponseV1[] · required

orderId

string

Inventory Admin

Did you find what you were looking for?