Ticket Distributions

Server

Services regarding ticket distribution level.

Get summary of distribution data for an order

GET

https://api.staging.entur.io/sales

/v1/ticket-distributions/{orderId}/summary

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.

Get summary of distribution data for an order › path Parameters

orderId

string · required · style: simple

orderId

Example: NTA2JGR7

Get summary of distribution data for an order › Headers

ET-Client-Name

string · style: simple

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

X-Correlation-Id

string · style: simple

Correlation id

Get summary of distribution data for an order › Responses

TicketDistributionSummary

orderId

string · required

The orderId of the ticket distribution summary

Distribution[] · required

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.

deprecated

Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute

POST

https://api.staging.entur.io/sales

/v1/ticket-distributions/{orderId}/distribute

Distribute a set of ticket distribution groups to NOD for pick up as QR-code and animation.

Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute › path Parameters

orderId

string · required · style: simple

orderId

Example: NTA2JGR7

Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute › query Parameters

deliverAfter

string · date-time · style: form · explode: true

The earliest time it should be possible to pick up the ticket

qrChecksumType

integer · int32 · style: form · explode: true

The QR Code checksum type

Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute › Headers

Entur-Pos

string · required · style: simple

A header containing a point-of-sale reference

Example: MyApplication

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation 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

TicketDistributionGroup[]

TicketDistributionGroup

id

integer · int64 · required

orderId

string · required

orderLineId

string · required

orderVersion

integer · int32 · required

TicketDistribution[] · required

updatedForOrderLineVersion

integer · int32 · required

createdByDCI

string

distributedByDCI

string

distributedByOrgId

integer · int64

organisationId

integer · int64

SalesPackage

fulfillmentMethod

string

The 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

orderOwnerCustomerId

string

The customerId of the customer that owns the order

distributionHolderCustomerId

string

The customerId of the customer that will receive the ticket

POST/v1/ticket-distributions/{orderId}/distribute

curl https://api.staging.entur.io/sales/v1/ticket-distributions/:orderId/distribute \
  --request POST \
  --header 'Entur-Pos: <string>'

Example Responses

[
  {
    "id": 123456789,
    "orderId": "ABCD1234",
    "orderVersion": 1,
    "orderLineId": "e9154697-41e6-4955-985e-d474d438a557",
    "orderLineVersion": 1,
    "ticketDistributions": [
      {
        "id": 987654321,
        "distributionStatus": "DISTRIBUTED",
        "authority": {
          "id": "1234",
          "name": "WayFare"
        },
        "customers": [
          {
            "customerId": "12345678901",
            "entitlements": [],
            "id": 1
          }
        ],
        "loyaltyProgram": false,
        "networkId": 1,
        "orderLineVersion": 1,
        "productTemplate": 1,
        "provider": 51,
        "tariffCode": 321,
        "combinedTicket": false,
        "fareProduct": {
          "id": "ABC:PurchasedFareProduct:SingleTicket",
          "version": "ABC:Version:PFP-1",
          "name": "Single Ticket",
          "organisationId": 5678
        },
        "supplementProducts": [],
        "userProfile": {
          "id": "ABC:UserProfile:Adult",
          "version": "ABC:Version:UP-1",
          "name": "Adult"
        },
        "reservations": [
          {
            "id": 1,
            "externalReservationId": "RESV123456",
            "datedServiceJourneyId": "TST:DatedServiceJourney:20250601",
            "seats": [
              {
                "externalSeatId": "SEAT123",
                "id": 1,
                "railcarNumber": "4",
                "seatNumber": "12",
                "seatType": "WINDOW",
                "seatingProperties": {
                  "fareClass": "STANDARD_CLASS",
                  "accommodationFacility": "SEATING",
                  "seatAttachment": "FIXED",
                  "seatPosition": "WINDOW",
                  "mobilityFacilities": [],
                  "passengerCommsFacilities": [],
                  "sanitaryFacilities": [],
                  "nuisanceFacilities": [],
                  "baggageType": []
                }
              }
            ]
          }
        ],
        "price": {
          "amount": "29.90",
          "currency": "NOK",
          "taxAmount": "5.98",
          "taxRate": "0.20"
        },
        "purchaseDate": "2025-06-01T12:00:00Z",
        "startOfValidity": "2025-06-01T13:00:00Z",
        "endOfValidity": "2025-06-01T14:00:00Z",
        "ticketType": "SINGLE",
        "ticketWithZones": false,
        "type": "SINGLE",
        "topology": {
          "fromStopPlace": "TST:StopPlace:123",
          "fromStopPlaceName": "Central Station",
          "toStopPlace": "TST:StopPlace:456",
          "toStopPlaceName": "Airport",
          "fareZones": [],
          "groupOfTariffZones": []
        },
        "distributionDetails": {
          "customerAccountRef": "ABC:CustomerAccount:209ea428-9457-4ee6-bcc8-3559ffda5dd4",
          "fareContractRef": "ABC:FareContract:ABCD1235-fae3c8b3-5f4b-4d3e-9f7a-2c6e8f4d2b1a"
        }
      }
    ],
    "updatedForOrderLineVersion": 1,
    "fulfillmentMethod": "ACCOUNT_BASED_TICKETING",
    "orderOwnerCustomerId": "123456789",
    "distributionHolderCustomerId": "987654321"
  }
]

