Retrieving modified/cancelled reservations

Modified or cancelled reservation message implies that there were changes to the reservation after you have acknowledged the original reservation message. However, if there were changes to the reservation before you could acknowledge the original new reservation message, then you can still retrieve the reservation as a new reservation message.

To process modified or cancelled reservations using OTA specifications:

  1. Retrieve the modified or cancelled reservations, and,
  2. Acknowledge that you have processed the reservations.

To retrieve modified or cancelled reservations

GET 
https://secure-supply-xml.booking.com/hotels/ota/OTA_HotelResModifyNotif

Use the OTA_HotelResModifyNotif endpoint to get all the modified or cancelled property reservations made through the Booking.com channels.

To ensure timely delivery of data, call GET OTA_HotelResModifyNotif once per twenty seconds. However, to help ensure that acknowledgements have been processed, wait five seconds between POST OTA_HotelResModifyNotif and the next GET OTA_HotelResModifyNotif.

Similar to new reservations, you can apply filters to retrieve:

  • A single reservation.
  • Reservations specific to certain properties specified by property IDs.
  • Reservations made since a specified date.
  • A maximum number of reservations to return per call.

Query parameters

The following table describes the optional elements you can add as query parameters to filter the incoming reservations.

Use filters sparingly

To process reservations optimally, Booking.com recommends that you use these parameters sparingly and only while retrieving reservations immediately after an unexpected outage. Make sure to remove these parameters after recovering from unexpected events.

Element Description Type Required/Optional Notes
id Specify a reservation ID to retrieve a single reservation. integer optional Specify a reservation ID that you have already retrieved. For accurate results, use the hotel_ids parameter and specify the property ID. With this parameter, you may access reservations made more than two weeks in the past.
Use the OTA_HotelResModifyNotif endpoint for reservations that have been modified or cancelled and OTA_HotelResNotif for all other reservations.
For example, https://secure-supply-xml.booking.com/hotels/ota/OTA_HotelResNotif?id=2672953870&hotel_ids=8011855
hotel_ids Specify the unique property ID(s), separated by comma, to limit results to those hotels. You can specify, for example, 10 property IDs. integer optional When retrieving reservations for multiple properties using this parameter, if you do not have access to some properties, the API returns a Warning in the response only for those properties while returning reservations for all other properties that you have access to. Use this parameter to restrict the results to a given property.
For example, when servicing an interactive request, you may pass hotel_ids for the partner account and id from an input field. If they do not match, the API returns 404 status. For example, https://secure-supply-xml.booking.com/hotels/ota/OTA_HotelResNotif?id=2672953870&hotel_ids=8011855,8011857
last_change Specify a date, in the format YYYY-MM-DD HH:MM:SS (GMT+1 Europe/Amsterdam), to retrieve all reservations that were made, modified or cancelled since the specified date. datetime optional Using this filter, the API selects reservations starting from the oldest reservation message. Note that the order may not be chronological. Note that this differs from the ordinary selection of only new bookings. You can limit the returned reservations count by specifying the limit parameter.
You can request reservations up to 2 weeks in the past. Reservations are returned regardless of whether they have already been acknowledged. Warning: Use this parameter only when recovering lost reservations after an unexpected outage.
limit Specify a maximum number of reservations to return. Specify a value >=10 and <= 500. integer optional The API may return reservations less than the specified limit based on the immediate availability of data, even if there are enough reservations to satisfy the limit. This filter can improve latency at the expense of throughput, therefore it adds a risk of a throughput bottleneck. It is not recommended to use a low value when retrieving new bookings and modifications.

Query parameter example

The following query retrieves modified or cancelled reservation(s) for properties with IDs 8011855 and 8011856 that were made since 2022-04-01. The query pulls 200 results per call, in case the result set runs longer than that.

GET https://secure-supply-xml.booking.com/hotels/ota/OTA_HotelResModifyNotif?hotel_ids=8011855,8011856,last_change=2022-04-01 00:00:00,limit=200

Response body example

The following is a successful response body example:

