Create order

Creates a non-confirmed order (reservation) that expires after 30 minutes. To confirm an already created order, use the Confirm Order endpoint.

Order creation may fail validation for reasons such as insufficient availability, invalid/missing customer data or if we were unable to generate a reservation on the supplier's booking platform.

Also see Error Codes

Ticket Language

By default, emails sent to the customers by Tiqets as well as the PDF tickets are made available in English. It is possible to set the language to any of the supported Tiqets languages by using the query parameter `lang`.

We recommend using the parameter if the customer has a preferred language different to English. By setting the language to the customer's preferred language, you make sure that the customer receives all relevant details in a language they understand.

Creating orders with external reference

The Tiqets Distributor API allows partners to add their own order reference ID (external reference) when creating orders. This external reference will be added in Tiqets' order system to help partners:

  • Cross-reference orders from a partner's system to Tiqets' orders

  • Handle errors in case of timeout or other errors during the order creation

The external reference ID's max. length is 255 characters and must be unique. Attempting to re-use an external reference ID will result in a unique constraint error response.

In case of timeouts or other errors during order creation, the own reference ID can be used to check the order status using the 'Get Order Information' endpoint.

Order Status Change Notification Webhook

The optional callback_url parameter can be used to provide a URL on your systems that we will call to inform you the status of this order has changed.

For more info: See the webhook's specific documentation.

Create order

post
/orders
Query parameters
langstringOptional

Language of the variants to retrieve.

Example: en
Header parameters
AuthorizationstringRequired

Token <Your_API_Key>.

Default: Token <Partner_API_key>.
Body
product_idintegerRequired

ID of the product

daystring · dateRequired

Visit date of the product

Example: 2019-06-01
timeslotstring | nullOptional

Selected timeslot to visit. Required only for products that manage their availability using timeslots

passport_idstring | nullOptional

Passport ID of the (main) visitor. Only if required for the product as advertised in Availability API. (On order level, not per individual visitor.)

zipcodeinteger | nullOptional

The 5-digit US zipcode/postal code if the visitor lives in the United States. Only if required for the product as advertised in Availability API. (On order level, not per individual visitor.)

pickup_locationstring | nullOptional

The holiday address of visitors. The tour provider may contact the visitor to arrange the nearest pickup location. Only if required for the product as advertised in Availability API. (On order level, not per individual visitor.)

dropoff_locationstring | nullOptional

The address where the visitors want to be dropped off after the ordered product/activity. Only if required for the product as advertised in Availability API. (On order level, not per individual visitor.)

flight_numberstring | nullOptional

The number of the flight the visitors arrive with. This allows the supplier to be at the right time and location if a product includes an airport pickup/dropoff. Only if required for the product as advertised in Availability API. (On order level, not per individual visitor.)

callback_urlstring | nullOptional

Optional Callback URL (webhook) for order status change notifications. This URL will be called for all order status changes, including cancellation.

external_referencestring | nullOptional

Partner's order reference ID. Maximum 255 characters, needs to be unique

Responses
200

Successful operation.

application/json
post
/orders

Last updated

Was this helpful?