json

application/json

deprecated

Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute

POST

https://api.staging.entur.io/sales

/v1/ticket-distributions/{orderId}/distribute-travel-card

Distribute a set of ticket distribution groups to NOD for pick up on 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 › path Parameters

orderId

string · required · style: simple

orderId

Example: NTA2JGR7

Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute › Headers

Entur-Pos

string · required · style: simple

A header containing a point-of-sale reference

Example: MyApplication

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation 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

Request for generating ticket for travel card

TicketTravelCardRequest

activate

boolean · required

Activate the product

mediaSerialNumberId

integer · int64 · min: 0 · max: 4294967295 · required

The media serial number (MSN) ID of the travel card

paymentMeansType

PaymentMeansType · enum · required

The payment means type used to purchase the ticket

Enum values:

NULL

FREE

TPURSE

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

TicketDistributionGroup[]

TicketDistributionGroup

id

integer · int64 · required

orderId

string · required

orderLineId

string · required

orderVersion

integer · int32 · required

TicketDistribution[] · required

updatedForOrderLineVersion

integer · int32 · required

createdByDCI

string

distributedByDCI

string

distributedByOrgId

integer · int64

organisationId

integer · int64

SalesPackage

fulfillmentMethod

string

orderOwnerCustomerId

string

The customerId of the customer that owns the order

distributionHolderCustomerId

string

The customerId of the customer that will receive the ticket

POST/v1/ticket-distributions/{orderId}/distribute-travel-card

curl https://api.staging.entur.io/sales/v1/ticket-distributions/:orderId/distribute-travel-card \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Entur-Pos: <string>' \
  --data '{
  "activate": true,
  "mediaSerialNumberId": 0,
  "paymentMeansType": "NULL"
}'

Example Request Body

{
  "activate": true,
  "mediaSerialNumberId": 0,
  "paymentMeansType": "NULL"
}

json

Example Responses

