Create, send, and query receipts
Send receipt
Send a receipt. Content will be defined by order ID and version of order. Receipts can only be made for orderVersions where there been a payment or a credit.
query Parameters
organisationIdreceiptTypeOverwrite receipt type if present
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
Send receipt › Request Body
orderIdOrder id to generate receipt
Request for sending a receipt to a customer using one or more distribution methods. Will only send email if both email and telephone are provided. To send sms, leave email as null.
orderVersionWhich version of the order that should be used to generate a receipt
copyReceiptSet to true when the receipt is a copy.
serialNumberThe desired serial number for the receipt
receiptLanguageDesired language of the receipt. Currently only supporting 'nob' and 'eng'
Send receipt › Responses
Ok
referenceReference to receipt
Get receipt type
Returns the type of receipt a combination of order ID and version will result in.
query Parameters
orderIdFilters by order ID
orderVersionFilters by order version
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 receipt type › Responses
Ok
receiptTypeType of receipt
Get pickup code message
Get the text used for pickup code message for an order in given language to send as message to the customer.
path Parameters
orderIdOrder id to generate pickup code message for
query Parameters
orderVersionWhich version of the order that should be used to generate a summary
languageDesired language of the message. Currently supporting 'nob', 'nno' and 'eng'
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 pickup code message › Responses
Ok