Ticket Distributions

Ticket Distribution Groups

Server

Download schema

Services regarding ticket distribution group level.

Search generated and distributed ticket distribution groups

GET

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

/v1/ticket-distribution-groups

Searches generated and distributed ticket distribution groups. Query parameters supports operators eq, ne, gt, gte, lt, lte, in, and nin. Defaults to eq if no operator is given. At least one search parameter is required.

Search generated and distributed ticket distribution groups › query Parameters

id

string[] · style: form · explode: true

Filters by ticket distribution group ID

Example: ["1234"]

Default: []

orderId

string[] · style: form · explode: true

Filters by order ID

Example: ["NTA2JGR7"]

Default: []

orderVersion

string[] · style: form · explode: true

Filters by order version

Example: ["1"]

Default: []

orderLineId

string[] · style: form · explode: true

Filters by order line ID

Example: ["26b02145-7dbf-4be9-8600-ff4a570d83d5"]

Default: []

orderOwnerCustomerId

string[] · style: form · explode: true

Filters by field orderOwnerCustomerId on ticket distribution group. Field is a string with only numeric values.

Example: ["1234"]

Default: []

distributionHolderCustomerId

string[] · style: form · explode: true

Filters by field distributionHolderCustomerId on ticket distribution group. Field is a string with only numeric values.

Example: ["1234"]

Default: []

organisationId

string[] · style: form · explode: true

Filters by organisation if the user has correct privileges

Example: ["1"]

Default: []

ticketDistributionId

string[] · style: form · explode: true

Filters by ticket distribution id

Example: ["1234"]

Default: []

distributionStatus

string[] · style: form · explode: true

Filters by ticket distributions group containing a ticket distribution status matching specified query

Example: ["DISTRIBUTED"]

Default: []

mediaSerialNumberId

string[] · style: form · explode: true

Filters by mediaSerialNumberId, id identifying the ecard

Example: ["1234"]

Default: []

createdAt

string[] · style: form · explode: true

Filters by when ticket distributions were created

Example: ["gte:2023-01-01T00:00:00Z","lt:2023-12-31T23:59:59Z"]

Default: []

updatedAt

string[] · style: form · explode: true

Filters by when ticket distributions last were updated

Example: ["2023-01-01T00:00:00Z","2023-12-31T23:59:59Z"]

Default: []

startOfValidity

string[] · style: form · explode: true

Filters by field startOfValidity on ticket distributions. Must be timestamp string. Supports search in a range by specifying two timestamps each prefixed with an operator.

Example: ["2023-01-01T00:00:00Z","2023-12-31T23:59:59Z"]

Default: []

endOfValidity

string[] · style: form · explode: true

Filters by field endOfValidity on ticket distributions. Must be timestamp string. Supports search in a range by specifying two timestamps each prefixed with an operator.

Example: ["2023-01-01T00:00:00Z","2023-12-31T23:59:59Z"]

Default: []

customers

string[] · style: form · explode: true

Filters by customer id

Example: ["1234"]

Default: []

page

integer · int32 · style: form · explode: true

Selects a specific page in the collection

Example: 2

Default: 1

perPage

integer · int32 · max: 100 · style: form · explode: true

Specifies the number of entries returned in a page. Maximum allowed value is 100.

Example: 20

Default: 30

Search generated and distributed ticket distribution groups › 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

Accepts-Language

string · style: simple

A header used to select language

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

Search generated and distributed ticket distribution groups › Responses

OK

Page displays a subset of a list of entities

PageOfTicketDistributionGroup

TicketDistributionGroup[] · readOnly · required

Items on a specific page

totalItems

integer · int64 · readOnly · required

Total number of items

Example: 72

totalPages

integer · int64 · readOnly · required

Total number of pages available to browse

Example: 9

GET/v1/ticket-distribution-groups

curl https://api.staging.entur.io/sales/v1/ticket-distribution-groups

Example Responses

