Services related to order lines on order.
Update OrderLines on an Order
This endpoint updates OrderLines on the specified Order, and returns the updated representations
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 OrderLines on an Order › Request Body
Price with included tax amounts and an optional rate.
The Travellers that are to travel on this OrderLine.
Description.
The underlying FareProducts which make up this SalesPackage.
Price with included tax amounts and an optional rate.
idId for an OrderLine, required when updating orderLines
Possible additional parameters for the configurations
privateCodePrivate code.
Reference to a resource available in a different APIs
externalReferenceExternal reference to another system supplied by the client.
A map of client provided data. No validation is performed, and no guarantee can be made about its contents.
Wrapper for references connected to distribution of travel rights and/or tickets
Classification of the products chosen.
externalConfirmationExternal confirmation status for this OrderLine. Allowed values: PENDING, SUCCESS, FAILED.
effectiveCancellationDateIf set, the effective date for cancellation. Overrides timestamp.
Update OrderLines on an Order › Responses
OK
idID of OrderLine
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.
versionVersion of this OrderLine. This is iterated when the OrderLine is updated, but not when it is replaced.
createdAtTimestamp for when the OrderLine was created.
Price with included tax amounts and an optional rate.
The Travellers that are to travel on this OrderLine.
Description.
The underlying FareProducts which make up this SalesPackage.
Price with included tax amounts and an optional rate.
Metadata about who or what added the OrderLine.
refundedIf true = refunded, false = cancelled, null = active
cancellationCancellation reason for an OrderLine. OrderLines with REPLACED have been replaced with a newer version.
lastConfirmedAtTimestamp for when the OrderLine was last confirmed.
Possible additional parameters for the configurations
privateCodePrivate code.
Reference to a resource available in a different APIs
externalReferenceExternal reference to another system supplied by the client.
A map of client provided data. No validation is performed, and no guarantee can be made about its contents.
Wrapper for references connected to distribution of travel rights and/or tickets
Classification of the products chosen.
externalConfirmationExternal confirmation status for this OrderLine. Allowed values: PENDING, SUCCESS, FAILED.
effectiveCancellationDateIf set, the effective date for cancellation. Overrides timestamp.
Add OrderLines to Order
This endpoint adds a list of OrderLines to the specified Order, and returns a 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 OrderLines to Order › Request Body
Price with included tax amounts and an optional rate.
The Travellers that are to travel on this OrderLine.
Description.
The underlying FareProducts which make up this SalesPackage.
Price with included tax amounts and an optional rate.
idId for an OrderLine, required when updating orderLines
Possible additional parameters for the configurations
privateCodePrivate code.
Reference to a resource available in a different APIs
externalReferenceExternal reference to another system supplied by the client.
A map of client provided data. No validation is performed, and no guarantee can be made about its contents.
Wrapper for references connected to distribution of travel rights and/or tickets
Classification of the products chosen.
externalConfirmationExternal confirmation status for this OrderLine. Allowed values: PENDING, SUCCESS, FAILED.
effectiveCancellationDateIf set, the effective date for cancellation. Overrides timestamp.
Add OrderLines to Order › Responses
OK
idID of OrderLine
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.
versionVersion of this OrderLine. This is iterated when the OrderLine is updated, but not when it is replaced.
createdAtTimestamp for when the OrderLine was created.
Price with included tax amounts and an optional rate.
The Travellers that are to travel on this OrderLine.
Description.
The underlying FareProducts which make up this SalesPackage.
Price with included tax amounts and an optional rate.
Metadata about who or what added the OrderLine.
refundedIf true = refunded, false = cancelled, null = active
cancellationCancellation reason for an OrderLine. OrderLines with REPLACED have been replaced with a newer version.
lastConfirmedAtTimestamp for when the OrderLine was last confirmed.
Possible additional parameters for the configurations
privateCodePrivate code.
Reference to a resource available in a different APIs
externalReferenceExternal reference to another system supplied by the client.
A map of client provided data. No validation is performed, and no guarantee can be made about its contents.
Wrapper for references connected to distribution of travel rights and/or tickets
Classification of the products chosen.
externalConfirmationExternal confirmation status for this OrderLine. Allowed values: PENDING, SUCCESS, FAILED.
effectiveCancellationDateIf set, the effective date for cancellation. Overrides timestamp.
Delete OrderLines from Order
This endpoint removes a list of OrderLines from the specified Order. This is equivalent of running multiple DELETE /v1/orders/{orderId}/orderlines/{orderLineId}
path Parameters
orderIdOrder ID
query Parameters
orderLineIdsList of order line IDs to delete
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.
Delete OrderLines from Order › Responses
No Content
Cancel OrderLines in an Order
The cost of the OrderLine will be removed from the Order total, and the field cancellation will be set to CANCELLED. Only to be used for CONFIRMED OrderLines. Typical usage: refunding.
path Parameters
orderIdOrder ID
query Parameters
orderLineIdsUse request body
effectiveCancellationDateThis parameter is used to override cancellation date from current timestamp. This will be applied to every order line in the request. Separate requests are required per cancellation date.
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.
Cancel OrderLines in an Order › Responses
OK
The cancelled OrderLines
idID of OrderLine
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.
versionVersion of this OrderLine. This is iterated when the OrderLine is updated, but not when it is replaced.
createdAtTimestamp for when the OrderLine was created.
Price with included tax amounts and an optional rate.
The Travellers that are to travel on this OrderLine.
Description.
The underlying FareProducts which make up this SalesPackage.
Price with included tax amounts and an optional rate.
Metadata about who or what added the OrderLine.
refundedIf true = refunded, false = cancelled, null = active
cancellationCancellation reason for an OrderLine. OrderLines with REPLACED have been replaced with a newer version.
lastConfirmedAtTimestamp for when the OrderLine was last confirmed.
Possible additional parameters for the configurations
privateCodePrivate code.
Reference to a resource available in a different APIs
externalReferenceExternal reference to another system supplied by the client.
A map of client provided data. No validation is performed, and no guarantee can be made about its contents.
Wrapper for references connected to distribution of travel rights and/or tickets
Classification of the products chosen.
externalConfirmationExternal confirmation status for this OrderLine. Allowed values: PENDING, SUCCESS, FAILED.
effectiveCancellationDateIf set, the effective date for cancellation. Overrides timestamp.
Confirm pending OrderLines
Confirm OrderLines that have externalConfirmation=PENDING. If all pending OrderLines are confirmed, an OrderConfirmed event is emitted and the order transitions to CONFIRMED. Otherwise, an OrderPartiallyConfirmed event is emitted and the order remains in DRAFT. Returns 200 with the current order state, including if the order is already confirmed.
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 pending OrderLines › Request Body
orderLineIdsIDs of order lines to confirm. Must be order lines with externalConfirmation=PENDING.
Confirm pending OrderLines › 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.
Deprecated. Please use PUT `/v1/orders/{orderId}/orderlines`
This endpoint updates a OrderLine on the specified Order, and returns an updated representation
path Parameters
orderIdOrder ID
orderLineIdOrderLine ID to given 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.
Deprecated. Please use PUT `/v1/orders/{orderId}/orderlines` › Request Body
Price with included tax amounts and an optional rate.
The Travellers that are to travel on this OrderLine.
Description.
The underlying FareProducts which make up this SalesPackage.
Price with included tax amounts and an optional rate.
idId for an OrderLine, required when updating orderLines
Possible additional parameters for the configurations
privateCodePrivate code.
Reference to a resource available in a different APIs
externalReferenceExternal reference to another system supplied by the client.
A map of client provided data. No validation is performed, and no guarantee can be made about its contents.
Wrapper for references connected to distribution of travel rights and/or tickets
Classification of the products chosen.
externalConfirmationExternal confirmation status for this OrderLine. Allowed values: PENDING, SUCCESS, FAILED.
effectiveCancellationDateIf set, the effective date for cancellation. Overrides timestamp.
Deprecated. Please use PUT `/v1/orders/{orderId}/orderlines` › Responses
OK
idID of OrderLine
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.
versionVersion of this OrderLine. This is iterated when the OrderLine is updated, but not when it is replaced.
createdAtTimestamp for when the OrderLine was created.
Price with included tax amounts and an optional rate.
The Travellers that are to travel on this OrderLine.
Description.
The underlying FareProducts which make up this SalesPackage.
Price with included tax amounts and an optional rate.
Metadata about who or what added the OrderLine.
refundedIf true = refunded, false = cancelled, null = active
cancellationCancellation reason for an OrderLine. OrderLines with REPLACED have been replaced with a newer version.
lastConfirmedAtTimestamp for when the OrderLine was last confirmed.
Possible additional parameters for the configurations
privateCodePrivate code.
Reference to a resource available in a different APIs
externalReferenceExternal reference to another system supplied by the client.
A map of client provided data. No validation is performed, and no guarantee can be made about its contents.
Wrapper for references connected to distribution of travel rights and/or tickets
Classification of the products chosen.
externalConfirmationExternal confirmation status for this OrderLine. Allowed values: PENDING, SUCCESS, FAILED.
effectiveCancellationDateIf set, the effective date for cancellation. Overrides timestamp.
Deprecated. Please use DELETE `/v1/orders/{orderId}/orderlines?orderLineIds={orderLineId}`
This endpoint removes an OrderLine from the specified Order. Note that this should only be used for non-confirmed OrderLines. If the OrderLine has been confirmed, it needs to be cancelled instead. Typical usage: customer has decided not to purchase the OrderLine.
path Parameters
orderIdOrder ID
orderLineIdOrderLine ID to given 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.
Deprecated. Please use DELETE `/v1/orders/{orderId}/orderlines?orderLineIds={orderLineId}` › Responses
No Content
Deprecated. Please use POST `/v1/orders/{orderId}/orderlines/cancel?orderLineIds={orderLineId}`
The cost of the OrderLine will be removed from the Order total, and the field cancellation will be set to CANCELLED. Only to be used for CONFIRMED OrderLines. Typical usage: refunding.
path Parameters
orderIdOrder ID
orderLineIdOrderLine ID to given Order
query Parameters
effectiveCancellationDateThis parameter is used to override cancellation date from current timestamp.
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.
Deprecated. Please use POST `/v1/orders/{orderId}/orderlines/cancel?orderLineIds={orderLineId}` › Responses
OK
idID of OrderLine
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.
versionVersion of this OrderLine. This is iterated when the OrderLine is updated, but not when it is replaced.
createdAtTimestamp for when the OrderLine was created.
Price with included tax amounts and an optional rate.
The Travellers that are to travel on this OrderLine.
Description.
The underlying FareProducts which make up this SalesPackage.
Price with included tax amounts and an optional rate.
Metadata about who or what added the OrderLine.
refundedIf true = refunded, false = cancelled, null = active
cancellationCancellation reason for an OrderLine. OrderLines with REPLACED have been replaced with a newer version.
lastConfirmedAtTimestamp for when the OrderLine was last confirmed.
Possible additional parameters for the configurations
privateCodePrivate code.
Reference to a resource available in a different APIs
externalReferenceExternal reference to another system supplied by the client.
A map of client provided data. No validation is performed, and no guarantee can be made about its contents.
Wrapper for references connected to distribution of travel rights and/or tickets
Classification of the products chosen.
externalConfirmationExternal confirmation status for this OrderLine. Allowed values: PENDING, SUCCESS, FAILED.
effectiveCancellationDateIf set, the effective date for cancellation. Overrides timestamp.