[
  {
    "id": 123456789,
    "orderId": "ABCD1234",
    "orderVersion": 1,
    "orderLineId": "e9154697-41e6-4955-985e-d474d438a557",
    "orderLineVersion": 1,
    "ticketDistributions": [
      {
        "id": 987654321,
        "distributionStatus": "DISTRIBUTED",
        "authority": {
          "id": "1234",
          "name": "WayFare"
        },
        "customers": [
          {
            "customerId": "12345678901",
            "entitlements": [],
            "id": 1
          }
        ],
        "loyaltyProgram": false,
        "networkId": 1,
        "orderLineVersion": 1,
        "productTemplate": 1,
        "provider": 51,
        "tariffCode": 321,
        "combinedTicket": false,
        "fareProduct": {
          "id": "ABC:PurchasedFareProduct:SingleTicket",
          "version": "ABC:Version:PFP-1",
          "name": "Single Ticket",
          "organisationId": 5678
        },
        "supplementProducts": [],
        "userProfile": {
          "id": "ABC:UserProfile:Adult",
          "version": "ABC:Version:UP-1",
          "name": "Adult"
        },
        "reservations": [
          {
            "id": 1,
            "externalReservationId": "RESV123456",
            "datedServiceJourneyId": "TST:DatedServiceJourney:20250601",
            "seats": [
              {
                "externalSeatId": "SEAT123",
                "id": 1,
                "railcarNumber": "4",
                "seatNumber": "12",
                "seatType": "WINDOW",
                "seatingProperties": {
                  "fareClass": "STANDARD_CLASS",
                  "accommodationFacility": "SEATING",
                  "seatAttachment": "FIXED",
                  "seatPosition": "WINDOW",
                  "mobilityFacilities": [],
                  "passengerCommsFacilities": [],
                  "sanitaryFacilities": [],
                  "nuisanceFacilities": [],
                  "baggageType": []
                }
              }
            ]
          }
        ],
        "price": {
          "amount": "29.90",
          "currency": "NOK",
          "taxAmount": "5.98",
          "taxRate": "0.20"
        },
        "purchaseDate": "2025-06-01T12:00:00Z",
        "startOfValidity": "2025-06-01T13:00:00Z",
        "endOfValidity": "2025-06-01T14:00:00Z",
        "ticketType": "SINGLE",
        "ticketWithZones": false,
        "type": "SINGLE",
        "topology": {
          "fromStopPlace": "TST:StopPlace:123",
          "fromStopPlaceName": "Central Station",
          "toStopPlace": "TST:StopPlace:456",
          "toStopPlaceName": "Airport",
          "fareZones": [],
          "groupOfTariffZones": []
        },
        "distributionDetails": {
          "customerAccountRef": "ABC:CustomerAccount:209ea428-9457-4ee6-bcc8-3559ffda5dd4",
          "fareContractRef": "ABC:FareContract:ABCD1235-fae3c8b3-5f4b-4d3e-9f7a-2c6e8f4d2b1a"
        }
      }
    ],
    "updatedForOrderLineVersion": 1,
    "fulfillmentMethod": "ACCOUNT_BASED_TICKETING",
    "orderOwnerCustomerId": "123456789",
    "distributionHolderCustomerId": "987654321"
  }
]

json

application/json

Generate ticket distributions

POST

https://api.staging.entur.io/sales

/v1/ticket-distributions/{orderId}/generate

Generate a set of ticket distribution groups which later will be distributed to a ticket system.

Generate ticket distributions › path Parameters

orderId

string · required · style: simple

orderId

Example: NTA2JGR7

Generate ticket distributions › Headers

Entur-Pos

string · required · style: simple

A header containing a point-of-sale reference

Example: MyApplication

ET-Client-Name

string · style: simple

X-Correlation-Id

string · style: simple

Correlation id

Accepts-Language

string · style: simple

A header used to select language

Current supported languages are 'nob', 'nno' and 'eng'

Entur-Distribution-Channel

string · style: simple

A header containing a distribution channel reference

Example: ENT:DistributionChannel:App

Generate ticket distributions › Responses

TicketDistributionGroup[]

TicketDistributionGroup

id

integer · int64 · required

orderId

string · required

orderLineId

string · required

orderVersion

integer · int32 · required

TicketDistribution[] · required

updatedForOrderLineVersion

integer · int32 · required

createdByDCI

string

distributedByDCI

string

distributedByOrgId

integer · int64

organisationId

integer · int64

SalesPackage

fulfillmentMethod

string

orderOwnerCustomerId

string

The customerId of the customer that owns the order

distributionHolderCustomerId

string

The customerId of the customer that will receive the ticket

POST/v1/ticket-distributions/{orderId}/generate

curl https://api.staging.entur.io/sales/v1/ticket-distributions/:orderId/generate \
  --request POST \
  --header 'Entur-Pos: <string>'

