PDF Tickets

Server

Services for generating and sending pdf tickets.

Search generated and distributed ticket PDFs

GET

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

/v1/pdf-tickets

Searches generated and distributed ticket PDFs. Query parameters support 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 PDFs › query Parameters

id

string[] · style: form · explode: true

PDF ticket id

Example: ["1234"]

Default: []

orderId

string[] · style: form · explode: true

Filters by order ID

Example: ["NTA2JGR7"]

Default: []

orderLineId

string[] · style: form · explode: true

Filters by order line ID

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

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: []

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 PDFs › Headers

ET-Client-Name

string

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> for companies, and <personal name>-<application> for individuals.

X-Correlation-Id

string

Correlation id

Search generated and distributed ticket PDFs › Responses

Page displays a subset of a list of entities

PageOfPdfTicket

PdfTicket[] · 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

Create PDF

POST

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

/v1/pdf-tickets/{orderId}

Creates or gets PDFs with valid tickets. Returns PDFs with qr codes. If a PDF is not created, but found, then the language parameter is irrelevant. PDFs can later be sent by email.

Create PDF › path Parameters

orderId

string · required · style: simple

orderId

Example: NTA2JGR7

Create PDF › Headers

Entur-Pos

string · required · style: simple

A header containing a point-of-sale reference

Example: MyApplication

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Create PDF › Request Body

Request for generating and sending pdf-ticket by email

TicketPdfCreateRequest

pdfLanguage

LanguageCode · enum · required

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

Enum values:

nob

nno

eng

Default: nob

orderVersion

integer · int32 · required

Desired version of the order that is going to be distributed as a pdf-ticket. Default: 1

Default: 1

TicketPdfTraveller[]

Array of names and ticketDistributionIds of travellers. These names will overwrite existing traveller names on the ticket if the order line does not include any entitlements.

Default: []

orderLineIds

string[]

List of orderLineIds to include in the pdf-ticket. If unspecified, all order lines for the given order version will be included.

shouldGroupTravellers

boolean

Flag to indicate that PDF tickets are grouped together for travellers with the same journey.

Default: true

Create PDF › Responses

PdfTicket[]

PdfTicket

pdf

string · pattern: ^(?:[A-Za-z0-9+/]{4}… · required

orderId

string · required

deleteAt

string · date-time · required

orderLineId

string · required

orderVersion

integer · int32 · required

combinedTicket

boolean · required

orderLineVersion

integer · int32 · required

ticketDistributionId

integer · int64 · required

id

integer · int64

organisationId

integer · int64

POST/v1/pdf-tickets/{orderId}

curl https://api.staging.entur.io/sales/v1/pdf-tickets/:orderId \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Entur-Pos: <string>' \
  --data '{
  "travellers": [
    {
      "name": "John Doe",
      "ticketDistributionId": 123456789
    },
    {
      "name": "Karen Smith",
      "ticketDistributionId": 123456790
    }
  ],
  "pdfLanguage": "nob",
  "orderVersion": 2,
  "shouldGroupTravellers": true
}'

Example Request Body

{
  "travellers": [
    {
      "name": "John Doe",
      "ticketDistributionId": 123456789
    },
    {
      "name": "Karen Smith",
      "ticketDistributionId": 123456790
    }
  ],
  "pdfLanguage": "nob",
  "orderVersion": 2,
  "shouldGroupTravellers": true
}

json

Example Responses

[
  {
    "id": 12345,
    "pdf": "JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PC9UeXBlIC9QYWdlL1BhcmVudCA0IDAgUi9SZXNvdXJjZXMgNiAwIFIvTWVkaWFCb3ggWzAgMCA2MTIgNzkyXT4+CmVuZG9iago2IDAgb2JqCjw8L0ZvbnQgNyAwIFIvUHJvY1NldCBbL1BERiAvVGV4dF0+PgplbmRvYmoK",
    "orderId": "ABDC1234",
    "deleteAt": "2024-12-31T23:59:59Z",
    "orderLineId": "26b02145-7dbf-4be9-8600-ff4a570d83d5",
    "orderVersion": 1,
    "combinedTicket": false,
    "organisationId": 1234,
    "orderLineVersion": 1,
    "ticketDistributionId": 67890
  }
]

