All about Hotel-X Booking Query
The Booking List operation (Booking Query) allows to retrieve either the details of a specific reservation or a list of the reservations made in a given time frame.
Booking List
In order to receive a list of all the reservations made in a specific type frame you should perform the Booking query by "Dates".
Some of the fields to be requested are:
- Holder
- Hotel
- Price
- Remarks
- Status
Below you will find an example of Booking by "Dates" - note that the information returned might vary between Sellers:
{"query":"query ($criteriaBookingRead: HotelCriteriaBookingInput!, $settings: HotelSettingsInput!) {\n hotelX {\n booking(criteria: $criteriaBookingRead, settings: $settings) {\n auditData {\n transactions {\n request\n response\n }\n }\n bookings {\n reference {\n client\n supplier\n }\n holder {\n name\n surname\n }\n hotel {\n creationDate\n checkIn\n checkOut\n hotelCode\n hotelName\n boardCode\n occupancies {\n id\n paxes {\n age\n }\n }\n rooms {\n occupancyRefId\n code\n description\n price {\n currency\n binding\n net\n gross\n exchange {\n currency\n rate\n }\n markups {\n channel\n currency\n binding\n net\n gross\n exchange {\n currency\n rate\n }\n }\n }\n }\n }\n price {\n currency\n binding\n net\n gross\n exchange {\n currency\n rate\n }\n markups {\n channel\n currency\n binding\n net\n gross\n exchange {\n currency\n rate\n }\n }\n }\n cancelPolicy {\n refundable\n cancelPenalties {\n hoursBefore\n penaltyType\n currency\n value\n }\n }\n remarks\n status\n payable\n }\n errors {\n code\n type\n description\n }\n warnings {\n code\n type\n description\n }\n }\n }\n}","variables":{"criteriaBookingRead":{"accessCode":"","language":"en","dates":{"dateType":"BOOKING","start":"2020-10-17","end":"2020-10-18"},"typeSearch":"DATES"},"settings":{"client":"","context":"","auditTransactions":true}}}
Booking Details
In order to receive the details of a specific reservation you should perform the Booking query either by "BookingID" (strongly recommended) or by "Reference" (to be deprecated) - note that the information returned might vary between Sellers:
Some of the fields to be requested are:
- Holder
- Hotel
- Price
- Remarks
- Status
Below you will find an example of Booking by "bookingID":
{"query":"query ($criteriaBookingRead: HotelCriteriaBookingInput!, $settings: HotelSettingsInput!) {\n hotelX {\n booking(criteria: $criteriaBookingRead, settings: $settings) {\n auditData{\n\t\t\t\ttransactions{\n\t\t\t\t\trequest\n\t\t\t\t\trequest\n\t\t\t\t}\n\t\t\t\ttimeStamp\n\t\t\t}\n bookings {\n reference {\n client\n supplier\n bookingID\n }\n holder {\n name\n surname\n }\n hotel {\n creationDate\n checkIn\n checkOut\n hotelCode\n hotelName\n boardCode\n occupancies {\n id\n paxes {\n age\n }\n }\n rooms {\n occupancyRefId\n code\n description\n price {\n currency\n binding\n net\n gross\n exchange {\n currency\n rate\n }\n markups {\n channel\n currency\n binding\n net\n gross\n exchange {\n currency\n rate\n }\n }\n }\n }\n }\n price {\n currency\n binding\n net\n gross\n exchange {\n currency\n rate\n }\n markups {\n channel\n currency\n binding\n net\n gross\n exchange {\n currency\n rate\n }\n }\n }\n cancelPolicy {\n refundable\n cancelPenalties {\n hoursBefore\n penaltyType\n currency\n value\n }\n }\n remarks\n status\n payable\n }\n errors {\n code\n type\n description\n }\n warnings {\n code\n type\n description\n }\n }\n }\n}","variables":{"criteriaBookingRead":{"accessCode":"","language":"en","typeSearch":"REFERENCES","bookingID":"","references":{"hotelCode":"","currency":"","references":[{"supplier":"","client":""}]}},"settings":{"client":"","auditTransactions":true,"context":"","testMode":false}}}
You will find more information on our Documentation and API Schema.