<?xml version="1.0" encoding="UTF-8"?>
<OTA_HotelResModifyNotifRQ xmlns="http://www.opentravel.org/OTA/2003/05" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.opentravel.org/OTA/2003/05 OTA_HotelResModifyNotifRQ.xsd" TimeStamp="2022-03-24T16:05:05+00:00" Target="Production" Version="2.001">
    <HotelResModifies>
        <HotelResModify>
            <RoomStays>
                <RoomStay IndexNumber="167">
                    <RoomTypes>
                        <RoomType RoomTypeCode="801185504">
                            <RoomDescription Name="Quadruple Room - General - Breakfast included">
                                <Text>Rooms are 13 square metres.</Text>
                                <MealPlan>Breakfast is included in the room rate.</MealPlan>
                                <MaxChildren>0</MaxChildren>
                            </RoomDescription>
                        </RoomType>
                    </RoomTypes>
                    <RatePlans>
                        <RatePlan>
                            <Commission>
                                <CommissionPayableAmount Amount="1128" DecimalPlaces="2" CurrencyCode="EUR"/>
                            </Commission>
                        </RatePlan>
                    </RatePlans>
                    <RoomRates>
                        <RoomRate EffectiveDate="2022-04-11" RatePlanCode="25278032">
                            <Rates>
                                <Rate>
                                    <Total AmountAfterTax="2000" DecimalPlaces="2" CurrencyCode="EUR" />
                                </Rate>
                            </Rates>
                        </RoomRate>
                        <RoomRate EffectiveDate="2022-04-12" RatePlanCode="25278032">
                            <Rates>
                                <Rate>
                                    <Total AmountAfterTax="2000" DecimalPlaces="2" CurrencyCode="EUR" />
                                </Rate>
                            </Rates>
                        </RoomRate>
                        <RoomRate EffectiveDate="2022-04-13" RatePlanCode="25278032">
                            <Rates>
                                <Rate>
                                    <Total AmountAfterTax="2000" DecimalPlaces="2" CurrencyCode="EUR" />
                                </Rate>
                            </Rates>
                        </RoomRate>
                    </RoomRates>
                    <GuestCounts>
                        <GuestCount Count="2"/>
                    </GuestCounts>
                    <Total AmountAfterTax="6000" DecimalPlaces="2" CurrencyCode="EUR"></Total>
                    <BasicPropertyInfo HotelCode="8011855"/>
                    <ResGuestRPHs>
                        <ResGuestRPH RPH="1"/>
                    </ResGuestRPHs>
                    <SpecialRequests>
                        <SpecialRequest Name="smoking preference">
                            <Text>Non-Smoking</Text>
                        </SpecialRequest>
                    </SpecialRequests>
                </RoomStay>
            </RoomStays>
            <ResGuests>
                <ResGuest ResGuestRPH="1">
                    <Profiles>
                        <ProfileInfo>
                            <Profile>
                                <Customer>
                                    <PersonName>
                                        <Surname>Dory B</Surname>
                                    </PersonName>
                                </Customer>
                            </Profile>
                        </ProfileInfo>
                    </Profiles>
                </ResGuest>
            </ResGuests>
            <ResGlobalInfo>
                <Comments>
                    <Comment ParagraphNumber="1">
                        <Text>** Genius Booker **</Text>
                    </Comment>
                </Comments>
                <Total AmountAfterTax="6000" DecimalPlaces="2" CurrencyCode="EUR" />
                <HotelReservationIDs>
                    <HotelReservationID ResID_Value="2254083207" ResID_Date="2022-03-24T16:01:39"/>
                </HotelReservationIDs>
                <Profiles>
                    <ProfileInfo>
                        <Profile>
                            <Customer>
                                <PersonName>
                                    <GivenName>Dory</GivenName>
                                    <Surname>B</Surname>
                                </PersonName>
                                <Address>
                                    <AddressLine></AddressLine>
                                    <CityName></CityName>
                                    <PostalCode></PostalCode>
                                    <CountryName Code="NL" />
                                    <CompanyName></CompanyName>
                                </Address>
                            </Customer>
                        </Profile>
                    </ProfileInfo>
                </Profiles>
            </ResGlobalInfo>
        </HotelResModify>
    </HotelResModifies>
</OTA_HotelResModifyNotifRQ>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9Yesl4MHBAMOxcc2yCMFSrdKRHoNVTchP8eldx3ay2yvH8nRb31Y2KdiMxiChLmBDukzMBLVYHXZx2ZEHX60KCos=] -->

Response body elements

To better understand each response element that make up the response body, this section is split into multiple tables.

The response body contains the following high-level root elements:

Reservation details

Element Attribute Description Type Notes
OTA_HotelResModifyNotifRQ Contains the response data. object
>HotelResModifies Contains the modified/cancelled property reservations for each specified property. object
>>HotelResModify Contains individual property reservation details that were modified/cancelled. object
>>> RoomStays Contains the booked room details per reservation. object
>>> Services Contains details of services that the guest is eligible for. object To view this and its child elements, make sure to enable the feature: Get extra information for reservations (res_extra_info).

Booked room details

The following table lists all the elements that consolidate details per booked room.

