Skip to main content

Booking Read and List

Booking Query​

The Hotel-X Booking Query operation allows you to retrieve specific reservation details (Booking Read) or a list of reservations made within a specified time frame (Booking List).

What Information Can I Expect in the Booking Query Response?​

Some of the key fields returned in the Booking Query response include:

  • Holder
  • Hotel
  • Price
  • Remarks
  • Status
info
  • For a complete list of available fields, please visit our Hotel-X Documentation and explore the GraphQL Playground.
  • Keep in mind that the information provided in the Booking Query response can vary by Seller. If you require specific fields, we encourage you to contact the Seller directly.

Verifying Accepted Booking Queries by Sellers​

The fields available for querying may vary across Sellers. You can verify the fields supported and any restrictions applied by a Seller through our Metadata Query:

  • "queryableBy" – Specifies if the Seller allows searching via a specific field.
  • "requires" – Indicates if the field is mandatory for the Seller's API.
  • "value" – Confirms if the Seller allows or requires a particular field.
  • "reviewDate" – Shows the last date the field value was verified against the Seller.
info

If you are not using the Hotel-X bookingID input, ensure you specify your accessCode in the HotelCriteriaBookingInput. While the language parameter is optional, including it is recommended for optimal results.

Booking Query: Booking Details​

How Can I Retrieve the Details of a Booking?​

To obtain the details of a specific reservation, you can add either the bookingID (returned in the Book response, highly recommended) or the typeSearch REFERENCES (to be deprecated) to your HotelCriteriaBookingInput.

Booking ID:

{
    "criteriaBookingRead" : {
        "bookingID" : "1@1[241028[241029[230918[1[es[EUR[2[test_0123456789[2596391"
    }
}

References:

{
    "criteriaBookingRead" : {
        "accessCode" : "2",
        "typeSearch" : "REFERENCES",
        "references" : {
            "hotelCode" : "1",
            "currency" : "EUR",
            "references" : [
                {
                    "client" : "test_0123456789",
                    "supplier": "2636944"
                }
            ]
        }
    }
}

Booking Query: Booking List​

How do I get the list of bookings for a specific date range?​

To obtain a list of all reservations made within a specific time frame, perform the Booking Query using typeSearch DATES. Then, specify if your dateType is either BOOKING (booking date) or ARRIVAL (check-in date), along with the start and end dates of the query (YYYY-MM-DD).

Dates:

{
    "criteriaBookingRead" : {
        "accessCode" : "2",
        "typeSearch" : "DATES",
        "dates" : {
            "dateType" : "ARRIVAL",
            "start" : "2024-10-28",
            "end" : "2024-10-28"
        }
    }
}
tip

Don't forget to check our Hotel-X Pull Buyers API Documentation for a full example of a Hotel-X Booking Query!🚀