Outdated version

This documentation is outdated and is soon going to be deprecated. For the latest in Reservations API documentation, see the Retrieving reservations using B.XML section.

The following section is outdated and Booking.com does not actively verify its accuracy. Use at your own discretion.

reservations (B.XML)

The reservations call is used to retrieve the following messages:

  • New reservation messages
  • Modified (or upgraded) reservation messages
  • Cancelled reservation messages

Step 1: Request for reservation information

POST https://secure-supply-xml.booking.com/hotels/xml/reservations

Request — HTTP Message Body Model

<?xml version="1.0" encoding="UTF-8"?>
<request>
  <username>providermachinelogin</username>
  <password>********</password>
</request>

Request — Node Overview

Node Name Nest Level Parent Node Value Range Data Type Node Multiplicity
hotel_id L1 request @5-7 digits integer 0..1
id L1 request -- integer 0..1
last_change L1 request [see below] string 0..1
limit L1 request [see below] integer 0..1
password L1 request -- string 1
request L0 NULL(root) -- -- 1
username L1 request -- string 1
  • The request body consists of a request root node. This is the parent node to the required username and password nodes, and the optional hotel_id, id node, and/or last_change nodes.

  • The child node username should contain the provider's Booking.com XML machine login.

  • The child node password should contain the provider's Booking.com XML machine password.

  • The optional child node hotel_id contains the Booking.com hotel ID for which the provider wishes to check for reservation information. When the hotel_id is omitted, a complete list of reservations will be given for the fiven parameters.

  • The optional child node id contains the Booking.com reservation ID for which the provider wishes to pull. It is required that a provider using this method also mix in pulls without a specified reservation id to verify all pending reservation messages are retrieved.

  • The optional child node last_change contains the time from which the provider would like to query any changes in an ISO 8601 format of YYYY-MM-DD HH:MM:SS. The timezone is CET in winter, and CEST in summer. The last change function will not contain any reservation messages that have never been queued for XML before. Connectivity Partners should only request reservations up until 2 weeks in the past. The last_change element will also result in reservations that have been picked up via XML before. last_change will return reservations starting from the oldest reservation. The exact number varies depending on our system, but please expect several hundred. This can be reduced by specifying limit.

  • The limit parameter specifies the maximum number of reservations to return in a response. You must use an integer larger than 10. However, note that each response can return less reservations than the specified maximum number regardless of the number of reservations available.

Step 2: Response of reservation information

Type HTTP Method Message Sender Message Receiver
Response POST Booking.com IT Provider

The below represent some different response models for reservations. Please note that multiple reservation child elements of different status element types can be mixed in a single reservations response element.

Virtual credit card (VCC) details are included in all retrievals

In case you retrieve a reservation multiple times, VCC details are included in all retrievals. However, ordinary credit card (CC) details are only included once (B.XML) or until the details are acknowledged (OTA).

Response Model — No pending new, modified, cancelled reservations

In this case no messages are pending in queue for the provider based on the parameters provided in Step 1.

<reservations>
</reservations>
<!-- RUID: [XXXXXXXXXXXXXXXXXXXXXXXXXXX==] -->

Response Model — New reservation confirmation

<?xml version="1.0" encoding="UTF-8"?>
<reservations>
<reservation>
  <booked_at>2016-06-01T11:57:22+00:00</booked_at>
  <commissionamount>21.09</commissionamount>
  <currencycode>EUR</currencycode>
  <customer>
    <address>Vista 2, 3º izq</address>
    <cc_cvc />
    <cc_expiration_date />
    <cc_name />
    <cc_number />
    <cc_type />
    <city>Madrid</city>
    <company />
    <countrycode>es</countrycode>
    <dc_issue_number />
    <dc_start_date />
    <email>guest01@guest.booking.com</email>
    <first_name>Juan</first_name>
    <last_name>Valdez</last_name>
    <remarks>Booker is travelling for business and may be using a corporate credit card.
This customer requires the receipt of the stay.
Approximate time of arrival: between 11:00 and 12:00 hours
You have a bookkeeper who would prefer a quiet room. (Based on availability)




  --- You received a virtual Booking.com credit card for 21.37. You can charge up to 2 days after check-out date. ---
*** Genius booker ***

***
Offer Genius customers 2 hours more to check out
Priority check-in priorities
Welcome drink
Free bicycle rental
Free breakfast: Genius guests will enjoy complimentary breakfast at the property.
Free WiFi: Genius guests will enjoy free WiFi at the property.
***