Element Attribute Description Type Notes
RoomStay Contains the room reservation details for each booked room. object The details include Booking.com room type, rate plan, commission payable, guest count, and reference to guest details among others.
IndexNumber Specifies a unique ID generated by Booking.com for each booked room in the reservation. integer Use this ID to identify the booked room within the reservation. Unique for every booked room.
> RoomTypes Contains the room type details for each booked room. object
>> RoomType Contains the individual room type details for each reservation. object
RoomTypeCode Specifies the unique room type ID generated by Booking.com at the time of creating the room type. integer
>>> RoomDescription Contains a description of the booked room. object
Name Specifies the room name for the booked room. string Booking.com generates the name from the following values: room name, cancellation policy and meal plan name.
>>>> Text Specifies the room description for the booked room. string Booking.com populates this field based on the property’s settings in the room amenity and room details.
>>>> MealPlan Specifies the meal plan information applicable for the booked room. string
>>>> MaxChildren Specifies the maximum number of children who can stay in the booked room for free. integer This is a static setting defined per room. Guests cannot specify a value for the MaxChildren attribute during the booking process. The maximum age of the children can be found in the policy of the property. The property can request this setting through the Booking.com Connectivity Support team or check in the Booking.com Extranet.
>>> Amenities Contains the details of all the facilities available in the room and at the property at the time of reservation. object
>>>> Amenity Specifies the details of each facility available in the room and at the property at the time of reservation. string
> RatePlans Contains the rate plan information for the reservation. object
>> RatePlan Contains individual rate plan information for the reservation. object
>>> Commission Contains the commission information for each reservation that the property owes to Booking.com. object
>>>> CommissionPayableAmount Contains the individual commission information. object
Amount Captures the total commission due for this room for all nights combined. integer
DecimalPlaces Specifies the number of decimal places to represent the minor unit of a particular currency. integer For example, Amount=13350 with DecimalPlaces="2" represents 133.50.
CurrencyCode Specifies the currency used for pricing the commission. enumerated string This is always the same for a property and is set by Booking.com.
> RoomRates Contains the room price and rate plan information. object
>> RoomRate Contains individual room price and rate plan information. object
EffectiveDate Specifies the start date of the stay. datetime
RatePlanCode Specifies the unique rate plan code generated by Booking.com at the time of creating the rate plan. integer
>>> Rates Contains room rate information. object
>>>> Rate Contains individual room rate information. object
>>>>> Total Contains information about the total price. object
AmountAfterTax/AmountBeforeTax Specifies the total price including all relevant taxes. integer If the property has both Including VAT and Including taxes enabled in the Extranet (VAT/Tax/Charges page under the Property tab), the API returns AmountAfterTax, otherwise it returns AmountBeforeTax.
CurrencyCode Specifies the currency used for pricing. enumerated string This is always the same for a property and is set by Booking.com.
DecimalPlaces Specifies the number of decimal places to represent the minor unit of a particular currency. integer For example, Amount=13350 with DecimalPlaces="2" represents 133.50.
>> TPA_Extensions Contains additional reservation details for each booked room. object To see this and GuestCounts element, you must enable the feature: Include room-level guest count old (childcount_per_room). To see this and the rate rewrite information, you must enable the feature: Get extra information for reservations (res_extra_info).
> Occupancy Contains the maximum occupancy for each room reservation. If the room has rate level restrictions, then this is the maximum occupancy for that rate. integer To see this element, make sure to enable the feature: Include room-level occupancy (include_room_level_occupancy).
> GuestCounts Contains the room-level guest count for the reservation. object
>> GuestCount Contains the guest count for the reservation. object
Count Specifies the number of guests for this reservation as entered by the booker. integer
AgeQualifyingCode Specifies a code that represents the guest's age. Each code represents an age range. integer To see this and the age attribute, you must enable the feature: Include room-level guest count (guestcount_per_room).
The supported codes are:
10 - Adult.
8 - Child.
Age Specifies the age of the child guests. integer Only available when the AgeQualifyingCode = 8.
> CancelPenalties Contains the cancellation policy assigned to the roomrate. object To see this and its child elements, make sure to enable the feature: Add cancellation policy (res_cancel_policies).
> Total Contains the total price for this room for all nights combined. Calculated as the sum of all prices known at the moment of reservation. object Note that there may be some excluded charges from this price. For more details, enable the Include price details (include_price_details) feature.
AmountAfterTax/AmountBeforeTax Specifies the total price including all the taxes. integer If the property has both Including VAT and Including taxes enabled, AmountAfterTax is returned, otherwise AmountBeforeTax.
CurrencyCode Specifies the currency used for pricing. enumerated string This is always the same for a property and is set by Booking.com
DecimalPlaces Specifies the number of decimal places to represent the minor unit of a particular currency. integer For example, Amount=13350 with DecimalPlaces="2" represents 133.50.
>> Taxes Contains the tax information. object To see this and its child elements, make sure to enable the feature: Include price details (include_price_details).
> BasicPropertyInfo Contains the property information where the room is booked. object
HotelCode Specifies the property ID as used by Booking.com. integer
> ResGuestRPHs Contains an index number that works as a cross-reference to link guests (ResGuest) to rooms (RoomStay). object
>> ResGuestRPH object
RPH Specifies an index number that works as a cross-reference to link guests (ResGuest) to rooms (RoomStay). integer
> SpecialRequests Contains any special requests selected by the guest. object To view this and the child elements, make sure to enable the feature: Get extra information for reservations (res_extra_info).
>> SpecialRequest Contains individual special requests object
Name Specifies the service code. enumerated string For a full list of all available service names, see Service names/codes.
>>> Text Specifies the service description enumerated string For a full list of all the available service descriptions, see Service names.

Guest details

The following table lists all the elements that capture guest details.

Element Attribute Description Type Notes
ResGuests Contains the details of all the guests for the reservation. object
> ResGuest Contains individual guest details per room booked in the reservation. object
ResGuestRPH Specifies a reference to the RPH attribute under RoomStay > ResGuestRPH. integer Use this value to identify the room type details that this guest is assigned to.
>> Profiles Contains a collection of guest details. object
>>> ProfileInfo Contains a collection of individual guest details. object
>>>> Profile Contains individual guest details. object Useful when there is more than one room booked to list guest details for each room.
>>>>> Customer Contains the guest details. object
>>>>>> PersonName Contains the first name and surname of the guest. object This can be different from the booker name.
>>>>>>> GivenName Specifies the first name of the booker as filled by the booker. string Only visible when the feature: Split Surname and GivenName (ota_res_split_names) is enabled. The API splits the name into a given name and surname. Otherwise, this field is omitted.
>>>>>>> Surname Contains the guest name for this room as filled in on the website. string If the feature: Split Surname and GivenName (ota_res_split_names) is enabled, then this element contains only the surname of the guest. Otherwise, it specifies both the given name and surname.
TPA_Extensions Contains additional reservation details about the guest. object To view this and its child elements, make sure to enable the feature: Get extra information for reservations (res_extra_info).

