Reservations

Server

Download schema

Services related to reservations on order.

Add seat Reservation references

POST

https://api.staging.entur.io/sales

/v1/orders/{orderId}/reservations

Add seat Reservation references to the specified Order. Reservation ID is an UUID

Add seat Reservation references › path Parameters

orderId

string · required · style: simple

Order ID

Add seat Reservation references › Headers

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

ET-Client-Name

string

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> for companies, and <personal name>-<application> for individuals.

X-Correlation-Id

string

Correlation id

Entur-Distribution-Channel

string · style: simple

A header containing the distribution channel ID.

Add seat Reservation references › Request Body

PurchasedReservation[]

PurchasedReservation

reservationId

string · uuid · required

ID and version of the Reservation.

Example: de3299ae-b54c-4747-b915-d8536e1a9741

RefType · required

Reference to a resource available in a different APIs

Add seat Reservation references › Responses

PurchasedReservation[]

PurchasedReservation

reservationId

string · uuid · required

ID and version of the Reservation.

Example: de3299ae-b54c-4747-b915-d8536e1a9741

RefType · required

Reference to a resource available in a different APIs

POST/v1/orders/{orderId}/reservations

curl https://api.staging.entur.io/sales/v1/orders/:orderId/reservations \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Entur-Pos: <string>' \
  --data '[
  {
    "reservationId": "de3299ae-b54c-4747-b915-d8536e1a9741",
    "datedServiceJourneyRef": {
      "id": "ENT:Resource:12345",
      "version": "1"
    }
  }
]'

Example Request Body

[
  {
    "reservationId": "de3299ae-b54c-4747-b915-d8536e1a9741",
    "datedServiceJourneyRef": {
      "id": "ENT:Resource:12345",
      "version": "1"
    }
  }
]

json

Example Responses

[
  {
    "reservationId": "de3299ae-b54c-4747-b915-d8536e1a9741",
    "datedServiceJourneyRef": {
      "id": "ENT:Resource:12345",
      "version": "1"
    }
  }
]

json

application/json

Update seat Reservation reference

PUT

https://api.staging.entur.io/sales

/v1/orders/{orderId}/reservations/{reservationId}

Update seat Reservation reference

Update seat Reservation reference › path Parameters

orderId

string · required · style: simple

Order ID

reservationId

string · uuid · required · style: simple

Reservation ID associated with Order

Update seat Reservation reference › Headers

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Entur-Distribution-Channel

string · style: simple

A header containing the distribution channel ID.

Update seat Reservation reference › Request Body

PurchasedReservation

reservationId

string · uuid · required

ID and version of the Reservation.

Example: de3299ae-b54c-4747-b915-d8536e1a9741

RefType · required

Reference to a resource available in a different APIs

Update seat Reservation reference › Responses

PurchasedReservation

reservationId

string · uuid · required

ID and version of the Reservation.

Example: de3299ae-b54c-4747-b915-d8536e1a9741

RefType · required

Reference to a resource available in a different APIs

PUT/v1/orders/{orderId}/reservations/{reservationId}

curl https://api.staging.entur.io/sales/v1/orders/:orderId/reservations/:reservationId \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Entur-Pos: <string>' \
  --data '{
  "reservationId": "de3299ae-b54c-4747-b915-d8536e1a9741",
  "datedServiceJourneyRef": {
    "id": "ENT:Resource:12345",
    "version": "1"
  }
}'

Example Request Body

{
  "reservationId": "de3299ae-b54c-4747-b915-d8536e1a9741",
  "datedServiceJourneyRef": {
    "id": "ENT:Resource:12345",
    "version": "1"
  }
}

json

Example Responses

{
  "reservationId": "de3299ae-b54c-4747-b915-d8536e1a9741",
  "datedServiceJourneyRef": {
    "id": "ENT:Resource:12345",
    "version": "1"
  }
}

json

application/json

Remove seat Reservation reference

DELETE

https://api.staging.entur.io/sales

/v1/orders/{orderId}/reservations/{reservationId}