booked rate: Non Refundable Rate - 23% (Early booker - Secret) (6535032)
Genius Rate: Non Refundable Rate - 23% (Early booker - Secret) (6535032)</remarks>
    <telephone>666 428 664</telephone>
    <zip>28004</zip>
  </customer>
  <date>2015-01-01</date>
  <hotel_id>111111</hotel_id>
  <hotel_name>Hotel </hotel_name>
  <id>757808939</id>
  <modified_at>2016-06-09T08:35:06+00:00</modified_at>
  <reservation_extra_info>
    <booker>
      <affiliations>
        <affiliation name="Editorial Páginas de Espuma SL" number="ES B82448655" numbertype="vat" type="company" />
      </affiliations>
    </booker>
    <flags>
      <flag name="booker_is_genius" />
    </flags>
    <guests>
      <services>
        <service name="GF_8">
          <text>Free WiFi – Genius guests will get free WiFi at the property.</text>
        </service>
        <service name="GF_6">
          <text>Free breakfast – Genius guests will get free breakfast at the property.</text>
        </service>
        <service name="GF_4">
          <text>Free bike rental</text>
        </service>
        <service name="GF_5">
          <text>Give Genius guests 2 extra hours to check out</text>
        </service>
      </services>
    </guests>
    <payer>
      <payments>
        <payment amount="92.37" currency="EUR" payment_type="payment_via_Booking.com" payout_type="Virtual credit card" />
      </payments>
    </payer>
  </reservation_extra_info>
  <room>
    <arrival_date>2015-02-01</arrival_date>
    <commissionamount>23.0925</commissionamount>
    <currencycode>EUR</currencycode>
    <departure_date>2015-02-02</departure_date>
    <extra_info> Classic-style with large windows and tiled floors, this room includes free Wi-Fi, a TV, a kettle and a minibar. <extra_info>
    <facilities> Tea Coffee Maker, Minibar, Shower, Safety Deposit Box, Telephone, Air Conditioning, Hairdryer, Wake Up Service / Alarm Clock, Iron, Bathrobe, Desk, Free toiletries, Toilet, Satellite Channels, Carpeted Floor, Laptop Safe Box, Flat-screen TV, Sofa, Tiled / Marble floor, Electric Kettle </facilities>
    <guest_name> Conchita Valdez </guest_name>
    <id>1404303</id>
    <Info> Breakfast is included in the room rate. Children and Extra Bed Policy: Children are welcome. All children under 2 years are charged EUR 25 per night for cots. All children under 16 years are charged EUR 45 per night for extra beds. All further older children or adults are charged EUR 45 per night for extra beds. Maximum capacity of extra beds in a room is 2. Deposit Policy: The total price of the reservation will be charged at the time of booking. Cancellation Policy: Please note, if canceled or modified, the total price of the reservation will be charged. <info>
    <max_children>0</max_children>
    <meal_plan> Breakfast is included in the room rate.</meal_plan>
    <name>Camera Tripla</name>
    <numberofguests>3</numberofguests>
    <price date="2016-02-06" genius_rate="no" rate_id="130435" rewritten_from_id="6535032" rewritten_from_name="Non Refundable Rate - 23% (Early booker - Secret)">92.37</price>
    <price_details>
      <guest>
        <extracomponent amount="8.397273" currency="EUR" included="yes" per_night="no" per_person="no" percentage="10%" text="IVA" />
        <extracomponent amount="13.500000" currency="EUR" included="no" per_night="yes" per_person="yes" percentage="no" text="Tassa di soggiorno" />
        <total>92.37</total>
      </guest>
      <hotel>
        <extracomponent amount="8.397273" currency="EUR" included="yes" per_night="no" per_person="no" percentage="10%" text="IVA" />
        <extracomponent amount="13.500000" currency="EUR" included="no" per_night="yes" per_person="yes" percentage="no" text="Tassa di soggiorno" />
        <total>92.37</total>
      </hotel>
    </price_details>
    <remarks>booked rate: Non Refundable Rate - 23% (Early booker - Secret) (6535032)</remarks>
    <roomreservation_id>841493627</roomreservation_id>
    <smoking>0</smoking>
    <totalprice>92.37</totalprice>
  </room>
  <status>new</status>
  <time>01:34:23</time>
  <totalprice>92.37</totalprice>
  <services_reservations>
      <service_reservation>
          <extranet_url>https://admin.booking.com/hotel/hoteladmin/extranet_ng/manage/booking.html?service_action=details&amp;hotel_id=355138&amp;service_req=8697&amp;res_id=1906125412</extranet_url>
          <guest_answers>
              <question name="What time do you prefer?">20:30</question>
          </guest_answers>
          <payment_policies>
              <payment_policy>Payment policy was not defined</payment_policy>
          </payment_policies>
          <prices>
              <price>
                  <number_of_units>3</number_of_units>
                  <price_per_unit currency_code="EUR"
                      rate_description=""
                      unit="per_person">35</price_per_unit>
                  <total currency_code="EUR">105</total>
              </price>
          </prices>
          <reservation_status>Reserved</reservation_status>
          <reservation_time time="2017-04-09 09:04:51" />
          <service_identification_info auto_approve_enabled="False"
                               id="2183"
                               service_category_code="InStayServices"
                               service_type_id="31"
                               title="Attraction">
              <attribute key="attraction_description">A visit to the Tablao Flamenco Los Gallos to see a typical Andalusian show.</attribute>
              <attribute key="attraction_name">Flamenco show</attribute>
          </service_identification_info>
          <service_reservation_id>8697</service_reservation_id>
      </service_reservation>
  </services_reservations>
 <totalprice>92.37</totalprice>


</reservation>
</reservations>
<!-- RUID: [XXXXXXXXXXXXXXXXXXXXXXXXXXX==] -->

Response model — Modified reservation

<?xml version="1.0" encoding="UTF-8"?>
<reservations>
  <reservation>
    <commissionamount>45</commissionamount>
    <currencycode>EUR</currencycode>
    <customer>
      <address>ADDRESS</address>
      <cc_cvc />
      <cc_expiration_date />
      <cc_name />
      <cc_number />
      <cc_type />
      <city>CITY</city>
      <company />
      <countrycode>nl</countrycode>
      <dc_issue_number />
      <dc_start_date />
      <email />
      <first_name>FIRSTNAMEBOOKER</first_name>
      <last_name>LASTNAMEBOOKER</last_name>
      <remarks>SPECIAL REQUESTS</remarks>
      <telephone>+31 20 715 00 00</telephone>
      <zip>ZIP CODE</zip>
    </customer>
    <date>2012-11-13</date>
    <hotel_id>367456</hotel_id>
    <hotel_name>XML test hotel</hotel_name>
    <id>312651462</id>
    <loyalty_id>123ABC</loyalty_id>
    <room>
      <addons>
        <addon>
          <name>Parking space</name>
          <nights>1</nights>
          <persons>1</persons>
          <price_mode>3</price_mode>
          <price_per_unit>5</price_per_unit>
          <totalprice>5</totalprice>
          <type>22</type>
        </addon>
      </addons>
      <arrival_date>2012-12-13</arrival_date>
      <commissionamount>45</commissionamount>
      <currencycode>EUR</currencycode>
      <departure_date>2012-12-14</departure_date>
      <extra_info />
      <facilities>Wooden / Parquet floor</facilities>
      <guest_name>MODIFIED GUEST NAME</guest_name>
      <id>36745601</id>
      <info>All meals and select beverages are included in the room rate. Children and Extra Bed Policy: All children are welcome. All children under 1 years stay free of charge when using existing beds. All children under 2 years are charged EUR 20 per person per night for children's cots/cribs. There is no capacity for extra beds in the room. The maximum number of children's cots/cribs in a room is 1.  Deposit Policy: No deposit will be charged.  Cancellation Policy: If cancelled  up to 4 days before date of arrival,  no fee will be charged. If cancelled  later or in case of no-show, the total price of the reservation will be charged.</info>
      <max_children>0</max_children>
      <meal_plan>All meals and select beverages are included in the room rate.</meal_plan>
      <name>Standard Double Room - Special conditions</name>
      <numberofguests>1</numberofguests>
      <price date="2012-12-13" rate_id="1278608">370</price>
      <remarks />
      <roomreservation_id>243197707</roomreservation_id>
      <smoking>0</smoking>
      <totalprice>375</totalprice>
    </room>
    <status>modified</status>
    <time>10:44:46</time>
    <totalprice>375</totalprice>
    <services_reservations>
      <service_reservation>
          <extranet_url>https://admin.booking.com/hotel/hoteladmin/extranet_ng/manage/booking.html?service_action=details&amp;hotel_id=355138&amp;service_req=8697&amp;res_id=1906125412</extranet_url>
          <guest_answers>
              <question name="What time do you prefer?">20:30</question>
          </guest_answers>
          <payment_policies>
              <payment_policy>Payment policy was not defined</payment_policy>
          </payment_policies>
          <prices>
              <price>
                  <number_of_units>3</number_of_units>
                  <price_per_unit currency_code="EUR"
                      rate_description=""
                      unit="per_person">35</price_per_unit>
                  <total currency_code="EUR">105</total>
              </price>
          </prices>
          <reservation_status>Reserved</reservation_status>
          <reservation_time time="2017-04-09 09:04:51" />
          <service_identification_info auto_approve_enabled="False"
                               id="2183"
                               service_category_code="InStayServices"
                               service_type_id="31"
                               title="Attraction">
              <attribute key="attraction_description">A visit to the Tablao Flamenco Los Gallos to see a typical Andalusian show.</attribute>
              <attribute key="attraction_name">Flamenco show</attribute>
          </service_identification_info>
          <service_reservation_id>8697</service_reservation_id>
      </service_reservation>
  </services_reservations>

  </reservation>
