Services regarding ticket distribution level.
Get summary of distribution data for an order
Returns a list of the distinct summary data for the orderId. This service/endpoint is useful to just retrieve external distribution data for an order when you may not have access to all order data.
path Parameters
orderIdorderId
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 summary of distribution data for an order › Responses
OK
orderIdThe orderId of the ticket distribution summary
List of distinct summaries of all ticket distributions of the ticket distribution groups for a given orderId. At least one of the fields in a distribution is non-null.
Generate ticket distributions
Generate a set of ticket distribution groups which later will be distributed to a ticket system.
path Parameters
orderIdorderId
Headers
Entur-PosA header containing a point-of-sale reference
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
Accepts-LanguageA header used to select language
Current supported languages are 'nob', 'nno' and 'eng'
Entur-Distribution-ChannelA header containing a distribution channel reference
Generate ticket distributions › Responses
OK
idorderIdorderLineIdorderVersionupdatedForOrderLineVersioncreatedByDCIorganisationIddistributedByDCIfulfillmentMethodThe fulfillment method given by the order line. Useful for determining which external ticketing system to retrieve validation data from. Possible values: NOD, ACCOUNT_BASED_TICKETING, INTERNATIONAL, BIFROST
distributedByOrgIdorderOwnerCustomerIdThe customerId of the customer that owns the order
distributionHolderCustomerIdThe customerId of the customer that will receive the ticket
Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute
Distribute a set of ticket distribution groups to NOD for pick up as QR-code and animation.
path Parameters
orderIdorderId
query Parameters
deliverAfterThe earliest time it should be possible to pick up the ticket
qrChecksumTypeThe QR Code checksum type
Headers
Entur-PosA header containing a point-of-sale reference
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
Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute › Responses
OK
idorderIdorderLineIdorderVersionupdatedForOrderLineVersioncreatedByDCIorganisationIddistributedByDCIfulfillmentMethodThe fulfillment method given by the order line. Useful for determining which external ticketing system to retrieve validation data from. Possible values: NOD, ACCOUNT_BASED_TICKETING, INTERNATIONAL, BIFROST
distributedByOrgIdorderOwnerCustomerIdThe customerId of the customer that owns the order
distributionHolderCustomerIdThe customerId of the customer that will receive the ticket
Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute
Distribute a set of ticket distribution groups to NOD for pick up on travel card.
path Parameters
orderIdorderId
Headers
Entur-PosA header containing a point-of-sale reference
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
Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute › Request Body
activateActivate the product
paymentMeansTypeThe payment means type used to purchase the ticket
mediaSerialNumberIdThe media serial number (MSN) ID of the travel card
Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute › Responses
OK
idorderIdorderLineIdorderVersionupdatedForOrderLineVersioncreatedByDCIorganisationIddistributedByDCIfulfillmentMethodThe fulfillment method given by the order line. Useful for determining which external ticketing system to retrieve validation data from. Possible values: NOD, ACCOUNT_BASED_TICKETING, INTERNATIONAL, BIFROST
distributedByOrgIdorderOwnerCustomerIdThe customerId of the customer that owns the order
distributionHolderCustomerIdThe customerId of the customer that will receive the ticket