{
  "items": [
    {
      "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"
    }
  ],
  "totalItems": 72,
  "totalPages": 9
}

json

application/json

Distribute ticket distribution groups

POST

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

/v1/ticket-distribution-groups/distribute

Distribute a set of ticket distribution groups to NOD.

Distribute ticket distribution groups › Headers

Entur-Pos

string · required · style: simple

A header containing a point-of-sale reference

Example: MyApplication

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

Entur-Distribution-Channel

string · style: simple

A header containing a distribution channel reference

Example: ENT:DistributionChannel:App

Distribute ticket distribution groups › Request Body

Distribute a set of ticket distribution groups to NOD

TicketDistributionGroupDistributeRequest

orderId

string · required

ID of the order

orderVersion

integer · int32 · required

Version of the order

Default: 1

deliverAfter

string · date-time

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

OrderLineDistributionRequest[]

List of specific orderlineIds to distribute tickets for. If not specified, all tickets for the order will be distributed.

qrChecksumType

integer · int32

The 'toughness' of the QR-code. If not specified the service will determine it automatically based on deliverAfter and startOfValidity

languageCode

LanguageCode · enum

Desired language. Makes display text appear in defined language - if available. Default: nob

Enum values:

nob

nno

eng

Default: nob

Distribute ticket distribution groups › Responses

OK

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

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-distribution-groups/distribute

curl https://api.staging.entur.io/sales/v1/ticket-distribution-groups/distribute \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Entur-Pos: <string>' \
  --data '{
  "orderId": "orderId",
  "orderVersion": 1,
  "deliverAfter": "2024-08-25T15:00:00Z",
  "orderLineDistributionRequests": [
    {
      "orderLineId": "orderLineId",
      "startOfValidity": "2024-08-25T15:00:00Z",
      "deliverAfter": "2024-08-25T15:00:00Z"
    }
  ],
  "qrChecksumType": 0,
  "languageCode": "nob"
}'

Example Request Body

{
  "orderId": "orderId",
  "orderVersion": 1,
  "deliverAfter": "2024-08-25T15:00:00Z",
  "orderLineDistributionRequests": [
    {
      "orderLineId": "orderLineId",
      "startOfValidity": "2024-08-25T15:00:00Z",
      "deliverAfter": "2024-08-25T15:00:00Z"
    }
  ],
  "qrChecksumType": 0,
  "languageCode": "nob"
}

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

Get specific ticket distribution group by its id

GET

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

/v1/ticket-distribution-groups/{ticketDistributionGroupId}

Get the ticket distribution group located at this path

Get specific ticket distribution group by its id › path Parameters

ticketDistributionGroupId

integer · int64 · required · style: simple

ticketDistributionGroupId

Get specific ticket distribution group by its id › 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

Accepts-Language

string · style: simple

A header used to select language

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

Get specific ticket distribution group by its id › Responses

OK

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

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

GET/v1/ticket-distribution-groups/{ticketDistributionGroupId}

curl https://api.staging.entur.io/sales/v1/ticket-distribution-groups/:ticketDistributionGroupId

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

Transfer the distribution holder for ticket distribution groups

POST

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

/v1/ticket-distribution-groups/transfer-distribution-holder

Transfer the distribution holder for these ticket distribution groups to another customer

Transfer the distribution holder for ticket distribution groups › 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

Entur-Distribution-Channel

string · style: simple

A header containing a distribution channel reference

Example: ENT:DistributionChannel:App

Transfer the distribution holder for ticket distribution groups › Request Body

TransferDistributionHolderRequest

TicketDistributionGroupTransfer[] · required

Transfer the distribution holder for ticket distribution groups › Responses

OK

TransferDistributionHolderResponse

SuccessfulTicketDistributionGroupTransfer[] · required

FailedTicketDistributionGroupTransfer[] · required

POST/v1/ticket-distribution-groups/transfer-distribution-holder