</reservations>
<!-- RUID: [XXXXXXXXXXXXXXXXXXXXXXXXXXX==] -->

Response - cancelled reservation

<reservations>
<reservation>
<commissionamount></commissionamount>
<currencycode>EUR</currencycode>
<customer>
<address>efthdrtfhdfg</address>
<cc_cvc></cc_cvc>
<cc_expiration_date></cc_expiration_date>
<cc_name></cc_name>
<cc_number></cc_number>
<cc_type></cc_type>
<city>hdfhgdfgh</city>
<company></company>
<countrycode>gb</countrycode>
<dc_issue_number></dc_issue_number>
<dc_start_date></dc_start_date>
<email></email>
<first_name>test</first_name>
<last_name>test</last_name>
<remarks>test</remarks>
<telephone>425634563465</telephone>
<zip>3653546</zip>
</customer>
<date>2013-01-14</date>
<hotel_id>464167</hotel_id>
<hotel_name>Steve's Sunny hotel</hotel_name>
<id>960088068</id>
<status>cancelled</status>
<time>14:30:46</time>
<total_cancellation_fee>323</total_cancellation_fee>
<totalprice>0</totalprice>
</reservation>
</reservations>
<!-- RUID: [UmFuZG9tSVYkc2RlIyh9YScAAH0Bzh23eh4iMYGUj3+OwYOITRSCscllxLuwfvvePWuyVRiPIYiL/EZDUK3akw==] -->

Response - some response errors

response code 410 - hotel reservation is no longer available for delivery response code 403 - Access denied for hotel: when request has one hotel and provider donesn't have access to that hotel - hotel reservation does not belong to any of provider's hotels response code 404 - hotel reservation was not found response code 400 - hotel reservation has transaction message of the wrong type response code 200 - Invalid reservation Id - last_change is more than a month

in case of requesting multiple hotels you will get warning for hotels that you don't have access to

<reservations>
    <!-- (hotel reservatins/modification/cancellations, if any) -->
    <warnings>
        <warning code="403" string="Access denied for hotel 678765678" />
    </warning>
</reservations>

Element name - reservations

Short description The reservations element is the root of every reservations response. Type N/A Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent N/A Children reservation

Syntax

<reservations>
...
</reservations>

Element name - reservation

Short description Every reservation is indicated with a 'reservation' element Type N/A Amount of elements possible within parent Min:0 Max: unbounded Constraints N/A Format N/A Parent reservations Children: commissionamount,currencycode,customer,address,cc_cvc,cc_expiration_date,cc_activation_date,cc_name,cc_number,cc_type,city,company,countrycode,dc_issue_number,dc_start_date,email,first_name,last_name,remarks,telephone,zip,date,hotel_id,hotel_name,id,room,addons,addon,name,nights,persons,price_mode,price_per_unit,totalprice,type,arrival_date,commissionamount,currencycode,departure_date,extra_info,facilities,guest_name,id,info,name,numberofguests,price,remarks,roomreservation_id,smoking,totalprice,status,time,totalprice

Syntax

<reservations>
<reservation>
...
</reservation>
</reservations>

Element name - commissionamount

Short description The total commission a hotel has to pay to Booking.com per complete reservation Type integer Amount of elements possible within parent Min:1 Max:1 ConstraintsN/A Format Parent reservation Children N/A

Syntax

<reservation>
<commissionamount>49.80</commissionamount>
...
</reservation>

Element name - currencycode

Short description In which currency Booking.com will charge the commission to the hotel Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent reservation Children N/A

Syntax

<reservation>
...
<currencycode>EUR</currencycode>
...
</reservation>

Element name - customer

Short description The customer element contains the booker details Type N/A Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent reservation Children address,cc_cvc,cc_expiration_date,cc_activation_date,cc_name,cc_number,cc_type,city,company,countrycode,dc_issue_number,dc_start_date,email,first_name,last_name,remarks,telephone,zip

Syntax

<reservation>
...
<customer>
...
</customer>
...
</reservation>

Element name - address

Short description the address of the booker Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent customer Children N/A

can be empty

Syntax

<customer>
<address>Address</address>
...
</customer>

Element name - cc_cvc

Short description the credit card, verfication code that the booker has entered when making the reservation. Type integer Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent customer Children N/A

can be empty

Syntax

<customer>
...
<cc_cvc></cc_cvc>
...
</customer>

Element name - cc_expiration_date

Short description the expiration date of the credit card Type datetime Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format MM/YYYY Parent customer Children N/A

can be empty

Syntax

<customer>
...
<cc_expiration_date>01/2016</cc_expiration_date>
...
</customer>

Element name - currencycode

Short description: The currency code (ISO 4217) specifies the currency of the virtual credit card's current balance, which is attached to the reservation.

NOTE: To include this attribute to the Payment Card tag, you need to enable the "Include VCC current balance" feature in the Provider Portal.

Type: string Amount of elements possible within parent: Min:0 Max:1 Constraints: N/A Format: N/A Parent: customer Children: N/A