Booker details

The following table lists all the elements that capture details of the person who booked the stay.

Element Attribute Description Type Notes
ResGlobalInfo Contains more details on the reservation. object This includes comments, reservation ID, and details of the individual who made the reservation.
> Comments Contains all the comments about the reservation provided at the time of booking. object If the property has signed up to accept reservations paid through BookingPay and when there is such a reservation, then the Text contains more details on the payment. To view this new value in Text, make sure to enable the feature: Pay with BookingPay (pay_with_bookingpay).
> Guarantee Contains the card details as a guarantee for the reservation. object
>> GuaranteesAccepted object
>>> GuaranteeAccepted object
>>>> PaymentCard object
CardCode Specifies the 2-character code of the credit card issuer. enumerated string The API returns "XX" if no code for the credit card is defined. Only returns from one of the values in the Card code table.
CardNumber Specifies the credit card number as supplied by the guest. string If all values are 0s, something went wrong when retrieving the number. You can try retrieving the reservation again.
SeriesCode Specifies the credit card CVC code as supplied by the guest. string If all values are 0s, something went wrong when retrieving the CVC-code. You can try retrieving the reservation again.
ExpireDate Specifies the credit card expiration date as supplied by the guest. datetime If all values are 0s, something went wrong when retrieving the expiration date. You can try retrieving the reservation again.
EffectiveDate Specifies the date that the card can be charged from. datetime This attribute exists only for virtual credit cards. To see this attribute in the response, you must enable the feature: Reservation virtual credit card activation (res_virtual_credit_card_activation_date) using the Provider portal.
CurrentBalance Specifies the current balance that is chargeable on the virtual credit card. integer This attribute exists only for virtual credit cards. To see this attribute in the response, you must enable the feature: Include VCC current balance (res_virtual_credit_card_current_balance) using the Provider portal.
DecimalPlaces Specifies the position of the decimal point (from right to left) in the current balance value. integer For example, Amount=10599 with DecimalPlaces="2" represents 105.99. To include this attribute to the PaymentCard element, you need to enable the feature: Include VCC current balance (res_virtual_credit_card_current_balance) using the Provider portal.
CurrencyCode Specifies the currency code (ISO 4217) of the virtual credit card's current balance. string To see this attribute in the response, you must enable the feature: Include VCC current balance (res_virtual_credit_card_current_balance) using the Provider portal.
VCCExpirationDate Specifies the expiration date of the virtual credit card. string This attribute exist only for virtual credit cards. To see this attribute in the response, you must enable the feature: Include VCC current balance (res_virtual_credit_card_current_balance) using the Provider portal.
>>>>>>>> CardHolderName Specifies the credit card holder's name as supplied by the guest. object If you receive "-" as the value, then something went wrong when retrieving the holder's name. You can try retrieving the reservation again.
> Total Specifies the total amount of room sales of this reservation. object Computed as (all rooms * all nights combined). Note that there may be some excluded charges from this price. For more details, enable the feature: Include price details (include_price_details) using the Provider portal.
AmountAfterTax/AmountBeforeTax Specifies the total price including taxes. integer If the property has VAT set as included in the price, then the API returns AmountAfterTax, otherwise it returns AmountBeforeTax.
CurrencyCode Specifies the currency used for pricing. enumerated string This is always the same for a property and is set by Booking.com.
DecimalPlaces Specifies the number of decimal places to represent the minor unit of a particular currency. integer For example, Amount=13350 with DecimalPlaces="2" represents 133.50.
> HotelReservationIDs Contains the reservations details. object To view the ResID_Source and ResID_Type child elements, enable the feature: OTA hotel reservation response token (ota_res_response_token).
> HotelReservationID Contains individual reservations message ID. object
ResID_Value Specifies the Booking.com reservation ID. string
ResID_Date Specifies the reservation creation date and time value. datetime
> Profiles Contains booker details. object
>> ProfileInfo object
>>> Profile object
>>>> Customer Contains details about the booker. object
Language Specifies the customer's preferred language of communication with the property. string To view this information, make sure to enable the feature: Include Preferred language in Customer (res_customer_preferred_lang).
Note: To enable/disable this feature, contact the Booking.com Connectivity Support team.
>>>>> PersonName Contains the booker's personal details such as name, phone number and address. object
>>>>>> GivenName Specifies the first name of the booker as filled by the booker on the website. object Note that this doesn't have to be the same as the guest name(s).
>>>>>> Surname Specifies the last name of the booker as filled by the booker on the website. object Note that this doesn't have to be the same as the guest name(s).
>>>>> Telephone Contains the telephone number details. object
PhoneNumber Specifies the telephone number as supplied by the booker. string
>>>>> Email Specifies the email address supplied by the booker. object Used by Booking.com to send the reservation confirmation.
>>>>> Address Contains the home address details. object
>>>>>> AddressLine Specifies the home address supplied by the booker. object
>>>>>> CityName Specifies the city of residence as supplied by the booker. object
>>>>>> PostalCode Specifies the zip / post code as supplied by the booker. object
>>>>>> CountryName Specifies the country code of residence as supplied by the booker. object
Code Specifies the country code of residence as supplied by the booker. string
>>>>>> CompanyName Specifies the company name as supplied by the booker. object
> TotalCommissions Contains commission details for all rooms in a reservation. object To view this and its child elements, make sure to enable the feature: Include total commission (include_total_commission).
> DepositPayments object To view this and its child elements, make sure to enable the feature: Get extra information for reservations (res_extra_info).
RUID Specifies the unique request ID which is an encoded string. object You can share this ID with the Booking.com Connectivity Support team when you run into an issue. This can help in understanding what went wrong.