Example Responses

[
  {
    "id": 123456789,
    "orderId": "ABCD1234",
    "orderVersion": 1,
    "orderLineId": "e9154697-41e6-4955-985e-d474d438a557",
    "orderLineVersion": 1,
    "ticketDistributions": [
      {
        "id": 987654321,
        "distributionStatus": "DISTRIBUTED",
        "authority": {
          "id": "1234",
          "name": "WayFare"
        },
        "customers": [
          {
            "customerId": "12345678901",
            "entitlements": [],
            "id": 1
          }
        ],
        "loyaltyProgram": false,
        "networkId": 1,
        "orderLineVersion": 1,
        "productTemplate": 1,
        "provider": 51,
        "tariffCode": 321,
        "combinedTicket": false,
        "fareProduct": {
          "id": "ABC:PurchasedFareProduct:SingleTicket",
          "version": "ABC:Version:PFP-1",
          "name": "Single Ticket",
          "organisationId": 5678
        },
        "supplementProducts": [],
        "userProfile": {
          "id": "ABC:UserProfile:Adult",
          "version": "ABC:Version:UP-1",
          "name": "Adult"
        },
        "reservations": [
          {
            "id": 1,
            "externalReservationId": "RESV123456",
            "datedServiceJourneyId": "TST:DatedServiceJourney:20250601",
            "seats": [
              {
                "externalSeatId": "SEAT123",
                "id": 1,
                "railcarNumber": "4",
                "seatNumber": "12",
                "seatType": "WINDOW",
                "seatingProperties": {
                  "fareClass": "STANDARD_CLASS",
                  "accommodationFacility": "SEATING",
                  "seatAttachment": "FIXED",
                  "seatPosition": "WINDOW",
                  "mobilityFacilities": [],
                  "passengerCommsFacilities": [],
                  "sanitaryFacilities": [],
                  "nuisanceFacilities": [],
                  "baggageType": []
                }
              }
            ]
          }
        ],
        "price": {
          "amount": "29.90",
          "currency": "NOK",
          "taxAmount": "5.98",
          "taxRate": "0.20"
        },
        "purchaseDate": "2025-06-01T12:00:00Z",
        "startOfValidity": "2025-06-01T13:00:00Z",
        "endOfValidity": "2025-06-01T14:00:00Z",
        "ticketType": "SINGLE",
        "ticketWithZones": false,
        "type": "SINGLE",
        "topology": {
          "fromStopPlace": "TST:StopPlace:123",
          "fromStopPlaceName": "Central Station",
          "toStopPlace": "TST:StopPlace:456",
          "toStopPlaceName": "Airport",
          "fareZones": [],
          "groupOfTariffZones": []
        },
        "distributionDetails": {
          "customerAccountRef": "ABC:CustomerAccount:209ea428-9457-4ee6-bcc8-3559ffda5dd4",
          "fareContractRef": "ABC:FareContract:ABCD1235-fae3c8b3-5f4b-4d3e-9f7a-2c6e8f4d2b1a"
        }
      }
    ],
    "updatedForOrderLineVersion": 1,
    "fulfillmentMethod": "ACCOUNT_BASED_TICKETING",
    "orderOwnerCustomerId": "123456789",
    "distributionHolderCustomerId": "987654321"
  }
]

json

application/json

Ticket Distribution Groups PDF Tickets

Did you find what you were looking for?

Ticket Distributions

Get summary of distribution data for an order

Get summary of distribution data for an order › path Parameters

Get summary of distribution data for an order › Headers

Get summary of distribution data for an order › Responses

Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute

Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute › path Parameters

Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute › query Parameters

Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute › Headers

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

Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute

Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute › path Parameters

Deprecated. Does not handle higher order version than 1, and does not support defining distribution language. Please use /v1/ticket-distribution-groups/{orderId}/distribute › Headers

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

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

Generate ticket distributions

Generate ticket distributions › path Parameters

Generate ticket distributions › Headers

Generate ticket distributions › Responses

Build with Entur

Contribute

Terms & Policies