Syntax

<customer>
...
<currencycode>EUR</currencycode>
...
</customer>

Element name - cc_name

Short description the name of the credit card Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent customer Children N/A

can be empty

Syntax

<customer>
...
<cc_name>Card holders name</cc_name>
...
</customer>

Element name - cc_number

Short description the number of the credit card Type integer Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent customer Children N/A

can be empty

Syntax

<customer>
...
<cc_number>5413541354135413</cc_number>
...
</customer>

Element name - cc_type

Short description the type of credit card Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent customer Children N/A

can be empty

Syntax

<customer>
...
<cc_type>MasterCard</cc_type>
...
</customer>

Element name - city

Short description The city where the booker is from Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent customer Children N/A

can be empty

Syntax

<customer>
...
<city>City</city>
...
</customer>

Element name - company

Short description The company where the booker works, or made the reservation for Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent customer Children N/A

can be empty

Syntax

<customer>
...
<company></company>
...
</customer>

Element name - countrycode

Short description the country code of the country where the booker is from Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent customer Children N/A

Syntax

<customer>
...
<countrycode>gb</countrycode>
...
</customer>

Element name - dc_issue_number

Short description Issue number. Used for Maestro (Switch) debit cards. Type integer Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent customer Children N/A

can be empty

Syntax

<customer>
...
<dc_issue_number></dc_issue_number>
...
</customer>

Element name - dc_start_date

Short description Start date. Used for Maestro (Switch) debit cards. Type datetime Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format MM/YYYY Parent customer Children N/A

can be empty

Syntax

<customer>
...
<dc_start_date></dc_start_date>
...
</customer>

Element name - email

Short description Email address supplied by the customer Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent customer Children N/A

can be empty

Syntax

<customer>
...
<email></email>
...
</customer>

Element name - first_name

Short description First name of the booker as supplied by the customer. Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent customer Children N/A

doesn't have to be the same as the guestname(s).

Syntax

<customer>
...
<first_name>First name</first_name>
...
</customer>

Element name - last_name

Short description Last name of the booker as supplied by the customer. Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent customer Children N/A

doesn't have to be the same as the guestname(s).

Syntax

<customer>
...
<last_name>Last name</last_name>
...
</customer>

Element name - remarks

Short description Remarks regarding this reservation, supplied by the customer. Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent customer Children N/A

can be empty

Syntax

<customer>
...
<remarks>Special Requests</remarks>
...
</customer>

Element name - telephone

Short description Telephone number as supplied by the customer. Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent customer Children N/A

can be empty

Syntax

<customer>
...
<telephone>+31207150000</telephone>
...
</customer>

Element name - zip

Short description Zip / Post code as supplied by the customer. Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent customer Children N/A

can be empty

Syntax

<customer>
...
<zip>Zip Code</zip>
...
</customer>

Element name - date

Short description Date on which this reservation is made. Type datetime Amount of elements possible within parent Min:1 Max:unbounded Constraints N/A Format YYYY-MM-DD Parent reservation Children N/A

Syntax

<reservations>
<reservation>
...
<date>2012-09-28</date>
...
</reservation>
</reservations>

Element name - hotel_id

Short description The hotel ID as used by Booking.com Type integer Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent reservation Children N/A

Syntax

<reservations>
<reservation>
...
<hotel_id>367456</hotel_id>
...
</reservation>
</reservations>

Element name - hotel_name

Short description The hotel name as used by Booking.com Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent reservation Children N/A

Syntax

<reservations>
<reservation>
...
<hotel_name>XML test hotel</hotel_name>
...
</reservation>
</reservations>
<reservations>
<reservation>
...
<hotel_name>XML test hotel</hotel_name>
...
</reservation>
</reservations>

Element name - id

Short description The reservation ID as used by Booking.com Type integer Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent reservation Children N/A

Syntax

<reservations>
<reservation>
...
<id>543510983</id>
...
</reservation>
</reservations>

Element name - loyalty_id

Short description The loyalty membership ID of a participating chain as filled in by the guest during the book process Type string Amount of elements possible within parent Min:0 Max:1 Constraints max 9 characters Format N/A Parent reservation Children N/A

Syntax

<reservations>
<reservation>
<commissionamount>62.58</commissionamount>
<currencycode>EUR</currencycode>
<customer>
...
</customer>
<date>2012-11-19</date>
<hotel_id>12345</hotel_id>
<hotel_name>Test Hotel</hotel_name>
<id>123456789</id>
<loyalty_id>123ABC</loyalty_id>
<room>
...
</room>
<status>new</status>
<time>10:39:12</time>
<totalprice>447</totalprice>
</reservation>
</reservations>

Element name - room

Short description One element for every room (sometimes with identical id) will be returned. Type N/A Amount of elements possible within parent Min:0 Max:unbounded Constraints N/A Format N/A Parent reservation Children addons,arrival_date,commissionamount,currencycode,departure_date,extra_info,facilities,guest_name,id,info,name,numberofguests,price,remarks,roomreservation_id,smoking,totalprice

Syntax

<reservation>
...
<room>
...
</room>
...
</reservation>

Element name - addons

Short description Additional services added to the reservation Type N/A Amount of elements possible within parent Min:0 Max:1 Constraints N/A Format N/A Parent room Children addon

Syntax

<room>
<addons>
...
</addons>
...
</room>

Element name - addon

Short description One element for every add-on. Type N/A Amount of elements possible within parent Min:0 Max:unbounded Constraints N/A Format N/A Parent addons Children name,nights,persons,price_mode,price_per_unit,totalprice,Type*

Syntax

<addons>
<addon>
...
</addon>
</addons>

Element name - name

Short description The add-on name, in English. Type string Amount of elements possible within parent Min:0 Max:1 Constraints Format Parent addon Children

Syntax

<addon>
<name>Parking space</name>
...
</addon>

Element name - nights

Short description Number of nights this customer has booked the addon for Type integer Amount of elements possible within parent Min:0 Max:1 Constraints N/A Format N/A Parent addon Children N/A

Syntax

<addon>
...
<nights>1</nights>
...
</addon>

Element name - persons

Short description Number of persons this addon is booked for Type integer Amount of elements possible within parent Min:0 Max:1 Constraints N/A Format N/A Parent addon Children N/A

Syntax

<addon>
...
<persons>4</persons>
...
</addon>

Element name - price_mode