Remove seat Reservation reference

Remove seat Reservation reference › path Parameters

orderId

string · required · style: simple

Order ID

reservationId

string · uuid · required · style: simple

Reservation ID associated with Order

Remove seat Reservation reference › Headers

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Entur-Distribution-Channel

string · style: simple

A header containing the distribution channel ID.

Remove seat Reservation reference › Responses

No Content

No data returned

Fees Travellers

Add seat Reservation references

POST

https://api.staging.entur.io/sales

/v1/orders/{orderId}/reservations

Add seat Reservation references to the specified Order. Reservation ID is an UUID

Add seat Reservation references › path Parameters

orderId

string · required · style: simple

Order ID

Add seat Reservation references › Headers

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Entur-Distribution-Channel

string · style: simple

A header containing the distribution channel ID.

Add seat Reservation references › Request Body

PurchasedReservation[]

PurchasedReservation

reservationId

string · uuid · required

ID and version of the Reservation.

Example: de3299ae-b54c-4747-b915-d8536e1a9741

RefType · required

Reference to a resource available in a different APIs

Add seat Reservation references › Responses

PurchasedReservation[]

PurchasedReservation

reservationId

string · uuid · required

ID and version of the Reservation.

Example: de3299ae-b54c-4747-b915-d8536e1a9741

RefType · required

Reference to a resource available in a different APIs

Update seat Reservation reference

PUT

https://api.staging.entur.io/sales

/v1/orders/{orderId}/reservations/{reservationId}

Update seat Reservation reference

Update seat Reservation reference › path Parameters

orderId

string · required · style: simple

Order ID

reservationId

string · uuid · required · style: simple

Reservation ID associated with Order

Update seat Reservation reference › Headers

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Entur-Distribution-Channel

string · style: simple

A header containing the distribution channel ID.

Update seat Reservation reference › Request Body

PurchasedReservation

reservationId

string · uuid · required

ID and version of the Reservation.

Example: de3299ae-b54c-4747-b915-d8536e1a9741

RefType · required

Reference to a resource available in a different APIs

Update seat Reservation reference › Responses

PurchasedReservation

reservationId

string · uuid · required

ID and version of the Reservation.

Example: de3299ae-b54c-4747-b915-d8536e1a9741

RefType · required

Reference to a resource available in a different APIs

Remove seat Reservation reference

DELETE

https://api.staging.entur.io/sales

/v1/orders/{orderId}/reservations/{reservationId}

Remove seat Reservation reference

Remove seat Reservation reference › path Parameters

orderId

string · required · style: simple

Order ID

reservationId

string · uuid · required · style: simple

Reservation ID associated with Order

Remove seat Reservation reference › Headers

Entur-Pos

string · required · style: simple

Point-of-sale identifier.

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Entur-Distribution-Channel

string · style: simple

A header containing the distribution channel ID.

Remove seat Reservation reference › Responses

No Content

No data returned

Reservations

Add seat Reservation references

Add seat Reservation references › path Parameters

Add seat Reservation references › Headers

Add seat Reservation references › Request Body

Add seat Reservation references › Responses

Update seat Reservation reference

Update seat Reservation reference › path Parameters

Update seat Reservation reference › Headers

Update seat Reservation reference › Request Body

Update seat Reservation reference › Responses

Remove seat Reservation reference

Remove seat Reservation reference › path Parameters

Remove seat Reservation reference › Headers

Remove seat Reservation reference › Responses

Build with Entur

Contribute

Terms & Policies

Reservations

Add seat Reservation references

Add seat Reservation references › path Parameters

Add seat Reservation references › Headers

Add seat Reservation references › Request Body

Add seat Reservation references › Responses

Update seat Reservation reference

Update seat Reservation reference › path Parameters

Update seat Reservation reference › Headers

Update seat Reservation reference › Request Body

Update seat Reservation reference › Responses

Remove seat Reservation reference

Remove seat Reservation reference › path Parameters

Remove seat Reservation reference › Headers

Remove seat Reservation reference › Responses