json

application/json

Send PDF

POST

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

/v1/pdf-tickets/{orderId}/send

Sends an email containing PDFs with valid tickets

Send PDF › path Parameters

orderId

string · required · style: simple

orderId

Example: NTA2JGR7

Send PDF › Headers

Entur-Pos

string · required · style: simple

A header containing a point-of-sale reference

Example: MyApplication

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Send PDF › Request Body

Request for generating and sending pdf-ticket by email

TicketPdfSendRequest

pdfLanguage

LanguageCode · enum · required

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

Enum values:

nob

nno

eng

Default: nob

orderVersion

integer · int32 · required

Desired version of the order that is going to be distributed as a pdf-ticket. Default: 1

Default: 1

email

string · required

Email-address for the receiver of pdf-ticket

TicketPdfTraveller[]

Array of names and ticketDistributionIds of travellers. These names will overwrite existing traveller names on the ticket if the order line does not include any entitlements.

Default: []

orderLineIds

string[]

List of orderLineIds to include in the pdf-ticket. If unspecified, all order lines for the given order version will be included.

shouldGroupTravellers

boolean

Flag to indicate that PDF tickets are grouped together for travellers with the same journey.

Default: true

Send PDF › Responses

EmailAddress[] · required

body

string · required

EmailAddress · required

subject

string · required

EmailAddress[]

EmailAddress

EmailAttachment[]

POST/v1/pdf-tickets/{orderId}/send

curl https://api.staging.entur.io/sales/v1/pdf-tickets/:orderId/send \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Entur-Pos: <string>' \
  --data '{
  "email": "test@mail.com",
  "travellers": [
    {
      "name": "John Doe",
      "ticketDistributionId": 123456789
    },
    {
      "name": "Karen Smith",
      "ticketDistributionId": 123456790
    }
  ],
  "pdfLanguage": "nob",
  "orderVersion": 2,
  "shouldGroupTravellers": true
}'

Example Request Body

{
  "email": "test@mail.com",
  "travellers": [
    {
      "name": "John Doe",
      "ticketDistributionId": 123456789
    },
    {
      "name": "Karen Smith",
      "ticketDistributionId": 123456790
    }
  ],
  "pdfLanguage": "nob",
  "orderVersion": 2,
  "shouldGroupTravellers": true
}

json

Example Responses

{
  "cc": [
    {
      "name": "name",
      "email": "email"
    }
  ],
  "to": [
    {
      "name": "name",
      "email": "email"
    }
  ],
  "bcc": [
    {
      "name": "name",
      "email": "email"
    }
  ],
  "body": "body",
  "from": {
    "name": "name",
    "email": "email"
  },
  "replyTo": {
    "name": "name",
    "email": "email"
  },
  "subject": "subject",
  "attachments": [
    {
      "content": "content",
      "filename": "filename",
      "mimeType": "mimeType",
      "disposition": "ATTACHMENT"
    }
  ]
}

json

application/json

deprecated

Deprecated. Please use /v1/pdf-tickets/{orderId}

POST

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

/v1/pdf-tickets/{orderId}/createOrGet

Creates or gets PDFs with valid tickets. Returns PDFs with qr codes. If a PDF is not created, but found, then the language parameter is irrelevant. PDFs can later be sent by email.

Deprecated. Please use /v1/pdf-tickets/{orderId} › path Parameters

orderId

string · required · style: simple

orderId

Example: NTA2JGR7

Deprecated. Please use /v1/pdf-tickets/{orderId} › Headers

Entur-Pos

string · required · style: simple

A header containing a point-of-sale reference

Example: MyApplication

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Deprecated. Please use /v1/pdf-tickets/{orderId} › Request Body

Request for generating and sending pdf-ticket by email

TicketPdfCreateRequest

pdfLanguage

LanguageCode · enum · required

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

Enum values:

nob

nno

eng

Default: nob

orderVersion

integer · int32 · required

Desired version of the order that is going to be distributed as a pdf-ticket. Default: 1

Default: 1

TicketPdfTraveller[]

Array of names and ticketDistributionIds of travellers. These names will overwrite existing traveller names on the ticket if the order line does not include any entitlements.