Short description An integer identifying the price mode (per stay, per night, per person per night) Type integer Amount of elements possible within parent Min:0 Max:1 Constraints N/A Format N/A Parent addon Children N/A

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

Syntax

<addon>
...
<price_mode>3</price_mode>
...
</addon>

Element name - price_per_unit

Short description The unitary price for this add-on. Type integer Amount of elements possible within parent Min:0 Max:1 Constraints N/A Format N/A Parent addon Children N/A

Syntax

<addon>
...
<price_per_unit>5</price_per_unit>
...
</addon>

Element name - totalprice

Short description The total calculated price for this add-on, taking into consideration the price mode. Type integer Amount of elements possible within parent Min:0 Max:1 Constraints N/A Format N/A Parent addon Children N/A

Syntax

<addon>
...
<totalprice>5</totalprice>
...
</addon>

Element name - type

Short description The add-on type id. Type integer Amount of elements possible within parent Min:0 Max:1 Constraints N/A Format N/A Parent addon Children N/A

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

Syntax

<addon>
...
<type>22</type>
...
</addon>

Element name - arrival_date

Short description Date of arrival of the guests Type datetime Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format YYYY-MM-DD Parent room Children N/A

Syntax

<room>
<arrival_date>2012-10-28</arrival_date>
...
</room>

Element name - commissionamount

Short description The total commission due for this room for all nights combined. The currency used for pricing is always the same for the hotel and set by Booking.com Type integer Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent room Children N/A

Syntax

<room>
...
<commissionamount>49.8</commissionamount>
...
</room>

Element name - currencycode

Short description The currency code that relates to the prices in this reservation Type string Amount of elements possible within parent Min:1 Max:1 ConstraintsN/A FormatN/A Parent room ChildrenN/A

Syntax

<room>
...
<currencycode>EUR</currencycode>
...
</room>

Element name - departure_date

Short description Date of departure of the guests Type datetime Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format YYYY-MM-DD Parent room Children N/A

Syntax

<room>
...
<departure_date>2012-10-29</departure_date>
...
</room>

Element name - extra_info

Short description Extra room information as currently known for the booked room in the database. Type string Amount of elements possible within parent Min:1 Max:1 Constraints Format N/A Parent room Children N/A

Syntax

<room>
...
<extra_info></extra_info>
...
</room>

Element name - facilities

Short description Room facilities as displayed on the website at the time the reservation was made. Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent room Children N/A

Syntax

<room>
...
<facilities>Wooden / Parquet floor</facilities>
...
</room>

Element name - guest_name

Short description Guest name(s) for this room as filled in on the website. Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent room Children N/A

Syntax

<room>
  ...
  <guest_name>First name Last name</guest_name>
  ...
</room>

Element name - id

Short description The room type ID as used by Booking.com Type integer Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent room Children N/A

Syntax

<room>
  ...
  <id>36745603</id>
  ...
</room>

Element name - info

Short description Room info as displayed on the website at the time the reservation was made. Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent room Children N/A

Syntax

<room>
  ...
<info>All meals and select beverages are included in the room rate. Children and Extra Bed Policy: All children are welcome. All children under 1 years stay free of charge when using existing beds. All children under 2 years are charged EUR 20 per person per night for children's cots/cribs. There is no capacity for extra beds in the room. The maximum number of children's cots/cribs in a room is 1. Deposit Policy: No deposit will be charged. Cancellation Policy: If cancelled up to 4 days before date of arrival, no fee will be charged. If cancelled later or in case of no-show, the total price of the reservation will be charged.</info>
  ...
</room>

Element name - name

Short description Room name as displayed on the website. Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent room Children N/A

Please note that the roomname might differ from the roomname in the roomrates request, depending on the policy and/or rate type. Therefore we suggest to only map based on room ID and rate ID.

Syntax

<room>
  ...
  <name>Suite - Special conditions</name>
  ...
</room>

Element name - max_children

Short description The static setting of maximum amount of children that can stay free in the booked room. Type integer Amount of elements possible within parent Min:0 Max:1 Constraints N/A Format N/A Parent room Children N/A

Note that, this does not mean that if the max_children=2, that the guest has entered 2 children in the bookprocess. This is a static setting, defined per room. The maximum age of the children can be found in the policy of the hotel. The hotelier can request this setting with the Booking.com account managers or check in the Booking.com Extranet.

Syntax

<room>
  ...
  <max_children>0</max_children>
  ...
</room>

Element name - meal_plan

Short description Mealplan (breakfast, lunch or dinner) information that is applicable for the booked room. Type string Amount of elements possible within parent Min:0 Max:1 Constraints N/A Format freetext Parent room Children N/A

Syntax

<room>
  ...
  <meal_plan>All meals and select beverages are included in the room rate.</meal_plan>
  ...
</room>

Element name - numberofguests

Short description Number of adult guests for this room as submitted by the guest on Booking.com If the room rate of the reservation is not Occupancy based pricing then it will be the number of guests that the booker selected Type integer Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent room Children N/A

Syntax

<room>
  ...
  <numberofguests>4</numberofguests>
  ...
</room>

Element name - price

Short description Price and rate category ID per night as known at the moment of reservation. The currency used for pricing is always the same for the hotel and set by BOOKING.COM. Type N/A Amount of elements possible within parent Min:1 Max:unbounded Constraints N/A Format< N/A/br> Parent room Children N/A

Syntax

<room>
  ...
  <numberofguests>4</numberofguests>
  ...
</room>
Attribute Name - date

Attribute description Attribute Type datetime Attribute Constraints Amount of elements possible within parent Min:1 Max:1 Format YYYY-MM-DD

The currency used for pricing is always the same for the hotel and set by Booking.com

Syntax

  <price date="2012-10-28" rate_id="1278608">410</price>
Attribute Name - rate_id

Attribute description Rate category ID per night as known at the moment of reservation Attribute Type integer Attribute Constraints Amount of elements possible within parent Min:1 Max:1 Format

Syntax

  <price date="2012-10-28" rate_id="1278608">410</price>

Element name - remarks

Short description Remarks regarding this reservation. Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent room Children N/A

Syntax

<room>
  ...
  <remarks></remarks>
  ...
</room>

Element name - reservation_extra_info (with price information)

