collections

the identifier of a package

leg identifier

default string, full names etc (length 0-200)

The optional limit parameter limits the number of items that are presented in the response document. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Minimum = 1. Maximum = 10000. Default = 100.

The optional offset parameter representing the starting index of the returned collection. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Default = 0.

Only features that have a geometry that intersects the bounding box are selected. The bounding box is provided as four or six numbers, depending on whether the coordinate reference system includes a vertical axis (height or depth): * Lower left corner, coordinate axis 1 * Lower left corner, coordinate axis 2 * Minimum value, coordinate axis 3 (optional) * Upper right corner, coordinate axis 1 * Upper right corner, coordinate axis 2 * Maximum value, coordinate axis 3 (optional) If the value consists of four numbers, the coordinate reference system is WGS 84 longitude/latitude (http://www.opengis.net/def/crs/OGC/1.3/CRS84) unless a different coordinate reference system is specified in the parameter bbox-crs. If the value consists of six numbers, the coordinate reference system is WGS 84 longitude/latitude/ellipsoidal height (http://www.opengis.net/def/crs/OGC/0/CRS84h) unless a different coordinate reference system is specified in the parameter bbox-crs. The query parameter bbox-crs is specified in OGC API - Features - Part 2: Coordinate Reference Systems by Reference. For WGS 84 longitude/latitude the values are in most cases the sequence of minimum longitude, minimum latitude, maximum longitude and maximum latitude. However, in cases where the box spans the antimeridian the first value (west-most box edge) is larger than the third value (east-most box edge). If the vertical axis is included, the third and the sixth number are the bottom and the top of the 3-dimensional bounding box. If a feature has multiple spatial geometry properties, it is the decision of the server whether only a single spatial geometry property is used to determine the extent or all relevant geometries.

short string, display names (length 0-75)

Header field, JWT must be supplied

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>.

Correlation id

the identifier of a package

leg identifier

default string, full names etc (length 0-200)

The optional limit parameter limits the number of items that are presented in the response document. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Minimum = 1. Maximum = 10000. Default = 100.

The optional offset parameter representing the starting index of the returned collection. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Default = 0.

short string, display names (length 0-75)

Header field, JWT must be supplied

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>.

Correlation id

the identifier of a package

leg identifier

default string, full names etc (length 0-200)

short string, display names (length 0-75)

Header field, JWT must be supplied

Distribution channel identifier used by downstream sales and ticket distribution services.

Point-of-sale identifier used by downstream sales and ticket distribution services.

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>.

Correlation id

the identifier of a package

leg identifier

default string, full names etc (length 0-200)

traveller identifier

default string, full names etc (length 0-200)

ancillary identifier

default string, full names etc (length 0-200)

short string, display names (length 0-75)

Header field, JWT must be supplied

Distribution channel identifier used by downstream sales and ticket distribution services.

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>.

Correlation id

the identifier of a package

leg identifier

default string, full names etc (length 0-200)

Filter travel documents by status

The lifecycle status of a travel document.
PENDING the document is being processed or awaiting distribution pickup
ACTIVE the document is ready for use
FAILED the document distribution failed
EXPIRED the document has expired
CANCELLED the document has been cancelled

short string, display names (length 0-75)

Header field, JWT must be supplied

Distribution channel identifier used by downstream sales and ticket distribution services.

Point-of-sale identifier used by downstream sales and ticket distribution services.

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>.

Correlation id

short string, display names (length 0-75)

Header field, JWT must be supplied

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>.

Correlation id

The optional limit parameter limits the number of items that are presented in the response document. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Minimum = 1. Maximum = 10000. Default = 100.

The optional offset parameter representing the starting index of the returned collection. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Default = 0.

the identifier of a package (maps to Orders id)

optional owner customer identifier filter (maps to Orders createdBy, exact match only)

default string, full names etc (length 0-200)

optional contact customer identifier filter (maps to Orders contact, exact match only)

default string, full names etc (length 0-200)

optional package balance filter, passed through to Orders balance filter

optional package created-at filter, passed through to Orders createdAt filter

optional package currency filter, passed through to Orders currency filter

optional package dated service journey ID filter, passed through to Orders datedServiceJourneyId filter

optional package distribution channel ID filter, passed through to Orders distributionChannelId filter

optional package end-time filter, passed through to Orders endTime filter

optional package external reference filter, passed through to Orders externalReference filter

optional package from stop place ID filter, passed through to Orders fromStopPlaceId filter

optional package last-confirmed-at filter, passed through to Orders lastConfirmedAt filter

optional package orderBy value, passed through to Orders orderBy

optional package leg external reference filter, mapped to Orders orderLineExternalReference

optional package leg identifier filter, mapped to Orders orderLineId

optional package organisation ID filter, passed through to Orders organisationId filter

optional package original dated service journey ID filter, passed through to Orders originalDatedServiceJourneyId filter

optional package POS filter, passed through to Orders pos filter

optional package reservation ID filter, passed through to Orders reservationId filter

optional package product ID filter, mapped to Orders fareProductId

optional package fare product version filter, passed through to Orders fareProductVersion filter

optional package service journey ID filter, passed through to Orders serviceJourneyId filter

optional package sort direction (ASC or DESC), passed through to Orders sortBy

optional package start-time filter, passed through to Orders startTime filter

optional package to stop place ID filter, passed through to Orders toStopPlaceId filter

optional package total amount filter, passed through to Orders totalAmount filter

optional package total tax amount filter, passed through to Orders totalTaxAmount filter

optional package version filter, passed through to Orders version filter

Filter packages by their lifecycle status (e.g. CONFIRMED, CANCELLED)

The life-cycle state of the package (from NEW to ENDED)
OFFERED the package is offered
SELECTED the package is selected to modify
PENDING the purchase of the package is not confirmed (the end user has shown intentions to purchase this offer), must be finalized with the package-confirm operation
CONFIRMED a finalized package ('purchased'). Both parties agreed to deliver services in return of payment
CANCELLED the package is cancelled after it is purchased. The agreement will specify whether there is a refund, or under which conditions
EXPIRED the MP didn't respond on time, the package offer has been expired
STARTED the package is started, the trip execution module is needed now to manage the execution of the package
ENDED the package has ended, the trip has been executed
RELEASED for internal archiving, the package has not been purchased.

short string, display names (length 0-75)

Header field, JWT must be supplied

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>.

Correlation id

The unique identifier of the package to retrieve

short string, display names (length 0-75)

Header field, JWT must be supplied

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>.

Correlation id

The optional limit parameter limits the number of items that are presented in the response document. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Minimum = 1. Maximum = 10000. Default = 100.

The optional offset parameter representing the starting index of the returned collection. Only items are counted that are on the first level of the collection in the response document. Nested objects contained within the explicitly requested items shall not be counted. Default = 0.

optional customer identifier filter

default string, full names etc (length 0-200)

optional filter on the client's own customer reference

optional first name filter

short string, display names (length 0-75)

optional last name filter

short string, display names (length 0-75)

optional email filter

default string, full names etc (length 0-200)

optional phone number filter

default string, full names etc (length 0-200)

short string, display names (length 0-75)

Header field, JWT must be supplied

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>.

Correlation id

short string, display names (length 0-75)

Header field, JWT must be supplied

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>.

Correlation id

customer identifier

default string, full names etc (length 0-200)

short string, display names (length 0-75)

Header field, JWT must be supplied

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>.

Correlation id

customer identifier

default string, full names etc (length 0-200)

short string, display names (length 0-75)

Header field, JWT must be supplied

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>.

Correlation id

customer identifier

default string, full names etc (length 0-200)

short string, display names (length 0-75)

Header field, JWT must be supplied

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>.

Correlation id