Default: []

orderLineIds

string[]

List of orderLineIds to include in the pdf-ticket. If unspecified, all order lines for the given order version will be included.

shouldGroupTravellers

boolean

Flag to indicate that PDF tickets are grouped together for travellers with the same journey.

Default: true

Deprecated. Please use /v1/pdf-tickets/{orderId} › Responses

PdfTicket[]

PdfTicket

pdf

string · pattern: ^(?:[A-Za-z0-9+/]{4}… · required

orderId

string · required

deleteAt

string · date-time · required

orderLineId

string · required

orderVersion

integer · int32 · required

combinedTicket

boolean · required

orderLineVersion

integer · int32 · required

ticketDistributionId

integer · int64 · required

id

integer · int64

organisationId

integer · int64

POST/v1/pdf-tickets/{orderId}/createOrGet

curl https://api.staging.entur.io/sales/v1/pdf-tickets/:orderId/createOrGet \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Entur-Pos: <string>' \
  --data '{
  "travellers": [
    {
      "name": "John Doe",
      "ticketDistributionId": 123456789
    },
    {
      "name": "Karen Smith",
      "ticketDistributionId": 123456790
    }
  ],
  "pdfLanguage": "nob",
  "orderVersion": 2,
  "shouldGroupTravellers": true
}'

Example Request Body

{
  "travellers": [
    {
      "name": "John Doe",
      "ticketDistributionId": 123456789
    },
    {
      "name": "Karen Smith",
      "ticketDistributionId": 123456790
    }
  ],
  "pdfLanguage": "nob",
  "orderVersion": 2,
  "shouldGroupTravellers": true
}

json

Example Responses

[
  {
    "id": 12345,
    "pdf": "JVBERi0xLjQKJcfsj6IKNSAwIG9iago8PC9UeXBlIC9QYWdlL1BhcmVudCA0IDAgUi9SZXNvdXJjZXMgNiAwIFIvTWVkaWFCb3ggWzAgMCA2MTIgNzkyXT4+CmVuZG9iago2IDAgb2JqCjw8L0ZvbnQgNyAwIFIvUHJvY1NldCBbL1BERiAvVGV4dF0+PgplbmRvYmoK",
    "orderId": "ABDC1234",
    "deleteAt": "2024-12-31T23:59:59Z",
    "orderLineId": "26b02145-7dbf-4be9-8600-ff4a570d83d5",
    "orderVersion": 1,
    "combinedTicket": false,
    "organisationId": 1234,
    "orderLineVersion": 1,
    "ticketDistributionId": 67890
  }
]

json

application/json

Ticket Distributions

Search generated and distributed ticket PDFs

GET

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

/v1/pdf-tickets

Search generated and distributed ticket PDFs › query Parameters

id

string[] · style: form · explode: true

PDF ticket id

Example: ["1234"]

Default: []

orderId

string[] · style: form · explode: true

Filters by order ID

Example: ["NTA2JGR7"]

Default: []

orderLineId

string[] · style: form · explode: true

Filters by order line ID

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

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: []

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 PDFs › Headers

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Search generated and distributed ticket PDFs › Responses

Page displays a subset of a list of entities

PageOfPdfTicket

PdfTicket[] · 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

Create PDF

POST

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

/v1/pdf-tickets/{orderId}

Creates or gets PDFs with valid tickets. Returns PDFs with qr codes. If a PDF is not created, but found, then the language parameter is irrelevant. PDFs can later be sent by email.

Create PDF › path Parameters

orderId

string · required · style: simple

orderId

Example: NTA2JGR7

Create PDF › Headers

Entur-Pos

string · required · style: simple

A header containing a point-of-sale reference

Example: MyApplication

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Create PDF › Request Body

Request for generating and sending pdf-ticket by email

TicketPdfCreateRequest

pdfLanguage

LanguageCode · enum · required

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

Enum values:

nob

nno

eng

Default: nob

orderVersion

integer · int32 · required

Desired version of the order that is going to be distributed as a pdf-ticket. Default: 1

Default: 1

TicketPdfTraveller[]

Array of names and ticketDistributionIds of travellers. These names will overwrite existing traveller names on the ticket if the order line does not include any entitlements.