<reservation_extra_info>
    <booker>
       <affiliations>
          <affiliation name=”CompanyNameHere” number=”1234567890” numbertype=”vat” type=”company”/>
       </affiliations>
    </booker>
    <flags>
         <flag name="booker_is_genius"/>
         <flag name="no_address_reservation"/>
         <flag name="no_cc_reservation"/>
    </flags>
    <guests>
       <services>
          <service name="GF_3">
             <text>Priority late check out</text>
          </service>
          <service name="GF_4">
             <text>Welcome drink</text>
          </service>
       </services>
    </guests>
    <payer>
       <payments>
          <payment amount="92.37" currency="EUR" payment_type="payment_on_Booking.com" payout_type="Virtual credit card / BankTransfer"/>
       </payments>
    </payer>
</reservation_extra_info>
<reservation>
  <price date="2016-02-06" genius_rate="no" rate_id="130435" rewritten_from_id="6535032" rewritten_from_name="Non Refundable">92.37</price>
</reservation>
  • booker - This section contain information about the person who made the reservation.
  • affiliations - Should the booker have an affiliation, information will be in this section.
  • affiliation - This section contains information about the name of the company and VAT number only if the information is provided by the booker. Supported attributes in example above.
  • flags - Flags for the reservation.
  • flag - Acceptable name attributes as in above example.
  • guests - This section contains information about the guest(s) who will stay at the accommodation.
  • services - Services for the guest that are applicable.
  • service - Applicable name attribute codes contained in the BCSN (Booking.com Service Name Codes) below with its associated text in US English.
  • payer - This section contains information about the payment of the reservation.
  • payment - payout_type will be Bank Transfer or Virtual Credit Card. In case of no prepayment, the payment tag will not be included. payment_type currently will be "payment_on_Booking.com".
  • price - Contains attributes of the date, whether the rate is a Booking.com genius_rate1), the rate_id for mapping, original rate ID rewritten_from_id and original rate name rewritten_from_name should the mapped rate should be coming from a different rate configured on Booking.com.

1)Note : A reservation with the genius_rate set to no 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 discount, see the Opportunities tab in the extranet.

The reservation can have two different currency codes

The first one is the hotel default currency. It is the value of the tag <currencycode>.
The second one is the currency of the booking virtual credit card. That is only in case the payment is payment_on_Booking.com through the Booking Virtual Credit Card. The property can choose through Extranet to recieve the virtual credit card in different curreny than its default one. It is the value of the attribute currencycode of the <payment> tag under <reservation_extra_info>.

BCSN (Booking.com Service Name Codes)

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

Element name - roomreservation_id

Short description The room reservation ID as used by Booking.com to identify the booked room within the reservation. If a guest books multiple rooms, each room will have its own unique roomreservation_id. If a room is cancelled as part of a modification, the unique roomreservation_id for that room will no longer be present. Type integer Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent room Children N/A

Syntax

<room>
  ...
  <roomreservation_id>231508996</roomreservation_id>
  ...
</room>

Element name - smoking

Short description The smoking preference as filled in on the website Type boolean Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent room Children N/A

Syntax

<room>
  ...
  <smoking>1</smoking>
  ...
</room>

Element name - totalprice

Short description The total price for this room for all nights combined, sum of all prices known at the moment of reservation. Note that there may be some excluded charges from this price. For more details please implement feature include_price_details. Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent room Children N/A

The currency used for pricing is always the same for the hotel and set by Booking.com Syntax

<room>
  ...
  <totalprice>415</totalprice>
  ...
</room>

Element name - status

Short description The reservation status ('new', 'modified' or 'cancelled'). Type integer Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent reservation Children N/A

Syntax

<reservation>
  ...
  <status>new</status>
  ...
</reservation>

Element name - time

Short description Time on which this reservation is made. HH:MM:SS format. Type datetime Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format HH:MM:SS Parent reservation Children N/A

Syntax

<reservation>
  ...
  <time>16:38:15</time>
  ...
</reservation>

Element name - total_cancellation_fee

Short description The total amount of cancellation fees a guest has to pay because the cancellation was out of the cancellation policy. All cancelled rooms * all cancelled nights combined. Type integer Amount of elements possible within parent Min:0 Max:1 Constraints N/A Format N/A Parent reservation Children N/A

Syntax

<reservation>
  ...
  <total_cancellation_fee>323</total_cancellation_fee>
  <totalprice>0</totalprice>
  ...
</reservation>

Element name - totalprice

Short description The total amount of room sales of this reservation. All rooms * all nights combined. Note that there may be some excluded charges from this price. For more details please implement feature include_price_details. Type integer Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent reservation Children N/A

Syntax

<reservation>
  ...
  <totalprice>415</totalprice>
  ...
</reservation>

Element name - price_details

Short description Properties can configure the setup of taxes and charges in the Booking.com extranet. These setups will be reflected on the Front End, confirmation email to the customer and confirmation to the hotel. Properties can specify how VAT + city tax are calculated and can set up to 5 extra charges. You can pull these extra charges with the reservation by enabling feature "include_price_details" Type N/A Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent reservation Children guest,hotel

Syntax

<reservation>
  ...
  <price_details>
      <guest>
        <extracomponent amount="8.397273" currency="EUR" included="yes" per_night="no" per_person="no" percentage="10%" text="IVA" />
        <extracomponent amount="13.500000" currency="EUR" included="no" per_night="yes" per_person="yes" percentage="no" text="Tassa di soggiorno" />
        <total>92.37</total>
      </guest>
      <hotel>
        <extracomponent amount="8.397273" currency="EUR" included="yes" per_night="no" per_person="no" percentage="10%" text="IVA" />
        <extracomponent amount="13.500000" currency="EUR" included="no" per_night="yes" per_person="yes" percentage="no" text="Tassa di soggiorno" />
        <total>92.37</total>
      </hotel>
    </price_details>
  ...
</reservation>

Element name - guest

Short description Properties can configure the setup of taxes and charges in the Booking.com extranet. Inside guest element you will find extra charges that will be applied on guest Type N/A Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent price_details Children extracomponent,total

Syntax

<price_details>
    <guest>
      <extracomponent amount="8.397273" currency="EUR" included="yes" per_night="no" per_person="no" percentage="10%" text="IVA" />
      <extracomponent amount="13.500000" currency="EUR" included="no" per_night="yes" per_person="yes" percentage="no" text="Tassa di soggiorno" />
      <total>92.37</total>
    </guest>
    ...
  </price_details>

Element name - hotel

Short description Properties can configure the setup of taxes and charges in the Booking.com extranet. Inside hotel element you will find extra charges that will be applied on hotel Type N/A Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent price_details Children extracomponent,total

Syntax

