Skip to content

Booking Schemas

BookingResponse

Full booking details response

Properties

PropertyTypeDescription
infoobject
metaobject
operatorobject
paxobject
pricingobject
partnerobject
transportationobjectOnly included for transfer bookings

BookingRequest

Properties

PropertyTypeDescription
product_idstringProduct ID (e.g., “PRD12031”)
typestring
datestring
timestringTour start time
phoneobject
emailstringContact email address
lead_paxstringLead passenger name
adultsstringComma-separated adult names (By Person Type pricing)
childrenstringComma-separated children names
youthstringComma-separated youth names
studentsstringComma-separated student names
infantsstringComma-separated infant names
participantsintegerTotal number of participants
partner_refstringYour internal booking reference
internal_notesstring
hotel_pickupstringHotel pickup location (if product allows)
traveler_questionsstringAnswers to custom questions (required if product has custom_mandatory=1)
languagestringPreferred tour language
private_tourbooleanBook as private tour
descriptionstringConditionally required for products using the By API pricing model when multiple price slots exist. Pass the description value from the /return_availability response to select the correct slot (e.g., “With tickets” vs “Without tickets”). Can be omitted when only one slot is available.
tokenstringStripe payment token (if not on credit terms)
card_holderstringCardholder name (if paying by card)

BookingCancelRequest

Properties

PropertyTypeDescription
reference_idstringBooking reference to cancel (also accepts id as alias)
reasonstringReason for cancellation (mandatory)

BookingUpdateRequest

Properties

PropertyTypeDescription
idstringBooking reference
notesstringUpdate request details