Services related to travellers on order.
Add Traveller to Order
Deprecated. Please use POST /v1/orders/{orderId}/travellers/bulk.
path Parameters
orderIdOrder ID
Headers
Entur-PosPoint-of-sale identifier.
ET-Client-NameEntur 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-IdCorrelation id
Entur-Distribution-ChannelA header containing the distribution channel ID.
Add Traveller to Order › Request Body
Customer reference.
Add Traveller to Order › Responses
OK
Add list of Traveller to Order
This endpoint adds a list of Traveller to the specified Order, and returns the List
path Parameters
orderIdOrder ID
Headers
Entur-PosPoint-of-sale identifier.
ET-Client-NameEntur 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-IdCorrelation id
Entur-Distribution-ChannelA header containing the distribution channel ID.
Add list of Traveller to Order › Request Body
Customer reference.
Add list of Traveller to Order › Responses
OK
Remove list of travellers from Order
This endpoint removes the list of travellerIds from the specified Order.
path Parameters
orderIdOrder ID
query Parameters
travellerIdsList of traveller IDs to remove from order
Headers
Entur-PosPoint-of-sale identifier.
ET-Client-NameEntur 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-IdCorrelation id
Entur-Distribution-ChannelA header containing the distribution channel ID.
Remove list of travellers from Order › Responses
No Content
Update Traveller
This endpoint updates a Traveller for the specified Order, and returns the Traveller that was updated. If either the Order or the Traveller does not exist, it will throw an exception.
path Parameters
orderIdOrder ID
travellerIdTraveller ID associated with Order
Headers
Entur-PosPoint-of-sale identifier.
ET-Client-NameEntur 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-IdCorrelation id
Entur-Distribution-ChannelA header containing the distribution channel ID.
Update Traveller › Request Body
Customer reference.
Update Traveller › Responses
OK
Remove Traveller from Order
Deprecated. Please use DELETE /v1/orders/{orderId}/travellers/bulk
path Parameters
orderIdOrder ID
travellerIdTraveller ID associated with Order
Headers
Entur-PosPoint-of-sale identifier.
ET-Client-NameEntur 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-IdCorrelation id
Entur-Distribution-ChannelA header containing the distribution channel ID.
Remove Traveller from Order › Responses
OK