Include room-level guest counts (old)

When you enable the feature: Include room-level guest count old (childcount_per_room), the API returns the number of adults and children per room in the reservation along with age information.

Element Attribute Description Type Notes
RoomStays Contains the room reservation details. object
> RoomStay Contains the room reservation details for each booked room. object
>> TPA_Extensions Contains additional reservation details for each booked room. object
>>> GuestCounts Contains the number of adults and children per each room in the reservation. object
>>>> GuestCount Contains the number of adults and children per room in the reservation. object
AgeQualifyingCode Specifies a code that represents the guest's age. Each code represents an age range. integer The supported codes are:
10 - Adult.
8 - Child.
Count Specifies the guest count. integer
Age Specifies the age of the child guests. integer Only available when the AgeQualifyingCode = 8.

Include room-level guest count

When you enable the feature: Include room-level guest count (guestcount_per_room), the API returns the number of adults and children per room in the reservation along with age information.

Element Attribute Description Type Notes
RoomStays Contains the room reservation details. object
> RoomStay Contains the room reservation details for each booked room. object
>> GuestCounts Contains the number of adults and children per each room in the reservation. object
>>> GuestCount Contains the number of adults and children per room in the reservation. object
AgeQualifyingCode Specifies a code that represents the guest's age. Each code represents an age range. integer The supported codes are:
10 - Adult.
8 - Child.
Count Specifies the guest count. integer
Age Specifies the age of the child guests. integer Only available when the AgeQualifyingCode = 8.

Include room-level occupancy

When you enable the feature: Include room-level occupancy (include_room_level_occupancy), the API returns the maximum occupancy for each room reservation. If the room has rate-level restrictions, then this is the maximum occupancy for that rate. In case of no rate-level restrictions, then this is the maximum occupancy of the room. It can be used to get the maximum occupancy of the room for a price.

Element Attribute Description Type Notes
RoomStays Contains the room reservation details. object
> RoomStay Contains the room reservation details for each booked room. object
>> Occupancy Contains the maximum occupancy for each room reservation. If the room has rate level restrictions, then this is the maximum occupancy for that rate. integer

Add cancellation policy

When you enable the feature: Add cancellation policy details (res_cancel_policy_details), you can view the cancellation policy details assigned to the roomrate. The API also shows the grace period information for rooms with non-refundable roomrates.

Element Attribute Description Type Notes
RoomStays Contains the room reservation details. object
> RoomStay Contains the room reservation details for each booked room. object
>> CancelPenalties Contains the cancellation penalty details. object
>>> CancelPenalty Contains the Booking.com cancellation policy code and its effective date. object
PolicyCode Specifies the Booking.com cancellation policy code. integer
From Specifies the start date and time from which the policy is in effect. datetime
Until Specifies the date and time until which the policy is in effect. datetime
>>>> AmountPercent Contains the penalty amount. object
Amount Specifies the cancellation fee (if applicable) expressed as a fixed amount, if the guests cancels the booking. integer
DecimalPlaces Specifies the number of decimal places to represent the minor unit of a particular currency. integer
CurrencyCode Specifies the currency used for pricing the penalty. enumerated string This is always the same for a property and is set by Booking.com.

Include virtual credit card information

When you enable the feature: Payments Clarity Package (vcc_payment_v2), you can view the following information in the response:

  • Price details: Contains information on specified taxes and charges.
  • Current balance: Specifies the current balance on the VCC.
  • Card expiration date: Specifies the date the VCC expires in YYYY-MM-DD format. This is Booking.com standard. ExpiryDate follows the physical credit card standard. Both refer to the same expiration date, but one is more specific.
  • Card activation date: Specifies the date the VCC was activated in YYYY-MM-DD format.