curl https://api.staging.entur.io/sales/v1/ticket-distribution-groups/transfer-distribution-holder \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "ticketDistributionGroupTransfers": [
    {
      "ticketDistributionGroupId": 987654321,
      "toCustomerId": "987654321"
    },
    {
      "ticketDistributionGroupId": 123456789,
      "toCustomerId": "123456789",
      "toCustomerAccountRef": "ABC:CustomerAccount:209ea428-9457-4ee6-bcc8-3559ffda5dd4"
    }
  ]
}'

Example Request Body

{
  "ticketDistributionGroupTransfers": [
    {
      "ticketDistributionGroupId": 987654321,
      "toCustomerId": "987654321"
    },
    {
      "ticketDistributionGroupId": 123456789,
      "toCustomerId": "123456789",
      "toCustomerAccountRef": "ABC:CustomerAccount:209ea428-9457-4ee6-bcc8-3559ffda5dd4"
    }
  ]
}

json

Example Responses

{
  "successfulTicketDistributionGroupTransfers": [
    {
      "ticketDistributionGroupId": 987654321
    }
  ],
  "failedTicketDistributionGroupTransfers": [
    {
      "ticketDistributionGroupId": 123456789,
      "errorMessage": "Ticket distribution group not found"
    }
  ]
}

json

application/json

Update the validity of ticket distribution groups

POST

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

/v1/ticket-distribution-groups/update-validities

Update the validity of the ticket distribution groups, the endOfValidity is calculated automatically

Update the validity of ticket distribution groups › 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

Entur-Distribution-Channel

string · style: simple

A header containing a distribution channel reference

Example: ENT:DistributionChannel:App

Update the validity of ticket distribution groups › Request Body

UpdateValiditiesRequest

UpdateValidityRequest[] · required

Update the validity of ticket distribution groups › Responses

OK

UpdateValiditiesResponse

SuccessfulValidityUpdates[] · required

FailedValidityUpdates[] · required

POST/v1/ticket-distribution-groups/update-validities

curl https://api.staging.entur.io/sales/v1/ticket-distribution-groups/update-validities \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "updateValidities": [
    {
      "ticketDistributionGroupId": 123456789,
      "ticketDistributionId": 987654321,
      "startOfValidity": "2024-07-01T00:00:00Z"
    },
    {
      "ticketDistributionGroupId": 223344556,
      "ticketDistributionId": 112233445,
      "elementId": "element-001",
      "startOfValidity": "NOW"
    }
  ]
}'

Example Request Body

{
  "updateValidities": [
    {
      "ticketDistributionGroupId": 123456789,
      "ticketDistributionId": 987654321,
      "startOfValidity": "2024-07-01T00:00:00Z"
    },
    {
      "ticketDistributionGroupId": 223344556,
      "ticketDistributionId": 112233445,
      "elementId": "element-001",
      "startOfValidity": "NOW"
    }
  ]
}

json

Example Responses

{
  "successfulValidityUpdates": [
    {
      "ticketDistributionGroupId": 123456789
    }
  ],
  "failedValidityUpdates": [
    {
      "ticketDistributionGroupId": 987654321,
      "errorMessage": "Ticket distribution not found"
    }
  ]
}

json

application/json

Distribute travel card tickets by order ID

POST

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

/v1/ticket-distribution-groups/distribute/travel-card/by-order-id/{orderId}

Distribute a set of travel card tickets to NOD for pick-up based on an order ID.

Distribute travel card tickets by order ID › path Parameters

orderId

string · required · style: simple

orderId

Example: NTA2JGR7

Distribute travel card tickets by order ID › Headers

Entur-Pos

string · required · style: simple

A header containing a point-of-sale reference

Example: MyApplication

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

Distribute travel card tickets by order ID › 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

Distribute travel card tickets by order ID › Responses

OK

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

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-distribution-groups/distribute/travel-card/by-order-id/{orderId}

curl https://api.staging.entur.io/sales/v1/ticket-distribution-groups/distribute/travel-card/by-order-id/:orderId \
  --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

Ticket Distributions

Did you find what you were looking for?