Top level services for order
Get Orders
Get Orders by specifying multiple filter query parameters.
Each value(s) must be prefixed with a valid search operator [eq, ne, gt, gte, lt, lte, in, nin]. See examples in some query parameters.
query Parameters
balanceFilter by balance
contactFilter by contact info contact
createdAtFilter by created at
createdByFilter by contact info created by
currencyFilter by currency
datedServiceJourneyIdFilter by Leg with Dated Service Journey ID
distributionChannelIdFilter by Distribution Channel used when Order was created
endTimeFilter by the endTime of one of the Legs on the Order
externalReferenceFilter by external reference
fromStopPlaceIdFilter by Leg with from Stop Place ID
idFilter by order ID
lastConfirmedAtFilter by when an Order was last confirmed
orderBySorts the result based on a field in the Order objects
orderLineExternalReferenceFilter by order lines external reference
orderLineIdFilter by OrderLine ID
organisationIdFilter by Organisation ID
originalDatedServiceJourneyIdFilter by Leg with Original Dated Service Journey ID
pageSelects a specific page in the collection
perPageSelects the number of elements per page
posFilter by POS header used when Order was created
reservationIdFilter by Reservation ID on OrderLines
salesPackageIdFilter by Sales Package ID
salesPackageVersionFilter by Sales Package version
fareProductIdFilter by Fare Product ID
fareProductVersionFilter by Fare Product version
serviceJourneyIdFilter by Leg with Service Journey ID
sortBySorts the result ascending or descending
startTimeFilter by the startTime of one of the Legs on the Order
statusFilter by Workflow Status
toStopPlaceIdFilter by Leg with to Stop Place ID
totalAmountFilter by total amount
totalTaxAmountFilter by total tax amount
versionOptional version query
Headers
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
Get Orders › Responses
OK
Items on a specific page
totalItemsTotal number of items
totalPagesTotal number of pages available to browse
Create an empty Order, and return the Order object
By calling this endpoint, a new, empty Order will be created. The Order ID can then be used to modify the Order to add journeys, etc.
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.
Create an empty Order, and return the Order object › Request Body optional
currencyThe currency for this Order.
expireAtAny changes not confirmed before this point in time will be discarded. Default is 20 minutes from the last operation. Cannot be in the past, or further into the future than six months.
Contact information related to different aspects in the lifecycle of an Order.
externalReferenceExternal reference for Orders
organisationOverrideIf present, the Order will be created on behalf of the given organisation ID, rather than the organisation associated with the token. Requires special agreements before use is allowed.
Create an empty Order, and return the Order object › Responses
OK
idID of Order.
Fees contained in the Order.
failedIndicates that the order version has failed and needs to be credited.
statusStatus of this Order or OrderLine. Every Order starts out with the status DRAFT, and can only be changed to CONFIRMED when it is balanced - when balance is '0.00'. All OrderLines that are have the status DRAFT at that point in time can also be changed to CONFIRMED.
balanceThe balance amount for this Order.
versionThe system increments an Order’s version number whenever some change occurs that causes the Order’s status to go from CONFIRMED to DRAFT. The user has to perform an action that causes the status to go from DRAFT to CONFIRMED (such as paying for the Order) before the time given in expireAt. If the Order is not confirmed within this time, the system will scrap all changes (including the incremented version) and return the Order to its last confirmed version.
currencyThe currency for this Order.
createdAtTimestamp for when Order was created.
OrderLines in the given Order.
Unique Travellers in this Order.
Payment references used on this Order.
totalAmountThe total amount due for this Order.
Seating Reservations connected to this Order.
organisationIdID of the organisation which created/sold this Order.
totalTaxAmountThe total tax amount for this Order.
posPoint-of-sale reference of request used when Order was created
lastConfirmedAtTimestamp for when Order was last confirmed.
distributionChannelIdDistribution channel ID of request used when Order was created
expireAtAny changes not confirmed before this point in time will be discarded. Default is 20 minutes from the last operation. Cannot be in the past, or further into the future than six months.
Contact information related to different aspects in the lifecycle of an Order.
externalReferenceExternal reference for Orders
Holder for fields used to explain why an Order has been issued. Used for zero tickets.
Get Order with ID in latest version
Get the latest versioned Order. Earlier versions with status CONFIRMED can be retrieved by specifying version=<desired version, minimum 1>.
path Parameters
orderIdOrder ID
query Parameters
versionOptional version query
Headers
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
Get Order with ID in latest version › Responses
OK
idID of Order.
Fees contained in the Order.
failedIndicates that the order version has failed and needs to be credited.
statusStatus of this Order or OrderLine. Every Order starts out with the status DRAFT, and can only be changed to CONFIRMED when it is balanced - when balance is '0.00'. All OrderLines that are have the status DRAFT at that point in time can also be changed to CONFIRMED.
balanceThe balance amount for this Order.
versionThe system increments an Order’s version number whenever some change occurs that causes the Order’s status to go from CONFIRMED to DRAFT. The user has to perform an action that causes the status to go from DRAFT to CONFIRMED (such as paying for the Order) before the time given in expireAt. If the Order is not confirmed within this time, the system will scrap all changes (including the incremented version) and return the Order to its last confirmed version.
currencyThe currency for this Order.
createdAtTimestamp for when Order was created.
OrderLines in the given Order.
Unique Travellers in this Order.
Payment references used on this Order.
totalAmountThe total amount due for this Order.
Seating Reservations connected to this Order.
organisationIdID of the organisation which created/sold this Order.
totalTaxAmountThe total tax amount for this Order.
posPoint-of-sale reference of request used when Order was created
lastConfirmedAtTimestamp for when Order was last confirmed.
distributionChannelIdDistribution channel ID of request used when Order was created
expireAtAny changes not confirmed before this point in time will be discarded. Default is 20 minutes from the last operation. Cannot be in the past, or further into the future than six months.
Contact information related to different aspects in the lifecycle of an Order.
externalReferenceExternal reference for Orders
Holder for fields used to explain why an Order has been issued. Used for zero tickets.
Update an Order.
Update one or multiple values on an Order.
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.
Update an Order. › Request Body
expireAtAny changes not confirmed before this point in time will be discarded. Default is 20 minutes from the last operation. Cannot be in the past, or further into the future than six months.
Contact information related to different aspects in the lifecycle of an Order.
externalReferenceExternal reference for Orders
Holder for fields used to explain why an Order has been issued. Used for zero tickets.
Update an Order. › Responses
OK
idID of Order.
Fees contained in the Order.
failedIndicates that the order version has failed and needs to be credited.
statusStatus of this Order or OrderLine. Every Order starts out with the status DRAFT, and can only be changed to CONFIRMED when it is balanced - when balance is '0.00'. All OrderLines that are have the status DRAFT at that point in time can also be changed to CONFIRMED.
balanceThe balance amount for this Order.
versionThe system increments an Order’s version number whenever some change occurs that causes the Order’s status to go from CONFIRMED to DRAFT. The user has to perform an action that causes the status to go from DRAFT to CONFIRMED (such as paying for the Order) before the time given in expireAt. If the Order is not confirmed within this time, the system will scrap all changes (including the incremented version) and return the Order to its last confirmed version.
currencyThe currency for this Order.
createdAtTimestamp for when Order was created.
OrderLines in the given Order.
Unique Travellers in this Order.
Payment references used on this Order.
totalAmountThe total amount due for this Order.
Seating Reservations connected to this Order.
organisationIdID of the organisation which created/sold this Order.
totalTaxAmountThe total tax amount for this Order.
posPoint-of-sale reference of request used when Order was created
lastConfirmedAtTimestamp for when Order was last confirmed.
distributionChannelIdDistribution channel ID of request used when Order was created
expireAtAny changes not confirmed before this point in time will be discarded. Default is 20 minutes from the last operation. Cannot be in the past, or further into the future than six months.
Contact information related to different aspects in the lifecycle of an Order.
externalReferenceExternal reference for Orders
Holder for fields used to explain why an Order has been issued. Used for zero tickets.
Fail Order
Fail the order and order lines that have externalConfirmation=PENDING. An OrderFailed event is emitted and the order transitions to CONFIRMED with failed=true. Returns 200 with the current order state, including if the order is already confirmed or failed.
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.
Fail Order › Request Body
orderLineIdsIDs of order lines that failed external confirmation. Must be order lines with externalConfirmation=PENDING.
Fail Order › Responses
OK
idID of Order.
Fees contained in the Order.
failedIndicates that the order version has failed and needs to be credited.
statusStatus of this Order or OrderLine. Every Order starts out with the status DRAFT, and can only be changed to CONFIRMED when it is balanced - when balance is '0.00'. All OrderLines that are have the status DRAFT at that point in time can also be changed to CONFIRMED.
balanceThe balance amount for this Order.
versionThe system increments an Order’s version number whenever some change occurs that causes the Order’s status to go from CONFIRMED to DRAFT. The user has to perform an action that causes the status to go from DRAFT to CONFIRMED (such as paying for the Order) before the time given in expireAt. If the Order is not confirmed within this time, the system will scrap all changes (including the incremented version) and return the Order to its last confirmed version.
currencyThe currency for this Order.
createdAtTimestamp for when Order was created.
OrderLines in the given Order.
Unique Travellers in this Order.
Payment references used on this Order.
totalAmountThe total amount due for this Order.
Seating Reservations connected to this Order.
organisationIdID of the organisation which created/sold this Order.
totalTaxAmountThe total tax amount for this Order.
posPoint-of-sale reference of request used when Order was created
lastConfirmedAtTimestamp for when Order was last confirmed.
distributionChannelIdDistribution channel ID of request used when Order was created
expireAtAny changes not confirmed before this point in time will be discarded. Default is 20 minutes from the last operation. Cannot be in the past, or further into the future than six months.
Contact information related to different aspects in the lifecycle of an Order.
externalReferenceExternal reference for Orders
Holder for fields used to explain why an Order has been issued. Used for zero tickets.
Reset Order to the latest confirmed version, or initial state if it has never been confirmed
This can be used when customers spend too much time placing an Order with a seat Reservation. By using reset, the application will free up space so that the seats can be reserved by others.
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.
Reset Order to the latest confirmed version, or initial state if it has never been confirmed › Responses
OK
idID of Order.
Fees contained in the Order.
failedIndicates that the order version has failed and needs to be credited.
statusStatus of this Order or OrderLine. Every Order starts out with the status DRAFT, and can only be changed to CONFIRMED when it is balanced - when balance is '0.00'. All OrderLines that are have the status DRAFT at that point in time can also be changed to CONFIRMED.
balanceThe balance amount for this Order.
versionThe system increments an Order’s version number whenever some change occurs that causes the Order’s status to go from CONFIRMED to DRAFT. The user has to perform an action that causes the status to go from DRAFT to CONFIRMED (such as paying for the Order) before the time given in expireAt. If the Order is not confirmed within this time, the system will scrap all changes (including the incremented version) and return the Order to its last confirmed version.
currencyThe currency for this Order.
createdAtTimestamp for when Order was created.
OrderLines in the given Order.
Unique Travellers in this Order.
Payment references used on this Order.
totalAmountThe total amount due for this Order.
Seating Reservations connected to this Order.
organisationIdID of the organisation which created/sold this Order.
totalTaxAmountThe total tax amount for this Order.
posPoint-of-sale reference of request used when Order was created
lastConfirmedAtTimestamp for when Order was last confirmed.
distributionChannelIdDistribution channel ID of request used when Order was created
expireAtAny changes not confirmed before this point in time will be discarded. Default is 20 minutes from the last operation. Cannot be in the past, or further into the future than six months.
Contact information related to different aspects in the lifecycle of an Order.
externalReferenceExternal reference for Orders
Holder for fields used to explain why an Order has been issued. Used for zero tickets.
Unlock Order
Unlock order if it is locked.
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.
Unlock Order › Responses
OK
idID of Order.
Fees contained in the Order.
failedIndicates that the order version has failed and needs to be credited.
statusStatus of this Order or OrderLine. Every Order starts out with the status DRAFT, and can only be changed to CONFIRMED when it is balanced - when balance is '0.00'. All OrderLines that are have the status DRAFT at that point in time can also be changed to CONFIRMED.
balanceThe balance amount for this Order.
versionThe system increments an Order’s version number whenever some change occurs that causes the Order’s status to go from CONFIRMED to DRAFT. The user has to perform an action that causes the status to go from DRAFT to CONFIRMED (such as paying for the Order) before the time given in expireAt. If the Order is not confirmed within this time, the system will scrap all changes (including the incremented version) and return the Order to its last confirmed version.
currencyThe currency for this Order.
createdAtTimestamp for when Order was created.
OrderLines in the given Order.
Unique Travellers in this Order.
Payment references used on this Order.
totalAmountThe total amount due for this Order.
Seating Reservations connected to this Order.
organisationIdID of the organisation which created/sold this Order.
totalTaxAmountThe total tax amount for this Order.
posPoint-of-sale reference of request used when Order was created
lastConfirmedAtTimestamp for when Order was last confirmed.
distributionChannelIdDistribution channel ID of request used when Order was created
expireAtAny changes not confirmed before this point in time will be discarded. Default is 20 minutes from the last operation. Cannot be in the past, or further into the future than six months.
Contact information related to different aspects in the lifecycle of an Order.
externalReferenceExternal reference for Orders
Holder for fields used to explain why an Order has been issued. Used for zero tickets.
Confirm Order
Manually confirm Orders where the balance is equal to 0.00
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.
Confirm Order › Responses
OK
idID of Order.
Fees contained in the Order.
failedIndicates that the order version has failed and needs to be credited.
statusStatus of this Order or OrderLine. Every Order starts out with the status DRAFT, and can only be changed to CONFIRMED when it is balanced - when balance is '0.00'. All OrderLines that are have the status DRAFT at that point in time can also be changed to CONFIRMED.
balanceThe balance amount for this Order.
versionThe system increments an Order’s version number whenever some change occurs that causes the Order’s status to go from CONFIRMED to DRAFT. The user has to perform an action that causes the status to go from DRAFT to CONFIRMED (such as paying for the Order) before the time given in expireAt. If the Order is not confirmed within this time, the system will scrap all changes (including the incremented version) and return the Order to its last confirmed version.
currencyThe currency for this Order.
createdAtTimestamp for when Order was created.
OrderLines in the given Order.
Unique Travellers in this Order.
Payment references used on this Order.
totalAmountThe total amount due for this Order.
Seating Reservations connected to this Order.
organisationIdID of the organisation which created/sold this Order.
totalTaxAmountThe total tax amount for this Order.
posPoint-of-sale reference of request used when Order was created
lastConfirmedAtTimestamp for when Order was last confirmed.
distributionChannelIdDistribution channel ID of request used when Order was created
expireAtAny changes not confirmed before this point in time will be discarded. Default is 20 minutes from the last operation. Cannot be in the past, or further into the future than six months.
Contact information related to different aspects in the lifecycle of an Order.
externalReferenceExternal reference for Orders
Holder for fields used to explain why an Order has been issued. Used for zero tickets.