<price_details>
    ...
    <hotel>
      <extracomponent amount="8.397273" currency="EUR" included="yes" per_night="no" per_person="no" percentage="10%" text="IVA" />
      <extracomponent amount="13.500000" currency="EUR" included="no" per_night="yes" per_person="yes" percentage="no" text="Tassa di soggiorno" />
      <total>92.37</total>
    </hotel>
  </price_details>

Element name - extracomponent

Short description This will contain the setup details for the extra charges applied on guest or hotel Type N/A Amount of elements possible within parent Min:0 Max:5 Constraints N/A Format N/A Parent guest/hotel Children N/A Attributes amout,currency,included,per_night,per_person,percentage,text Syntax

    <guest>
      <extracomponent amount="8.397273" currency="EUR" included="yes" per_night="no" per_person="no" percentage="10%" text="IVA" />
      ...
    </guest>
Attribute Name - amount

Attribute description The amount of the extra charge Attribute Type Integer Attribute Constraints Amount of elements possible within parent Min:1 Max:1 Format N/A

Attribute Name - currency

Attribute description The currency code of the amount of the extra charge Attribute Type string Attribute Constraints Amount of elements possible within parent Min:1 Max:1 Format N/A

Attribute Name - included

Attribute description indicate whether this extra charge is included in the total rate. Value can be "yes" or "no" Attribute Type string Attribute Constraints Amount of elements possible within parent Min:1 Max:1 Format N/A

Attribute Name - per_night

Attribute description indicate whether this extra charge is applied per night or per total amount. can be "yes" or "no" Attribute Type string Attribute Constraints Amount of elements possible within parent Min:1 Max:1 Format N/A

Attribute Name - per_person

Attribute description indicate whether this extra charge is applied per person or per total amount. can be "yes" or "no" Attribute Type string Attribute Constraints Amount of elements possible within parent Min:1 Max:1 Format N/A

Attribute Name - percentage

Attribute description The percentage of the extra charge applied to the total amount Attribute Type string Attribute Constraints Amount of elements possible within parent Min:1 Max:1 Format N/A

Attribute Name - text

Attribute description The description of the extra charge as entered from the Booking.com extranet by the property Attribute Type string Attribute Constraints Amount of elements possible within parent Min:1 Max:1 Format N/A

Element name - total

Short description This is the total amount of extra charges that will be applied Please note that this price doesn't include excluded(included = "no") extra charges. Type Integer Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent guest/hotel Children N/A Syntax

    <guest>
      ...
      <total>92.37</total>
    </guest>

Element name - service_reservations

Short description instay service reservations array if the hotel reservation has any. Type object Amount of elements possible within parent Min:0 Max:1 Constraints N/A Format N/A Parent reservation Children service_reservation

Syntax

<reservations>
    <reservation>
        ..
        <services_reservations>
                    <service_reservation> ... </service_reservation>
                    <service_reservation> ...  </service_reservation>
                    ...
        </services_reservations>
        ..
    </reservation>
</reservations>

Element name - service_reservation

Short description single instay service reservation details. Type Amount of elements possible within parent Min:0 Max:* Constraints N/A Format N/A Parent service_reservations Children extranet_url guest_answers payment_policies prices reservation_status reservation_time service_identification_info service_reservation_id

Syntax

            <service_reservation>
                <extranet_url></extranet_url>
                <guest_answers>
                    <question name=""></question>
                </guest_answers>
                <payment_policies>
                    <payment_policy></payment_policy>
                </payment_policies>
                <prices>
                    <price>
                        <number_of_units></number_of_units>
                        <price_per_unit currency_code="" rate_description="" unit=""></price_per_unit>
                        <total currency_code=""></total>
                    </price>
                </prices>
                <reservation_status></reservation_status>
                <reservation_time time="" />
                <service_identification_info auto_approve_enabled="" id="" service_category_code="" service_type_id="" title="">
                    <attribute key=""></attribute>
                    ..
                </service_identification_info>
                <service_reservation_id></service_reservation_id>
            </service_reservation>

Element name - service_reservation_id

Short description The ID for the service reservation. Type integer Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent service_reservation Children

Syntax

    <service_reservation>
        ..
        <service_reservation_id>8699</service_reservation_id>
        ..
    </service_reservation>

Element name - extranet_url

Short description The URL that the partner can use to approve the reservation in case it’s needed. Type string Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent service_reservation Children

Syntax

<extranet_url>https://admin.booking.com/hotel/hoteladmin/extranet_ng/manage/booking.html?service_action=details&amp;hotel_id=&amp;service_req=8698&amp;res_id=</extranet_url>

Element name - guest_answers

Short description Guest answers to questions regarding the service reservation Type array of objects Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent service_reservation Children question

Syntax

        <service_reservation>
            ..
            <guest_answers>
                <question name="Which tour are you interested in?">Tour por el centro histórico a las 17:00</question>
                <question name="Which language do you speak?">Español</question>
            </guest_answers>
            ..
        </service_reservation>

Element name - payment_policies

Short description Object to describe the instay service payment policy. Type array of payment_policy tags which hold strings describing the payment method Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent service_reservation Children payment_policy

Syntax

        <service_reservation>
            ..
            <payment_policies>
                <payment_policy>Payment policy was not defined</payment_policy>
            </payment_policies>
            ..
        </service_reservation>

Element name - prices

Short description Object to describe the price of the service reservation. The price can be composed of multiple price rates. Each rate will have separate tag. Type array of price objects Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent service_reservation Children price

Syntax

        <service_reservation>
            ..
            <prices>
                <price>
                    <number_of_units>3</number_of_units>
                    <price_per_unit currency_code="EUR"
                        rate_description=""
                        unit="per_person">35</price_per_unit>
                    <total currency_code="EUR">105</total>
                </price>
                <price>
                    <number_of_units>2</number_of_units>
                    <price_per_unit currency_code="EUR"
                        rate_description=""
                        unit="per_person">10</price_per_unit>
                    <total currency_code="EUR">20</total>
                </price>
                ...
            </prices>
            ..
        </service_reservation>

Element name - service_identification_info

Short description Object to give more identification about the instay service that got the reservation.
auto_approve_enabled is a boolean with two values "True" or "False", which states if the reservation needs partner approval or not.
id is the service unique ID.
service_type_id is the Id of the service type ( servie type is like Parking/wine .... ). List of the ServiceTypeIDs.
title is the title that the partner gave to the service.
attribute tags are flexible way to give more information about the service that got the reservation. Type array of attribute objects. Amount of elements possible within parent Min:1 Max:1 Constraints N/A Format N/A Parent service_reservation Children attribute

