v1

latestOpenAPI 3.1.02026-07-234140131.3 KB
Booking API

Retrieve tickets

get/orders/{orderReferenceId}/tickets

Path parameters

orderReferenceIdstring required

Tiqets Order ID.

Query parameters

langstring

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

Headers

Authorizationstring required

Token <Your_API_Key>.

Response

Successful operation.

successboolean
order_reference_idstring

Unique order reference ID.

order_status'new' | 'pending' | 'failed' | 'done' | 'cancelled'

The order status, as one of the following values:

  • new: Order is successfully created in Tiqets but not yet confirmed by the distributor.
  • pending: Order is confirmed; Tiqets is currently working on the fulfilment.
  • failed: Order fulfilment failed.
  • done: Order is fulfilled and the PDF tickets are ready.
  • cancelled: A previously fulfilled order has been cancelled.
how_to_use_infostring nullable

Instructions of how to use the tickets. Also displayed on the voucher.

post_purchase_infostring nullable

Post-purchase information.

tickets_pdf_urlstring nullable

URL to PDF document with the tickets. Language on the voucher follows order language as defined at order creation. Value is null unless the order_status is done.

must_knowstring nullable

Important information. Also displayed on the voucher.

pre_purchasestring nullable

Pre-purchase information.

good_to_knowstring nullable

Additional information.

includedstring nullable

Description of what is included in the ticket.

excludedstring nullable

Description of what is explicitly not included in the ticket.

has_timeslotsboolean nullable

Indicates whether the product has timeslots.

has_dynamic_pricingboolean

Indicates whether the product has dynamic pricing.

customer_data_required_on_create_orderboolean

This element can be ignored and is only returned for compatibility with legacy integrations. Always true.

starting_point_addressstring nullable

Address of the starting point.

starting_point_latitudenumber nullable

Latitude of the starting point.

starting_point_longitudenumber nullable

Longitude of the starting point.

starting_point_city_idinteger nullable

Tiqets city ID of the starting point.