Sign in

v1

latestOpenAPI 3.1.02026-07-234140131.3 KB
Booking API

Get order information

get/orders/{orderReferenceId}

Path parameters

orderReferenceIdstring required

Unique ID of order.

Query parameters

langstring

Language of the content to retrieve (ISO 639-1). Defaults to English if undefined.

externalboolean

Set this parameter to true to trace an order using the partner's own order ID (defined as external_reference upon order creation) as orderReferenceId.

Headers

Authorizationstring required

Token <Your_API_Key>.

Response

Successful operation.

product_idinteger

ID of the booked product.

promoted_product_idinteger nullable

Only applicable for products that aggregate the availability of a group of products. The promoted_product_id is the ID that was originally promoted while the actually booked product is different.

order_reference_idstring

Order reference ID of the order.

basket_reference_idstring

Basket reference ID of the order.

daystring date nullable

Booked visit date.

timeslotstring nullable

Booked timeslot at the given visit date.

order_statusstring

The order status, as one of the following values:

  • new: Order was created, but not yet confirmed or paid.
  • pending: Order was confirmed or paid, and the tickets are still being processed.
  • failed: Order was not paid or the ticket processing failed.
  • done: Order was completed and PDF tickets have been generated.
  • cancelled: Order was cancelled after it had been completed.
is_currently_cancellableboolean

Indicates if the order is currently eligible for cancellation.

cancellation_deadlinestring nullable

The latest timestamp allowed for the order cancellation. Only returned if the value of is_currently_cancellable is true. Format ISO_8601 YYYY-MM-DDTHH:MM:SS±HH:MM.

external_referencestring nullable

External order ID as provided upon order creation API request. Unique, maximum 255 characters

expected_ticket_delivery_datestring date nullable

The date on which the tickets will be expected to be delivered. Relevant when ticket_delivery != direct_via_tiqets_api