Sign in

v1

latestOpenAPI 3.1.02026-07-234140131.3 KB
Booking API

Create order

post/orders

Query parameters

langstring

Language of the variants to retrieve.

Order language. The language of the generated tickets follow this language. Defaults to English if undefined.

Headers

Authorizationstring required

Token <Your_API_Key>.

Request body

product_idinteger required

ID of the product

daystring date required

Visit date of the product

timeslotstring nullable

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

passport_idstring nullable

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 nullable

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 nullable

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 nullable

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 nullable

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 nullable

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

external_referencestring nullable

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

Response

Successful operation.

successboolean
order_reference_idstring

The unique order reference ID created for this order.

payment_confirmation_tokenstring

Unique token that must be used to confirm the order.

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