Skip to content

Schemas and Models

Property Required Type Description
city Yes string City
country Yes string Country
countryCode Yes string Country code
state Yes string State
postalCode No string Postal code
street No string Street
Property Required Type Description
name Yes string Attribute name
value Yes string Attribute value
Property Required Type Description
id Yes int Reservation ID
status Yes Status Reservation status
hotels Yes [Hotel] Hotels in reservation
amount Yes decimal Total amount
taxes Yes decimal Reservation taxes
client Yes Client Holder
cancellationPolicies Yes [CancellationPolicy] Penalty policies
currency Yes string Reservation currency
Property Required Type Description
bookingKey Yes string From booking hold
clientReference Yes string Partner reference. It cannot be used to look up a booking through the API.
roomCriteria No [RoomCriteria] Pax info
client Yes Client Reservation holder
payment No Payment Payment info — Deprecated: do not send it
commentsForHotel No string Special requirements

In a sample where client had been sent in BookingHold, a BookingNew request without client was accepted (HTTP 200). See Guest data in the hold.

Property Required Type Description
startDate Yes datetime UTC. When penalty starts
endDate Yes datetime Deprecated — do not rely on
amount Yes decimal Penalty amount
currency Yes string Currency
Property Required Type Description
name Yes string (A-Z, a-z, 0-9) First name
surname Yes string (A-Z, a-z, 0-9) Last name
contactData Yes [ContactData] Contact info
Property Required Type Description
email No string Email
phone No Phone Phone object
Property Required Type Description
bookingId Yes int Booking ID
clientReference Yes string Partner reference. It cannot be used to look up a booking through the API.
status Yes Status Booking status
amount Yes decimal Final amount
cancellationPolicies Yes [CancellationPolicy] Penalty policies
oldAmount No decimal Original amount before any rate change
Property Required Type Description
id Yes string Currency ID
name Yes string Currency name
Property Required Type Description
code Yes string Error code
type Yes string Error category
message Yes string Description
Property Required Type Description
type Yes FeeType Fee type
amount Yes decimal Fee value
Property Required Type Description
total Yes decimal Total fees
details Yes [Fee] Per-fee breakdown
currency Yes string Fee currency
Property Required Type Description
id Yes int Hotel ID
name No string Name
rooms No [Room] Rooms
Property Required Type Description
checkIn Yes string Arrival date
checkOut Yes string Departure date
roomCriteria Yes [RoomCriteria] Requested rooms
hotelIds Yes [int] Up to 50
hotelRateFilter No HotelRateFilter Rate filters
market No string ISO country code
Property Required Type Description
nonRefundable No bool Rate filter. Observed to have no effect in one Integration sample — see HotelRates. Default false
Property Required Type Description
age Yes int <17 = minor
name No string Guest name
surname No string Guest surname

In a BookingGet response where pax names had been sent in HotelRates, those names were not reflected; primaryGuest contained the booking holder’s name from client. Do not expect pax names sent in HotelRates to be returned by BookingGet. In a BookingGet response where roomCriteria had been sent in BookingHold, the primaryGuest of each room was the first pax of that room, and the other pax names did not appear. See Guest data in the hold.

Property Required Type Description
type Yes PaymentType Payment type
card Yes PaymentCard Card info
Property Required Type Description
type Yes PaymentCardType VI / MC / AE
holderName Yes string Cardholder name
number Yes string Card number
expirationMonth Yes int MM
expirationYear Yes int YYYY
cvc Yes string Security code
Property Required Type Description
countryCode Yes string Country code
number Yes string Phone number
Property Required Type Description
rateKey Yes string Quoted rate ID
clientCurrency Yes string Display currency
cancellationPolicies Yes [CancellationPolicy] Penalties
reservationPolicies Yes [ReservationPolicy] Reservation conditions
amount Yes decimal Net rate amount
publicAmount Yes decimal Recommended sale price
taxes Yes Taxes Taxes object
feesNotIncluded No Fees Charges paid at hotel
Property Required Type Description
type Yes PolicyType Policy type
description Yes string Details
Property Required Type Description
id Yes int Room ID
name No string Room name
rates No [Rate] Available rates
Property Required Type Description
paxes Yes [Pax] Occupants
Property Required Type Description
type Yes TaxType Tax type
amount Yes decimal Amount
Property Required Type Description
total Yes decimal Total taxes
details Yes [Tax] Per-tax breakdown

Value Description
CREATED The booking is registered but not CONFIRMED. Do not treat it as a confirmed booking.
CONFIRMED PT has accepted the booking and is responsible for it to the partner.
CANCELLED Created and cancelled
Value Description
SYSTEM System error
VALIDATION Validation error
APPLICATION App error
SECURITY Security error
Value Description
RESORT Resort fee charged by hotel
Value Description
VI Visa
MC Master Card
AE American Express
Value Description
VC Virtual credit card
Value Description
RESERVATION Reservation conditions
MEAL_PLAN Meal plan included
Value Description
MANDATORY Mandatory taxes
HOSPITALITY Hospitality taxes
OTHERS Untyped taxes