Element Attribute Description Type Notes
RoomStays Contains the room reservation details. object
> RoomStay Contains the room reservation details for each booked room. object
>> Total object
AmountAfterTax Specifies the amount after tax. integer
CurrencyCode Specifies the currency used for pricing the commission. enumerated string This is always the same for a property and is set by Booking.com.
DecimalPlaces Specifies the number of decimal places to represent the minor unit of a particular currency. integer
>>> Taxes Contains tax details. object
Amount Specifies the tax amount. integer
CurrencyCode Specifies the currency used for pricing the commission. enumerated string This is always the same for a property and is set by Booking.com.
DecimalPlaces Specifies the number of decimal places to represent the minor unit of a particular currency. integer
>>>> Tax Contains tax details. object
Amount Specifies the tax amount. integer
ChargeFrequency Specifies the charge frequency. enumerated integer For a list of charge frequency code, see charge type codes.
Code Specifies the tax code. integer For a list of fee tax type codes, see Tax type codes.
CurrencyCode Specifies the currency used for pricing the commission. enumerated string This is always the same for a property and is set by Booking.com.
DecimalPlaces Specifies the number of decimal places to represent the minor unit of a particular currency. integer
Type Specifies whether this extra charge is included in the total rate. enumerated string Possible values are:
- Inclusive: The extra charge is included in the total amount.
- Exclusive: The extra charge is excluded from the total amount.
>>>> TaxDescription Contains the tax description. object
>>>>> Text Specifies the tax description. string

Include price details

When you enable the feature: Include price details (include_price_details), the response includes VAT and city taxes. Properties can configure the setup of taxes and charges in the Booking.com Extranet. They can specify how VAT and city tax are calculated and can set up to 5 extra charges.

Element Attribute Description Type Notes
RoomStays Contains the room reservation details. object
> RoomStay Contains the room reservation details for each booked room. object
>> Total Contains the room price details. object
AmountAfterTax Specifies the amount after tax. integer
CurrencyCode Specifies the currency used for pricing the commission. enumerated string This is always the same for a property and is set by Booking.com.
DecimalPlaces Specifies the number of decimal places to represent the minor unit of a particular currency. integer
>>> Taxes Contains tax details. object
Amount Specifies the tax amount. integer
CurrencyCode Specifies the currency used for pricing the commission. enumerated string This is always the same for a property and is set by Booking.com.
DecimalPlaces Specifies the number of decimal places to represent the minor unit of a particular currency. integer
>>>> Tax Contains tax details. object
Amount Specifies the tax amount. integer
ChargeFrequency Specifies the charge frequency. enumerated integer For a list of charge frequency code, see charge type codes.
Code Specifies the tax code. integer For a list of fee tax type codes, see Tax type codes.
CurrencyCode Specifies the currency used for pricing the commission. enumerated string This is always the same for a property and is set by Booking.com.
DecimalPlaces Specifies the number of decimal places to represent the minor unit of a particular currency. integer
Type Specifies whether this extra charge is included in the total rate. enumerated string Possible values are:
- Inclusive: The extra charge is included in the total amount.
- Exclusive: The extra charge is excluded from the total amount.
>>>>> TaxDescription Contains the tax description. object
>>>>>> Text Specifies the tax description. string

Get extra information: Rate rewrite

When you enable the feature: Get extra information for reservations (res_extra_info), the API adds the following information to the reservation messages.

Element Attribute Description Type Notes
RoomStays Contains the room reservation details. object
> RoomStay Contains the room reservation details for each booked room. object
>> TPA_Extensions Contains additional reservation details for each booked room. object
>>> RateRewrite Contains the parent rate plan information when there is a rate rewrite. object
FromCode Specifies the rate ID of the booked rate of the room when the booked rate is rewritten from a parent rate. integer
FromName Specifies the name of the booked rate of the room when the booked rate is rewritten from a parent rate. string
ToCode Specifies the parent rate plan ID. integer
>>>> BookingCondition Contains more information on the property's policy. object
>>>>> RateGenius Contains whether the roomrate applied to the booking is a specially discounted genius rate. object
Value Specifies whether the roomrate applied to the booking is a specially discounted genius rate. boolean A reservation with the value set to false can show a genius discounted price, only if a genius discount has been added at the room level. For more information on how to set room-level genius rate discounts, see the Opportunities tab in the Extranet.
RateIds Specifies the rate category ID as known at the moment of reservation. integer If the room is booked with a rate that is rewritten from a parent rate, the API specifies the rate category ID of the parent rate.

Get extra information: Services details

In addition to the rate rewrite information, when you enable the feature: Get extra information for reservations (res_extra_info), the API adds service details.