Default: []

orderLineIds

string[]

List of orderLineIds to include in the pdf-ticket. If unspecified, all order lines for the given order version will be included.

shouldGroupTravellers

boolean

Flag to indicate that PDF tickets are grouped together for travellers with the same journey.

Default: true

Create PDF › Responses

PdfTicket[]

PdfTicket

pdf

string · pattern: ^(?:[A-Za-z0-9+/]{4}… · required

orderId

string · required

deleteAt

string · date-time · required

orderLineId

string · required

orderVersion

integer · int32 · required

combinedTicket

boolean · required

orderLineVersion

integer · int32 · required

ticketDistributionId

integer · int64 · required

id

integer · int64

organisationId

integer · int64

Send PDF

POST

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

/v1/pdf-tickets/{orderId}/send

Sends an email containing PDFs with valid tickets

Send PDF › path Parameters

orderId

string · required · style: simple

orderId

Example: NTA2JGR7

Send PDF › Headers

Entur-Pos

string · required · style: simple

A header containing a point-of-sale reference

Example: MyApplication

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Send PDF › Request Body

Request for generating and sending pdf-ticket by email

TicketPdfSendRequest

pdfLanguage

LanguageCode · enum · required

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

Enum values:

nob

nno

eng

Default: nob

orderVersion

integer · int32 · required

Desired version of the order that is going to be distributed as a pdf-ticket. Default: 1

Default: 1

email

string · required

Email-address for the receiver of pdf-ticket

TicketPdfTraveller[]

Array of names and ticketDistributionIds of travellers. These names will overwrite existing traveller names on the ticket if the order line does not include any entitlements.

Default: []

orderLineIds

string[]

List of orderLineIds to include in the pdf-ticket. If unspecified, all order lines for the given order version will be included.

shouldGroupTravellers

boolean

Flag to indicate that PDF tickets are grouped together for travellers with the same journey.

Default: true

Send PDF › Responses

EmailAddress[] · required

body

string · required

EmailAddress · required

subject

string · required

EmailAddress[]

EmailAddress

EmailAttachment[]

Deprecated. Please use /v1/pdf-tickets/{orderId}

POST

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

/v1/pdf-tickets/{orderId}/createOrGet

Creates or gets PDFs with valid tickets. Returns PDFs with qr codes. If a PDF is not created, but found, then the language parameter is irrelevant. PDFs can later be sent by email.

Deprecated. Please use /v1/pdf-tickets/{orderId} › path Parameters

orderId

string · required · style: simple

orderId

Example: NTA2JGR7

Deprecated. Please use /v1/pdf-tickets/{orderId} › Headers

Entur-Pos

string · required · style: simple

A header containing a point-of-sale reference

Example: MyApplication

ET-Client-Name

string

X-Correlation-Id

string

Correlation id

Deprecated. Please use /v1/pdf-tickets/{orderId} › Request Body

Request for generating and sending pdf-ticket by email

TicketPdfCreateRequest

pdfLanguage

LanguageCode · enum · required

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

Enum values:

nob

nno

eng

Default: nob

orderVersion

integer · int32 · required

Desired version of the order that is going to be distributed as a pdf-ticket. Default: 1

Default: 1

TicketPdfTraveller[]

Array of names and ticketDistributionIds of travellers. These names will overwrite existing traveller names on the ticket if the order line does not include any entitlements.

Default: []

orderLineIds

string[]

List of orderLineIds to include in the pdf-ticket. If unspecified, all order lines for the given order version will be included.

shouldGroupTravellers

boolean

Flag to indicate that PDF tickets are grouped together for travellers with the same journey.

Default: true

Deprecated. Please use /v1/pdf-tickets/{orderId} › Responses

PdfTicket[]

PdfTicket

pdf

string · pattern: ^(?:[A-Za-z0-9+/]{4}… · required

orderId

string · required

deleteAt

string · date-time · required

orderLineId

string · required

orderVersion

integer · int32 · required

combinedTicket

boolean · required

orderLineVersion

integer · int32 · required

ticketDistributionId

integer · int64 · required

id

integer · int64

organisationId

integer · int64