Syntax

        <service_reservation>
            ..
            <service_identification_info auto_approve_enabled="False"
                                 id="2183"
                                 service_category_code="InStayServices"
                                 service_type_id="31"
                                 title="Attraction">
                <attribute key="attraction_description">A chance to visit the Tablao Flamenco Los Gallos </attribute>
                <attribute key="attraction_name">Flamenco show</attribute>
            </service_identification_info>
            ..
        </service_reservation>

Provider Features

Add grace period cancellation policy (res_cancel_policie)

Information about the grace period policy for non-refundable rooms. If a property chooses to offer a grace period, guests can cancel non-refundable bookings within 1, 4 or 24 hours after booking. Normally there will be one cancel penalty element with the policy code. Only if the grace period policy applies there will be a second element with policy code "grace_period" and the deadline.

    <cancel_penalties>
        <cancel_penalty policy_code="1" />
        <cancel_penalty policy_code="grace_period">
            <deadline time="2017-02-20T14:32:10+00:00" />
            <amount_percent amount="100" />
        </cancel_penalty>
    </cancel_penalties>

reservation-level guest count (childcount)

Number of adults and children with their ages that the booker searched for when making the booking

    <reservations>
        <reservation>
            <guest_counts>
                <guest_count count="2" type="adult"/>
                <guest_count age="6" count="1" type="child"/>
                <guest_count age="10" count="1" type="child"/>
            </guest_counts>
        </reservation>
    </reservations>

Include Preferred language in Customer (res_customer_preferred_lang)

<preferred_language>en</preferred_language>

Include room-level occupancy (include_room_level_occupancy)

This feature when enabled will return 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 this is the maximum occupancy of the room. It can be used to get the maximum occupancy of the room for a price.

    <reservations>
        <reservation>
            <room>
                <occupancy>2</occupancy>
            </room>
        </reservation>
    </reservations>

Payments Clarity Package (vcc_payment_v2)

VCC details can be retrieved multiple times

When retrieving reservations, you can retrieve VCC details multiple (unlimited) times. This is not possible with normal credit card (CC) details, which you can retrieve only once.

This feature enables you to see VCC Payments information when you call any of the following endpoints:

  • OTA_HotelResNotif
  • OTA_HotelResNotifSplit (OTA Push)
  • OTA_HotelResModifyNotif
  • OTA_HotelResModifyNotifSplit (OTA Push)
  • B_XML Reservations
Four Features into One

Enabling this feature adds the following information to the response of the calls mentioned above:

  • 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.
  • Card Activation Date: Specifies the date the VCC was activated in YYYY-MM-DD format.
Code Examples

Here, you can see XML examples for OTA and B.XML with the feature disabled and enabled:

OTA - Feature Disabled
<HotelReservations>
   <HotelReservation>
      <RoomStays>
         <RoomStay>
            ...
         </RoomStay>
      </RoomStays>
   </HotelReservation>
</HotelReservations>
OTA - Feature Enabled

If you enable the feature, the following attributes in the PaymentCard tag become visible in the response:

  • CurrentBalance="string (of a number)": Refers to the numerical value of the current balance on the VCC.
  • VCCExpirationDate="YYYY-MM-DD": Refers to date the VCC expires. This is Booking.com standard for VCC. ExpireDate refers to the same date, but follows the physical credit card standard.
  • EffectiveDate="YYYY-MM-DD": Refers to date the VCC was activated.
  • <Total>...</Total>: Contains the information for taxes and charges.
<HotelReservations>
   <HotelReservation>
      <RoomStays>
         <RoomStay>
            ...
               <PaymentCard CardCode="MC" CardNumber="1234567890123456" SeriesCode="123" ExpireDate="0321"
      CurrentBalance="105.99" VCCExpirationDate="2021-03-09" EffectiveDate="2019-08-12">
      <CardHolderName>test</CardHolderName>
    </PaymentCard>
               <Total AmountAfterTax="9600" DecimalPlaces="2" CurrencyCode="EUR">
                  <Taxes Amount="10545455" CurrencyCode="EUR" DecimalPlaces="6">
                     <Tax Amount="8545455" ChargeFrequency="12" Code="19" CurrencyCode="EUR" DecimalPlaces="6" Type="Inclusive">
                        <TaxDescription>
                           <Text>********</Text>
                        </TaxDescription>
                     </Tax>
                     <Tax Amount="2000000" ChargeFrequency="21" Code="3" CurrencyCode="EUR" DecimalPlaces="6" Type="Inclusive">
                        <TaxDescription>
                           <Text>********</Text>
                        </TaxDescription>
                     </Tax>
                  </Taxes>
               </Total>
            ...
         </RoomStay>
      </RoomStays>
   </HotelReservation>
</HotelReservations>
B.XML - Feature Disabled
<reservations>
  <reservation>
    <customer>
      ...
    </customer>
    ...
    <room>
    ...
    </room>
    ...
  </reservation>
</reservations>
B.XML - Feature Enabled

If you enable the feature, the following child tags to the customer parent tag become visible in the response:

  • cc_current_balance : Refers to the numerical value of the current balance on the VCC (even though it states cc_current_balance).
  • cc_activation_date: Refers to date the VCC was activated (even though it states cc_activation_date).
  • vcc_expiration_date: Refers to date the VCC expires. This is Booking.com standard for VCC.
  • price_details: Refers to information about taxes and charges.
<reservations>
  <reservation>
    <customer>
      ...
      <cc_activation_date>2019-08-12</cc_activation_date>
      <cc_current_balance>105.99</cc_current_balance>
      ...
      <vcc_expiration_date>2021-03-09</vcc_expiration_date>
      ...
    </customer>
    ...
    <room>
    ...
      <price_details>
        <guest>
          <extracomponent amount="4.230000"
                          currency="EUR"
                          included="yes"
                          per_night="no"
                          per_person="no"
                          percentage="10%"
                          text="IVA" />
          <total>46.53</total>
        </guest>
        <hotel>
          <extracomponent amount="4.230000"
                          currency="EUR"
                          included="yes"
                          per_night="no"
                          per_person="no"
                          percentage="10%"
                          text="IVA" />
          <total>46.53</total>
        </hotel>
      </price_details>
      ...
    </room>
    ...
  </reservation>
</reservations>