Element Attribute Description Type Notes
> Services Contains information about the services. object
>> Service Contains information about individual services and freebies for guests who are Genius members. object
ServiceRPH Specifies the index that links guests (ResGuest') to rooms (RoomStay`). object
ServiceInventoryCode Specifies the unique ID of the add-on. enumerated string Only returns an ID from the list of IDs in the ServiceInventoryCode table.
ServicePricingType Specifies the pricing type code. enumerated string Only returns an ID from the list of IDs in the ServicePricingType table.
ID Specifies the ID that represents the freebies for guests who are Genius members. enumerated string
Inclusive Specifies whether the extra charge is included in the total amount. boolean
>>> ServiceDetails Contains the service details. enumerated string The service details can include one of the following values based on the pricing type code:
- GuestCount (number of guests).
- Timespan (number of nights).
- Fees (price to be paid for the add-ons).
>>>> SpecialRequests Contains any special requests selected by the guest. object
>>>>> SpecialRequest Contains individual special requests object
Name Specifies the service code. enumerated string For a full list of all available service names, see Service names/codes
>>>>>> Text Specifies the service description enumerated string For a full list of all the available service descriptions, see Service names.
>>>> GuestCounts Contains the guest count information. object
>>>>> GuestCount object
Count Specifies the guest count. integer
>>>>> TimeSpan Contains the number of stay nights. object
Duration Specifies the number of stay nights. integer
>>>>> Fees Contains the price that the guest has to pay for the add-ons. object
>>>>>> Fee Contains the price that the guest has to pay for the individual add-on. object
Amount Specifies the price to be paid for the add-on. integer

Get extra information: Guest details

In addition to the rate rewrite and service details information, when you enable the feature: Get extra information for reservations (res_extra_info), the API:

  • Specifies whether the booker is travelling on business, including company name & tax.
  • Highlights whether the guest is a member of Booking.com's loyalty program, Genius and if they qualify for any available freebies, such as a welcome drink or a late check-out.
Element Attribute Description Type Notes
RoomStays Contains the room reservation details. object
> RoomStay Contains the room reservation details for each booked room. object
>>TPA_Extensions Contains additional reservation details for each booked room. object
>>> reservation_extra_info object
booker object
>>>>> affiliations Contains the details of any affiliations that the person who made the booking might have. object
>>>>>> affiliation Contains the company name and VAT number provided by the booker. object
name Specifies the company name object
number Specifies the VAT number for the company which the booker is affiliated to. object
numbertype Specifies the type. For example, vat. object
type Specifies the affiliation type. For example, company. enumerated string
>>>> flags Contains additional details about the booking. object
>>>>> flag object
name enumerated string Can contain one of the following values:
- booker_is_genius: Indicates Whether the Booker is a member of Booking.com's loyalty program called Genius.
- no_cc_reservation: Indicates that the reservation doesn't need a credit card guarantee.
- no_address_reservation: Indicates that the reservation doesn't need to enter their address for the reservation.
- risk_free_replacement_booking: Indicates that Booking.com will provide an alternate reservation to the host if the guest cancels the reservation
- risk_free_reservation: Indicates that Booking.com will pay the cancellation charge if guests cancel the reservation.

Get extra information: Include deposit payments

In addition to the rate rewrite and all the above mentioned details, when you enable the feature: Get extra information for reservations (res_extra_info), the API also specifies any prepayment details, if applicable for the reservation.

Element Attribute Description Type Notes
ResGlobalInfo Contains additional details on special requests. object
> DepositPayments Contains information about the payment of the reservation. Booking.com can now take payments from the guest on behalf of the property. Specifies the payout type such as bank transfer or virtual credit card. object
>> GuaranteePayment If the reservation doesn't require a prepayment, the payment section is omitted. (only the tag is returned) object
GuaranteeType Specifies the guarantee payment type. string Currently supports the value PrePay.
>>> Description Contains payout type information. object
>>>> Text Specifies the payment and payment options such as bank transfer or virtual credit card. object
>>>> AmountPercent Contains the prepayment amount. object
Amount Specifies the prepayment amount. integer
DecimalPlaces Specifies the number of decimal places to represent the minor unit of a particular currency. integer
Currency Specifies the currency used for the prepayment amount. enumerated string This is always the same for a property and is set by Booking.com.

Reservations paid through BookingPay

When you enable the feature: Pay with BookingPay(pay_with_bookingpay), the API adds a new payment type to reservations that were paid through BookingPay using the Reservations API endpoints. When you enable this features, the API adds new values to the following existing elements in the response:

  • ResGlobalInfo.Comments.Comment.Text
  • DepositPayments.GuaranteePayment.GuaranteeType
  • DepositPayments.GuaranteePayment.AmountPercent.Description.Text
Element Attribute Description Type Notes
ResGlobalInfo object
> Comments Contains all the comments about the reservation provided at the time of booking. object
>> Comment Contains individual comments about the reservation. object
>>> Text Specifies the actual comment. string

Include reservation response token

When you enable the feature: OTA hotel reservation response token (ota_res_response_token), the API response includes a new HotelReservationID tag for every reservation that includes a token in OTA responses. The token identifies the message the provider is replying to, so that the Booking.com system can then acknowledge that a message has been received by the provider.

Element Attribute Description Type Notes
ResGlobalInfo Contains more details on special requests. object
> HotelReservationIDs Contains the reservations details. object
> HotelReservationID Contains individual reservation message details. object When the OTA hotel reservation response token feature is enabled, the API returns an additional HotelReservationID element with an alphanumeric value in the ResID_Value, if the API detects changes to the reservation details since the last retrieval.
ResID_Source Only available when the OTA hotel reservation response token feature is enabled. Specifies the reservation source. string To create a custom ResID_Source value, you must enable the connection setting "Include ResID_Source information in HotelReservationID". For more information on how to enable this setting, contact the Booking.com Connectivity Support team.
ResID_Type Only available when the OTA hotel reservation response token feature is enabled. Specifies the Booking.com reservation type. integer Can contain the following values:
- 14: new reservation
- 18: reservation was modified since the last retrieval.
ResID_Value Specifies the Booking.com reservation ID. string Can contain 2 entries if the API detects that a reservation was changed before the provider could acknowledge the booking. While acknowledging a changed reservation, you must provide both the ResID_Values.
ResID_Date Specifies the reservation creation date and time value. datetime

Include reservation-level guest count

When you enable the feature: Include reservation-level guest count (childcount), the API returns the number of adults and children (with their ages) that the booker searched for when making the booking. This information is added to the reservation message.

Disable Include room-level guest count

Before enabling this feature, make sure to disable the feature: Include room-level guest count (guestcount_per_room). If both the features are enabled, the API shows only the room-level guest count.

Element Attribute Description Type Notes
ResGlobalInfo Contains additional details on special requests. object
> GuestCounts Contains the number of adults and children (with their ages) per room reservation. object
>> GuestCount Contains the number of adults and ages of individual children included while searching for a reservation. integer
AgeQualifyingCode Specifies a code that represents the guest's age. Each code represents an age range. integer The supported codes are:
10 - Adult
8 - Child
Count Specifies the guest count. integer
Age Specifies the age of the child guests. integer

Include reservation-level commission

When you enable the feature: Include total commission (include_total_commission), the API returns the total commission amount for all rooms for all nights of a reservation.

By default, the API displays the commission amount per room stay under the RoomStay element. A single reservation can include multiple room stays. But by enabling this feature, you can get the total commission amount for all rooms for all nights of the reservation.

You can use this value to check the commission amount calculated, as some non-refundable reservations may be eligible for commission even if the reservation was modified or cancelled.

Element Attribute Description Type Notes
ResGlobalInfo Contains additional details on special requests. object
> TotalCommissions Contains commission details for all rooms in a reservation. object
>> CommissionPayableAmount Specifies the total commission for all rooms in a reservation. object
Amount Specifies the total commission amount. integer
DecimalPlaces Specifies the position of the decimal point (from right to left) in the total commission amount. integer
CurrencyCode Specifies the currency used for pricing the commission. enumerated string This is always the same for a property and is set by Booking.com.
>> Comment Specifies a comment. object

Include payment charges

When you enable the feature: ReservationsAPI Payment Charges (res_payment_charges), the API includes the following details for reservations that are paid through the PayByBooking payment method.

Element Attribute Description Type Notes
ResGlobalInfo Contains additional details on special requests. object
> Total object
AmountAfterTax Specifies the total including taxes. integer
DecimalPlaces Specifies the number of decimal places to represent the minor unit of a particular currency. integer
CurrencyCode Specifies the currency used for pricing the commission. enumerated string This is always the same for a property and is set by Booking.com.
>> TPA_Extensions Contains additional reservation details for each booked room. object
>>> TPA_Extension Contains additional reservation details for each booked room. object
>>>> PaymentCharge Contains the payment charge details. object
Amount integer
CurrencyCode Specifies the currency used for pricing the charge. enumerated string This is always the same for a property and is set by Booking.com.
DecimalPlaces Specifies the number of decimal places to represent the minor unit of a particular currency. integer

Include Timestamp of last update

Element Attribute Description Type Notes
OTA_HotelResModifyNotifRQ Contains the response data. object
>HotelResModifies Contains the modified/cancelled property reservations for each specified property. object
>>HotelResModify Contains individual property reservation details that were modified/cancelled. object
>>>LastModifyDateTime object

Service names

The following table lists all the services code names and their associated descriptions. Based on the code in the response, you can identify the available services supported by the property for a specific reservation.

Code Name Description
GF_1 Early check in
GF_2 Free airport shuttle
GF_3 Free drink upon arrival
Gf_4 Free bike rental
GF_5 Give Genius guests 2 extra hours to check out
GF_6 Free breakfast
GF_7 Free parking on availability
GF_8 Free Wifi

Service type ID

The following table lists all the services and their associated IDs. Based on the ID(s) in the response, you can identify the services or add-ons supported by the property for a reservation.

Service Type ID Service Name
1 Late Check-out
2 Early Check-in
3 Late Check-in
4 Champagne
5 Wine
6 Flowers
7 Attraction
8 Airport Shuttle
9 Parking
10 Massage
11 Facial
12 Body
13 Christmas
14 New Year
15 Celebration Package
16 Ski Pass

Available price modes

The following table lists all the price modes and their corresponding IDs. Based on the ID in the response, you can identify the price mode that was used to calculate the room price for a reservation.

ID Price mode
0 Not applicable
1 Per stay
2 Per person per stay
3 Per night
4 Per person per night
5 Percentage
6 Per person per night restricted

Addon types

The following table lists all the addons and their respective IDs.

ID Name
1 Breakfast
2 Continental breakfast
3 American breakfast
4 Buffet breakfast
5 Full english breakfast
6 Lunch
7 Dinner
8 Half board
9 Full board
11 Breakfast for Children
12 Continental breakfast for Children
13 American breakfast for Children
14 Buffet breakfast for Children
15 Full english breakfast for Children
16 Lunch for Children
17 Dinner for Children
18 Half board for Children
19 Full board for Children
20 WiFi
21 Internet
22 Parking space
23 Extrabed
24 Babycot
Quick Actions

→ To know more about how to acknowledge modified or cancelled reservation messages, see Acknowledging modified/cancelled reservations.
→ For troubleshooting information, see Troubleshooting and list of error codes.