Booking Modification

The modification method is a PUT method that can be used to change or update different values of a booking. The changes that can be performed are:

  • Update the client reference of a booking
  • Update the booking remarks
  • Update checkIn and checkOut dates.
  • Update board plans.
  • Update passenger data.
  • Add rooms to a booking.
  • Partially cancel a booking (cancel a room of a multiroom booking)

When updating a booking you can change various values at the same time. Please be aware that there are certain values than can not be changed, such as the reservation reference or the hotel name. The contract of the booking may also be a limiting factor when updating, as for certain contracts some values can not be changed. Additionally there are certain actions you will not be able to perform, such as:

  • You can not remove paxes of a room.
  • You can not change the type of a passenger (i.e: an adult can not be converted to a child)

The easiest and most advisable way to make a modification is to retrieve the booking via the BookingDetail operation, and use the BookingDetailRS as a basis for the BookingModificationRQ (the general structure is identical)

ENDPOINT:  PUT https://api.test.hotelbeds.com/hotel-api/1.0/bookings

Request parameters

Node/Attribute

Value

Description

bookingChangeRQ

Element

Top Element

bookingChangeRQ/mode String

Defines if the operation will be a simulation or an actual modification. Values:

SIMULATION: To simulate a booking modification

UPDATE : Actual modification of a reservation

bookingChangeRQ/booking/@reference

String

Booking reference

Format: XXX-XXXXXX

bookingChangeRQ/booking/@clientReference

String

Client internal booking reference

bookingChangeRQ/booking/@creationDate

Date

Booking creation date

Format: YYYY-MM-DD

bookingChangeRQ/booking/@status

String

Booking status:

  • CONFIRMED
  • CANCELLED
bookingChangeRQ/booking/@creationUser String apiKey used to make the booking

bookingChangeRQ/booking/@totalNet

Float

Total amount of the booking

bookingChangeRQ/booking/@pendingAmount Float Remaining amount to be paid

bookingChangeRQ/booking/@currency

String

Currency of the amount to be paid

bookingChangeRQ/booking/modificationPolicies Element Information regarding the allowed modifications to the booking
bookingChangeRQ/booking/modificationPolicies/@cancellation Boolean Indicates if the booking can be cancelled
bookingChangeRQ/booking/modificationPolicies/@modification Boolean Indicates if the booking can be modified
bookingChangeRQ/booking/holder Element Information of the booking holder
bookingChangeRQ/booking/holder/@name String Booking holder name
bookingChangeRQ/booking/holder/@surname String Booking holder surname
bookingChangeRQ/booking/remark String Reservation remark

bookingChangeRQ/booking/hotel

Element

Element that contains information about the hotel and associated rates

bookingChangeRQ/booking/hotel/@checkOut Date

Check-out date

Format: YYYY-MM-DD

bookingChangeRQ/booking/hotel/@checkIn Date

Check-in date Format:

YYYY-MM-DD

bookingChangeRQ/booking/hotel/@code Int

Hotebeds internal hotel code

bookingChangeRQ/booking/hotel/@name

String

Hotel name

bookingChangeRQ/booking/hotel/@categoryCode

String

Hotel category code

bookingChangeRQ/booking/hotel/@categoryName

String

Category name

bookingChangeRQ/booking/hotel/@destinationCode

String

Destination code for hotel location

bookingChangeRQ/booking/hotel/@destinationName

String

Destination name for hotel location

bookingChangeRQ/booking/hotel/@zoneCode

Int

Zone code for hotel location

bookingChangeRQ/booking/hotel/@zoneName

String

Zone name for hotel location

bookingChangeRQ/booking/hotel/@latitude

Float

Latitude data for geolocation

bookingChangeRQ/booking/hotel/@longitude

Float

Longitude data for geolocation

bookingChangeRQ/booking/hotel/@totalNet Float Total amount of the booking

bookingChangeRQ/booking/hotel/@currency

String

Client currency 

bookingChangeRQ/booking/hotels/hotel/rooms

Array of room elements

List of rooms booked for the hotel of the reservation

bookingChangeRQ/booking/hotels/hotel/rooms/room/

Element

Element that contains information about the room and associated rates

bookingChangeRQ/booking/hotel/rooms/room/@status

String

Booking status:

  • CONFIRMED
  • CANCELLED
bookingChangeRQ/booking/hotel/rooms/room/@id Int Room reservation identifier

bookingChangeRQ/booking/hotel/rooms/room/@code

Int

Internal room code

bookingChangeRQ/booking/hotel/rooms/room/@name

String

Room name/description

bookingChangeRQ/booking/hotel/rooms/room/paxes Array of pax elements List of paxes for the room
bookingChangeRQ/booking/hotel/rooms/room/paxes/pax Element Element that describes pax information
bookingChangeRQ/booking/hotel/rooms/room/paxes/pax/@roomId Int Room where the pax is located
bookingChangeRQ/booking/hotel/rooms/room/paxes/pax/@type String

Pax type 

Two values are permitted for the attribute:

  • AD for adults
  • CH for child
bookingChangeRQ/booking/hotel/rooms/room/paxes/pax/@name String Pax name
bookingChangeRQ/booking/hotel/rooms/room/paxes/pax/@surname String Pax surname

bookingChangeRQ/booking/hotel/rooms/room/rates

Array of rate elements

List of rates for a particular hotel

bookingChangeRQ/booking/hotel/rooms/room/rates/rate

Element

Price information for a room type and board

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/@rateClass

String

Internal rate class type (NOR, NRF, SPE, OFE, PAQ ...)

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/@net Float Room net price
bookingChangeRQ/booking/hotel/rooms/room/rates/rate/@rateComments String Rate comments that contain important information (max lenght = 4000 characters)

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/@rateType

String

Whether the booking can be confirmed in two steps (BOOKABLE) or three steps (RECHECK)

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/@paymentType

String

Identifies if it is pay at hotel or merchant 

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/@packaging

String

Identifies if the rate is for packaging

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/@boardCode

String

Internal board code

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/@boardName String Board name/description

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/@sellingPrice

Float

Room gross price, if it is included

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/@comission

Float 

Commission

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/@hotelSellingRate

Float

Room gross price in hotelCurrency (for the pay at hotel model)

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/@hotelCurrency

String

Hotel currency (for the pay at hotel model)

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/@hotelMandatory

Boolean

Identifies if the selling rate is recommended

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/@rooms

Int

Number of rooms requested with the same occupancy

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/@adults

Int

Number of adults requested per room

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/@children

Int

Number of children requested per room

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/cancellationPolicies

Array of policies elements

List of cancellation policies

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/cancellationPolicies/policy

Element

Cancellation policies

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/cancellationPolicies/policy/@amount

Float

Amount that will be charged after date from

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/cancellationPolicies/policy/@from

Date

Beginning date when the amount will be charged

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/cancellationPolicies/policy/@hotelAmount

Float

Amount that will be charged after date from in hotel currency (for the pay at hotel model)

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/cancellationPolicies/policy/@hotelCurrency

String

Currency in which the booking must be paid on arrival

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown

Element

Rate breakdown element

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/@agComission

Float

Agency commission

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/@comissionPct

Float

Commission percentage

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/@comissionVat

Float

Commission taxes

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts Array of rateDiscounts elements List of discounts for a particular rate
bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts/rateDiscount Element Discount element
bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts/rateDiscount/@code Int Discount internal code
bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts/rateDiscount/@name String Discount name/description
bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts/rateDiscount/@amount Float Amount of the discount

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements

Array of rateSupplements elements

List of supplements for a particular rate

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement Element Rate supplements element
bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@code Int Supplement code
bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@name String Supplement name
bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@from Date

Date from when the supplement begins to apply

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@to Date Date that the supplement no longer applies

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@amount

Float

Supplement amount

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@nights

Int

Number of nights the supplement applies

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@paxNumber

Int

Number of paxes to whom the supplement applies

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@paxType

String

Type of pax

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/taxes

Array of tax elements

List of prices with taxes included or excluded

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/taxes/@allIncluded

Boolean

Indicates if all taxes are included or not

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/taxes/tax

Element

Element that contains the information about the tax

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/taxes/tax/@included

Boolean

Indicates if the tax is included in the price or not

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/taxes/tax/@import

Float

Value of the tax

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/taxes/tax/@hotelImport

Float

Value of the tax in hotel currency if the tax is not included in the price

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/taxes/tax/@hotelCurrency

String

Hotel currency

bookingChangeRQ/booking/hotel/rooms/room/rates/rate/taxes/tax/@percentage

Float

Percentage to be paid at the hotel

bookingChangeRQ/booking/hotel/supplier

Element

Element that contains supplier information

bookingChangeRQ/booking/hotel/supplier/@name

String

Supplier name

bookingChangeRQ/booking/hotel/supplier/@vatNumber

String

Supplier VAT number

bookingChangeRQ/booking/remark String Booking comments

Request examples

Here you can find examples of the most common uses of the booking modification operation for both XML and JSON:

Full update

In a booking update you can change one or various values at the same time. When building the request we recommend to use the booking node from the BookingDetails, as the structure is the same. If you are not sure about what changes can be done you can use the SIMULATION mode to receive a response with the predicted changes without actually making them.

Full update examples

Request XML Example

<bookingChangeRQ xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <mode>UPDATE</mode>
     <booking reference="52-1274418" clientReference="INTEGRATIONAGENCY" creationDate="2017-08-31" status="CONFIRMED" creationUser="wuupfvswdqfz342cejxfv3ku" totalNet="302.26" pendingAmount="302.26" currency="EUR">
         <modificationPolicies cancellation="true" modification="true"/>
         <holder name="INTEGRATIONTESTFIRSTNAME" surname="INTEGRATIONTESTLASTNAME"/>
         <hotel checkOut="2017-09-20" checkIn="2017-09-15" code="1" name="Villa Dorada" categoryCode="3EST" categoryName="3 STARS" destinationCode="SAL" destinationName="Salou Area / Costa Dorada" zoneCode="10" zoneName="Salou" latitude="41.06865947991072" longitude="1.1524744666303377" totalNet="302.26" currency="EUR">
             <rooms>
                 <room status="CONFIRMED" id="1" code="DBT.ST-3" name="Double or Twin MONOPARENTAL 1 ADULT 2 CHILDREN">
                     <paxes>
                         <pax roomId="1" type="AD" name="First Adult Name" surname="Surname"/>
                         <pax roomId="1" type="CH" age="6" name="Second Child Name"/>
                         <pax roomId="1" type="CH" age="5" name="First Child Name"/>
                     </paxes>
                     <rates>
                         <rate rateClass="NOR" net="302.26" rateComments="1x Double or Twin Estimated total amount of taxes &amp; fees for this booking: 2.50 Euro   payable on arrival  &#xd;. Car park NO   . Key Collection 14:00 – 00:00. Check-in hour 14:00 – 00:00. . This rate is not applicable to Spain, Italy &amp; Portugal market/country or passport holders otherwise the reservation will not be accepted or supplement fees can be charged on arrival." paymentType="AT_WEB" packaging="false" boardCode="RO" boardName="ROOM ONLY" rooms="1" adults="1" children="2">
                             <cancellationPolicies>
                                 <cancellationPolicy amount="141.00" from="2017-09-14T23:59:00+02:00"/>
                                 <cancellationPolicy amount="70.50" from="2017-09-12T23:59:00+02:00"/>
                             </cancellationPolicies>
                         </rate>
                     </rates>
                 </room>
             </rooms>
             <supplier name="HOTELBEDS PRODUCT,S.L.U." vatNumber="ESB38877676"/>
         </hotel>
     </booking>
 </bookingChangeRQ>

 

Request JSON Example

{
  "mode": "UPDATE",
      "booking": {
         "reference": "52-1274417",
         "clientReference": "AGENCYTEST",
         "creationDate": "2017-08-31",
         "status": "CONFIRMED",
         "modificationPolicies": {
             "cancellation": true,
             "modification": true
         },
         "creationUser": "wuupfvswdqfz342cejxfv3ku",
         "holder": {
             "name": "INTEGRATIONTESTFIRSTNAME",
             "surname": "INTEGRATIONTESTLASTNAME"
         },
         "hotel": {
             "checkOut": "2017-09-20",
             "checkIn": "2017-09-15",
             "code": 1,
             "name": "Villa Dorada",
             "categoryCode": "3EST",
             "categoryName": "3 STARS",
             "destinationCode": "SAL",
             "destinationName": "Salou Area / Costa Dorada",
             "zoneCode": 10,
             "zoneName": "Salou",
             "latitude": "41.06865947991072",
             "longitude": "1.1524744666303377",
             "rooms": [
                 {
                     "status": "CONFIRMED",
                     "id": 1,
                     "code": "DBT.ST-3",
                     "name": "Double or Twin MONOPARENTAL 1 ADULT 2 CHILDREN",
                     "paxes": [
                         {
                             "roomId": 1,
                             "type": "AD",
                             "name": "First Adult Name",
                             "surname": "Surname"
                         },
                         {
                             "roomId": 1,
                             "type": "CH",
                             "age": 6,
                             "name": "Second Child Name"
                         },
                         {
                             "roomId": 1,
                             "type": "CH",
                             "age": 5,
                             "name": "First Child Name"
                         }
                     ],
                     "rates": [
                         {
                             "rateClass": "NOR",
                             "net": "302.26",
                             "rateComments": "1x Double or Twin Estimated total amount of taxes & fees for this booking: 2.50 Euro   payable on arrival  \r. Car park NO   . Key Collection 14:00 – 00:00. Check-in hour 14:00 – 00:00. . This rate is not applicable to Spain, Italy & Portugal market/country or passport holders otherwise the reservation will not be accepted or supplement fees can be charged on arrival.",
                             "paymentType": "AT_WEB",
                             "packaging": false,
                             "boardCode": "RO",
                             "boardName": "ROOM ONLY",
                             "cancellationPolicies": [
                                 {
                                     "amount": "141.00",
                                     "from": "2017-09-14T23:59:00+02:00"
                                 },
                                 {
                                     "amount": "70.50",
                                     "from": "2017-09-12T23:59:00+02:00"
                                 }
                             ],
                             "rooms": 1,
                             "adults": 1,
                             "children": 2
                         }
                     ]
                 }
             ],
             "totalNet": "302.26",
             "currency": "EUR",
             "supplier": {
                 "name": "HOTELBEDS PRODUCT,S.L.U.",
                 "vatNumber": "ESB38877676"
             }
         },
         "totalNet": 302.26,
         "pendingAmount": 302.26,
         "currency": "EUR"
     }
 }

 

Add rooms to a booking.

In a booking modification you can add rooms to a booking, provided that the new rooms are of the same type and have the same rate (and therefore share the same rateKey) as those already existing in the reservation.

Bear in mind that adding new rooms, even with the same rate Key, is subject to availability, so although not mandatory is highly recommended to request availability before attempting this action.

Add room examples

Request XML Example

 

BookingDetailsRS

<?xml version="1.0" encoding="UTF-8"?>
<bookingDetailRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" schemaLocation="http://www.hotelbeds.com/schemas/messages">
     <auditData processTime="291" timestamp="2017-08-31 12:51:35.895" requestHost="212.170.239.110" serverId="sa3RKSJACHXE79K.env#PL" environment="[int]" release="23c542efb2ca3c1642f5f0d87c6c410b81c52ee3" token="40667155-98cf-473f-88a3-8b96e70aeb2a"/>
     <booking reference="52-1274420" clientReference="INTEGRATIONAGENCY" creationDate="2017-08-31" status="CONFIRMED" creationUser="wuupfvswdqfz342cejxfv3ku" totalNet="604.50" pendingAmount="604.50" currency="EUR">
         <modificationPolicies cancellation="true" modification="true"/>
         <holder name="INTEGRATIONTESTFIRSTNAME" surname="INTEGRATIONTESTLASTNAME"/>
         <hotel checkOut="2017-09-20" checkIn="2017-09-15" code="1" name="Villa Dorada" categoryCode="3EST" categoryName="3 STARS" destinationCode="SAL" destinationName="Salou Area / Costa Dorada" zoneCode="10" zoneName="Salou" latitude="41.06865947991072" longitude="1.1524744666303377" totalNet="604.50" currency="EUR">
             <rooms>
                 <room status="CONFIRMED" id="1" code="DBT.ST" name="Double or Twin 2 ADULTS">
                     <paxes>
                         <pax roomId="1" type="AD" name="First Adult Name"/>
                         <pax roomId="1" type="AD" name="Second Adult Name"/>
                     </paxes>
                     <rates>
                         <rate rateClass="NOR" net="604.50" rateComments="2x Double or Twin Estimated total amount of taxes &amp; fees for this booking: 10.00 Euro   payable on arrival  &#xd;. Car park NO   . Key Collection 14:00 – 00:00. Check-in hour 14:00 – 00:00. . This rate is not applicable to Spain, Italy &amp; Portugal market/country or passport holders otherwise the reservation will not be accepted or supplement fees can be charged on arrival." paymentType="AT_WEB" packaging="false" boardCode="RO" boardName="ROOM ONLY" rooms="2" adults="2" children="0">
                             <cancellationPolicies>
                                 <cancellationPolicy amount="281.96" from="2017-09-14T23:59:00+02:00"/>
                                 <cancellationPolicy amount="140.98" from="2017-09-12T23:59:00+02:00"/>
                             </cancellationPolicies>
                         </rate>
                     </rates>
                 </room>
             </rooms>
             <supplier name="HOTELBEDS PRODUCT,S.L.U." vatNumber="ESB38877676"/>
         </hotel>    
     </booking>
 </bookingDetailRS>

 

BookingChangeRQ

<bookingChangeRQ xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <mode>UPDATE</mode>
     <booking reference="52-1274420" clientReference="INTEGRATIONAGENCY" creationDate="2017-08-31" status="CONFIRMED" creationUser="wuupfvswdqfz342cejxfv3ku" totalNet="604.50" pendingAmount="604.50" currency="EUR">
         <modificationPolicies cancellation="true" modification="true"/>
         <holder name="INTEGRATIONTESTFIRSTNAME" surname="INTEGRATIONTESTLASTNAME"/>
         <hotel checkOut="2017-09-20" checkIn="2017-09-15" code="1" name="Villa Dorada" categoryCode="3EST" categoryName="3 STARS" destinationCode="SAL" destinationName="Salou Area / Costa Dorada" zoneCode="10" zoneName="Salou" latitude="41.06865947991072" longitude="1.1524744666303377" totalNet="604.50" currency="EUR">
             <rooms>
                 <room status="CONFIRMED" id="1" code="DBT.ST" name="Double or Twin 2 ADULTS">
                     <paxes>
                         <pax roomId="1" type="AD" name="First Adult Name"/>
                         <pax roomId="1" type="AD" name="Second Adult Name"/>
                         <pax roomId="2" type="AD" name="Third Adult Name"/>
                         <pax roomId="2" type="AD" name="Fourth Adult Name"/>
                     </paxes>
                     <rates>
                         <rate rateClass="NOR" net="604.50" rateComments="2x Double or Twin Estimated total amount of taxes &amp; fees for this booking: 10.00 Euro   payable on arrival  &#xd;. Car park NO   . Key Collection 14:00 – 00:00. Check-in hour 14:00 – 00:00. . This rate is not applicable to Spain, Italy &amp; Portugal market/country or passport holders otherwise the reservation will not be accepted or supplement fees can be charged on arrival." paymentType="AT_WEB" packaging="false" boardCode="RO" boardName="ROOM ONLY" rooms="2" adults="2" children="0">
                             <cancellationPolicies>
                                 <cancellationPolicy amount="281.96" from="2017-09-14T23:59:00+02:00"/>
                                 <cancellationPolicy amount="140.98" from="2017-09-12T23:59:00+02:00"/>
                             </cancellationPolicies>
                         </rate>
                     </rates>
                 </room>
             </rooms>
             <supplier name="HOTELBEDS PRODUCT,S.L.U." vatNumber="ESB38877676"/>
         </hotel>
     </booking>
 </bookingChangeRQ>

 

Request JSON Example

 

BookingDetailsRS

{
     "auditData": {
         "processTime": "124",
         "timestamp": "2017-08-31 15:41:30.680",
         "requestHost": "212.170.239.110",
         "serverId": "sa3RKSJACHXE79K.env#PL",
         "environment": "[int]",
         "release": "23c542efb2ca3c1642f5f0d87c6c410b81c52ee3",
         "token": "a135766a-def3-4648-83e6-bb2173b972b0"
     },
     "booking": {
         "reference": "258-555202",
         "clientReference": "INTEGRATIONAGENCY",
         "creationDate": "2017-08-31",
         "status": "CONFIRMED",
         "modificationPolicies":  {
             "cancellation": true,
             "modification": true
         },
         "creationUser": "wuupfvswdqfz342cejxfv3ku",
         "holder": {
             "name": "INTEGRATIONTESTFIRSTNAME",
             "surname": "INTEGRATIONTESTLASTNAME"
         },
         "hotel": {
             "checkOut": "2017-11-15",
             "checkIn": "2017-11-14",
             "code": 424819,
             "name": "America Do Sul",
             "categoryCode": "3EST",
             "categoryName": "3 STARS",
             "destinationCode": "SAO",
             "destinationName": "Sao Paulo",
             "zoneCode": 1,
             "zoneName": "Sao Paulo - City",
             "latitude": "-23.540438",
             "longitude": "-46.642541",
             "rooms": [
                 {
                     "status": "CONFIRMED",
                     "id": 1,
                     "code": "DBL.ST",
                     "name": "DOUBLE STANDARD",
                     "paxes": [
                         {
                             "roomId": 1,
                             "type": "AD",
                             "name": "First Adult Name"
                         },
                         {
                             "roomId": 1,
                             "type": "AD",
                             "name": "Second Adult Name"
                         }
                     ],
                     "rates": [
                         {
                             "rateClass": "NOR",
                             "net": "68.04",
                             "rateComments": "Car park NO   . Check-in hour 14:00 – 14:00. ",
                             "paymentType": "AT_WEB",
                             "packaging": false,
                             "boardCode": "BB",
                             "boardName": "BED AND BREAKFAST",
                             "cancellationPolicies": [
                                 {
                                     "amount": "68.04",
                                     "from": "2017-11-10T23:59:00-03:00"
                                 }
                             ],
                             "rooms": 2,
                             "adults": 2,
                             "children": 0
                         }
                     ]
                 }
             ],
             "totalNet": "68.04",
             "currency": "USD",
             "supplier": {
                 "name": "ADVANTOS BRASIL OPERADORA DE TURISMO, LTDA",
                 "vatNumber": "BR16847249000177"
             }
         },
         "totalNet": 68.04,
         "pendingAmount": 68.04,
         "currency": "USD"
     }
 }

 

BookingChangeRQ

{
  "mode": "UPDATE",
     "booking": {
         "reference": "258-555202",
         "clientReference": "INTEGRATIONAGENCY",
         "creationDate": "2017-08-31",
         "status": "CONFIRMED",
         "modificationPolicies": {
             "cancellation": true,
             "modification": true
         },
         "creationUser": "wuupfvswdqfz342cejxfv3ku",
         "holder": {
             "name": "INTEGRATIONTESTFIRSTNAME",
             "surname": "INTEGRATIONTESTLASTNAME"
         },
         "hotel": {
             "checkOut": "2017-11-15",
             "checkIn": "2017-11-14",
             "code": 424819,
             "name": "America Do Sul",
             "categoryCode": "3EST",
             "categoryName": "3 STARS",
             "destinationCode": "SAO",
             "destinationName": "Sao Paulo",
             "zoneCode": 1,
             "zoneName": "Sao Paulo - City",
             "latitude": "-23.540438",
             "longitude": "-46.642541",
             "rooms": [
                 {
                     "status": "CONFIRMED",
                     "id": 1,
                     "code": "DBL.ST",
                     "name": "DOUBLE STANDARD",
                     "paxes": [
                         {
                             "roomId": 1,
                             "type": "AD",
                             "name": "First Adult Name"
                         },
                         {
                             "roomId": 1,
                             "type": "AD",
                             "name": "Second Adult Name"
                         },
                         {
                             "roomId": 2,
                             "type": "AD",
                             "name": "Third Adult Name"
                         },
                         {
                             "roomId": 2,
                             "type": "AD",
                             "name": "Fourth Adult Name"
                         }
                     ],
                     "rates": [
                         {
                             "rateClass": "NOR",
                             "net": "68.04",
                             "rateComments": "Car park NO   . Check-in hour 14:00 – 14:00. ",
                             "paymentType": "AT_WEB",
                             "packaging": false,
                             "boardCode": "BB",
                             "boardName": "BED AND BREAKFAST",
                             "cancellationPolicies": [
                                 {
                                     "amount": "68.04",
                                     "from": "2017-11-10T23:59:00-03:00"
                                 }
                             ],
                             "rooms": 2,
                             "adults": 2,
                             "children": 0
                         }
                     ]
                 }
             ],
             "totalNet": "68.04",
             "currency": "USD",
             "supplier": {
                 "name": "ADVANTOS BRASIL OPERADORA DE TURISMO, LTDA",
                 "vatNumber": "BR16847249000177"
             }
         },
         "totalNet": 68.04,
         "pendingAmount": 68.04,
         "currency": "USD"
     }
 }

 

 

Partially cancel a booking.

Partial cancellation is the cancellation of one or more rooms from a booking with multiple rooms booked without cancelling all of them. An example of this would be cancelling a room from a two room reservation. 

APItude allows two ways of booking more than one room in a booking:

  • Booking two rooms (or more) of the same type and occupation. This reservation mode uses just one rateKeys.
  • Booking two rooms (or more) of different type and occupation. This reservation mode uses multiple rateKeys.

Depending of this the method for partial cancellation differs slightly. Here are examples of both types of partial cancellation, showing the BookingDetails response of a booking before the partial cancellation and request and response of the BookingChange:

Partial cancellation of a booking with multiple rooms of the same type

Request XML Example

 

BookingDetailsRS

<?xml version="1.0" encoding="UTF-8"?>
<bookingDetailRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" schemaLocation="http://www.hotelbeds.com/schemas/messages">
     <auditData processTime="291" timestamp="2017-08-31 12:51:35.895" requestHost="212.170.239.110" serverId="sa3RKSJACHXE79K.env#PL" environment="[int]" release="23c542efb2ca3c1642f5f0d87c6c410b81c52ee3" token="40667155-98cf-473f-88a3-8b96e70aeb2a"/>
     <booking reference="52-1274420" clientReference="INTEGRATIONAGENCY" creationDate="2017-08-31" status="CONFIRMED" creationUser="wuupfvswdqfz342cejxfv3ku" totalNet="604.50" pendingAmount="604.50" currency="EUR">
         <modificationPolicies cancellation="true" modification="true"/>
         <holder name="INTEGRATIONTESTFIRSTNAME" surname="INTEGRATIONTESTLASTNAME"/>
         <hotel checkOut="2017-09-20" checkIn="2017-09-15" code="1" name="Villa Dorada" categoryCode="3EST" categoryName="3 STARS" destinationCode="SAL" destinationName="Salou Area / Costa Dorada" zoneCode="10" zoneName="Salou" latitude="41.06865947991072" longitude="1.1524744666303377" totalNet="604.50" currency="EUR">
             <rooms>
                 <room status="CONFIRMED" id="1" code="DBT.ST" name="Double or Twin 2 ADULTS">
                     <paxes>
                         <pax roomId="1" type="AD" name="First Adult Name"/>
                         <pax roomId="1" type="AD" name="Second Adult Name"/>
                         <pax roomId="2" type="AD" name="Third Adult Name"/>
                         <pax roomId="2" type="AD" name="Fourth Adult Name"/>
                     </paxes>
                     <rates>
                         <rate rateClass="NOR" net="604.50" rateComments="2x Double or Twin Estimated total amount of taxes &amp; fees for this booking: 10.00 Euro   payable on arrival  &#xd;. Car park NO   . Key Collection 14:00 – 00:00. Check-in hour 14:00 – 00:00. . This rate is not applicable to Spain, Italy &amp; Portugal market/country or passport holders otherwise the reservation will not be accepted or supplement fees can be charged on arrival." paymentType="AT_WEB" packaging="false" boardCode="RO" boardName="ROOM ONLY" rooms="2" adults="2" children="0">
                             <cancellationPolicies>
                                 <cancellationPolicy amount="281.96" from="2017-09-14T23:59:00+02:00"/>
                                 <cancellationPolicy amount="140.98" from="2017-09-12T23:59:00+02:00"/>
                             </cancellationPolicies>
                         </rate>
                     </rates>
                 </room>
             </rooms>
             <supplier name="HOTELBEDS PRODUCT,S.L.U." vatNumber="ESB38877676"/>
         </hotel>
     </booking>
 </bookingDetailRS>

 

BookingChangeRQ

<bookingChangeRQ xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <mode>UPDATE</mode>
     <booking reference="52-1274420" clientReference="INTEGRATIONAGENCY" creationDate="2017-08-31" status="CONFIRMED" creationUser="wuupfvswdqfz342cejxfv3ku" totalNet="604.50" pendingAmount="604.50" currency="EUR">
         <modificationPolicies cancellation="true" modification="true"/>
         <holder name="INTEGRATIONTESTFIRSTNAME" surname="INTEGRATIONTESTLASTNAME"/>
         <hotel checkOut="2017-09-20" checkIn="2017-09-15" code="1" name="Villa Dorada" categoryCode="3EST" categoryName="3 STARS" destinationCode="SAL" destinationName="Salou Area / Costa Dorada" zoneCode="10" zoneName="Salou" latitude="41.06865947991072" longitude="1.1524744666303377" totalNet="604.50" currency="EUR">
             <rooms>
                 <room status="CONFIRMED" id="1" code="DBT.ST" name="Double or Twin 2 ADULTS">
                     <paxes>
                         <pax roomId="1" type="AD" name="First Adult Name"/>
                         <pax roomId="1" type="AD" name="Second Adult Name"/>
                     </paxes>
                     <rates>
                         <rate rateClass="NOR" net="604.50" rateComments="2x Double or Twin Estimated total amount of taxes &amp; fees for this booking: 10.00 Euro   payable on arrival  &#xd;. Car park NO   . Key Collection 14:00 – 00:00. Check-in hour 14:00 – 00:00. . This rate is not applicable to Spain, Italy &amp; Portugal market/country or passport holders otherwise the reservation will not be accepted or supplement fees can be charged on arrival." paymentType="AT_WEB" packaging="false" boardCode="RO" boardName="ROOM ONLY" rooms="2" adults="2" children="0">
                             <cancellationPolicies>
                                 <cancellationPolicy amount="281.96" from="2017-09-14T23:59:00+02:00"/>
                                 <cancellationPolicy amount="140.98" from="2017-09-12T23:59:00+02:00"/>
                             </cancellationPolicies>
                         </rate>
                     </rates>
                 </room>
             </rooms>
             <supplier name="HOTELBEDS PRODUCT,S.L.U." vatNumber="ESB38877676"/>
         </hotel>
     </booking>
 </bookingChangeRQ>

 

Request JSON Example

 

BookingDetailsRS

{
     "auditData": {
         "processTime": "124",
         "timestamp": "2017-08-31 15:41:30.680",
         "requestHost": "212.170.239.110",
         "serverId": "sa3RKSJACHXE79K.env#PL",
         "environment": "[int]",
         "release": "23c542efb2ca3c1642f5f0d87c6c410b81c52ee3",
         "token": "a135766a-def3-4648-83e6-bb2173b972b0"
     },
     "booking": {
         "reference": "258-555202",
         "clientReference": "INTEGRATIONAGENCY",
         "creationDate": "2017-08-31",
         "status": "CONFIRMED",
         "modificationPolicies":  {
             "cancellation": true,
             "modification": true
         },
         "creationUser": "wuupfvswdqfz342cejxfv3ku",
         "holder": {
             "name": "INTEGRATIONTESTFIRSTNAME",
             "surname": "INTEGRATIONTESTLASTNAME"
         },
         "hotel": {
             "checkOut": "2017-11-15",
             "checkIn": "2017-11-14",
             "code": 424819,
             "name": "America Do Sul",
             "categoryCode": "3EST",
             "categoryName": "3 STARS",
             "destinationCode": "SAO",
             "destinationName": "Sao Paulo",
             "zoneCode": 1,
             "zoneName": "Sao Paulo - City",
             "latitude": "-23.540438",
             "longitude": "-46.642541",
             "rooms": [
                 {
                     "status": "CONFIRMED",
                     "id": 1,
                     "code": "DBL.ST",
                     "name": "DOUBLE STANDARD",
                     "paxes": [
                         {
                             "roomId": 1,
                             "type": "AD",
                             "name": "First Adult Name"
                         },
                         {
                             "roomId": 1,
                             "type": "AD",
                             "name": "Second Adult Name"
                         },  
                       {
                             "roomId": 2,
                             "type": "AD",
                             "name": "Third Adult Name"
                         },
                         {
                             "roomId": 2,
                             "type": "AD",
                             "name": "Fourth Adult Name"
                         }
                     ],
                     "rates": [
                         {
                             "rateClass": "NOR",
                             "net": "68.04",
                             "rateComments": "Car park NO   . Check-in hour 14:00 – 14:00. ",
                             "paymentType": "AT_WEB",
                             "packaging": false,
                             "boardCode": "BB",
                             "boardName": "BED AND BREAKFAST",
                             "cancellationPolicies": [
                                 {
                                     "amount": "68.04",
                                     "from": "2017-11-10T23:59:00-03:00"
                                 }
                             ],
                             "rooms": 2,
                             "adults": 2,
                             "children": 0
                         }
                     ]
                 }
             ],
             "totalNet": "68.04",
             "currency": "USD",
             "supplier": {
                 "name": "ADVANTOS BRASIL OPERADORA DE TURISMO, LTDA",
                 "vatNumber": "BR16847249000177"
             }
         },
         "totalNet": 68.04,
         "pendingAmount": 68.04,
         "currency": "USD"
     }
 }

 

BookingChangeRQ

{
  "mode": "UPDATE",
     "booking": {
         "reference": "258-555202",
         "clientReference": "INTEGRATIONAGENCY",
         "creationDate": "2017-08-31",
         "status": "CONFIRMED",
         "modificationPolicies": {
             "cancellation": true,
             "modification": true
         },
         "creationUser": "wuupfvswdqfz342cejxfv3ku",
         "holder": {
             "name": "INTEGRATIONTESTFIRSTNAME",
             "surname": "INTEGRATIONTESTLASTNAME"
         },
         "hotel": {
             "checkOut": "2017-11-15",
             "checkIn": "2017-11-14",
             "code": 424819,
             "name": "America Do Sul",
             "categoryCode": "3EST",
             "categoryName": "3 STARS",
             "destinationCode": "SAO",
             "destinationName": "Sao Paulo",
             "zoneCode": 1,
             "zoneName": "Sao Paulo - City",
             "latitude": "-23.540438",
             "longitude": "-46.642541",
             "rooms": [
                 {
                     "status": "CONFIRMED",
                     "id": 1,
                     "code": "DBL.ST",
                     "name": "DOUBLE STANDARD",
                     "paxes": [
                         {
                             "roomId": 1,
                             "type": "AD",
                             "name": "First Adult Name"
                         },
                         {
                             "roomId": 1,
                             "type": "AD",
                             "name": "Second Adult Name"
                         }
                     ],
                     "rates": [
                         {
                             "rateClass": "NOR",
                             "net": "68.04",
                             "rateComments": "Car park NO   . Check-in hour 14:00 – 14:00. ",
                             "paymentType": "AT_WEB",
                             "packaging": false,
                             "boardCode": "BB",
                             "boardName": "BED AND BREAKFAST",
                             "cancellationPolicies": [
                                 {
                                     "amount": "68.04",
                                     "from": "2017-11-10T23:59:00-03:00"
                                 }
                             ],
                             "rooms": 2,
                             "adults": 2,
                             "children": 0
                         }
                     ]
                 }
             ],
             "totalNet": "68.04",
             "currency": "USD",
             "supplier": {
                 "name": "ADVANTOS BRASIL OPERADORA DE TURISMO, LTDA",
                 "vatNumber": "BR16847249000177"
             }
         },
         "totalNet": 68.04,
         "pendingAmount": 68.04,
         "currency": "USD"
     }
 }

 

Partial cancellation of a booking with multiple rooms of different type

Request XML Example

 

BookingDetailsRS

 <?xml version="1.0" encoding="UTF-8"?>
  <bookingDetailRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" schemaLocation="http://www.hotelbeds.com/schemas/messages">
     <auditData processTime="291" timestamp="2017-08-31 12:51:35.895" requestHost="212.170.239.110" serverId="sa3RKSJACHXE79K.env#PL" environment="[int]" release="23c542efb2ca3c1642f5f0d87c6c410b81c52ee3" token="40667155-98cf-473f-88a3-8b96e70aeb2a"/>
     <booking reference="52-1274419" clientReference="INTEGRATIONAGENCY" creationDate="2017-08-31" status="CONFIRMED" creationUser="wuupfvswdqfz342cejxfv3ku" totalNet="528.97" pendingAmount="528.97" currency="EUR">
         <modificationPolicies cancellation="true" modification="true"/>
         <holder name="INTEGRATIONTESTFIRSTNAME" surname="INTEGRATIONTESTLASTNAME"/>
         <hotel checkOut="2017-09-20" checkIn="2017-09-15" code="1" name="Villa Dorada" categoryCode="3EST" categoryName="3 STARS" destinationCode="SAL" destinationName="Salou Area / Costa Dorada" zoneCode="10" zoneName="Salou" latitude="41.06865947991072" longitude="1.1524744666303377" totalNet="528.97" currency="EUR">
             <rooms>
                 <room status="CONFIRMED" id="1" code="DBT.ST" name="Double or Twin 2 ADULTS">
                     <paxes>
                         <pax roomId="1" type="AD" name="Second Adult Name" surname="Surname"/>
                         <pax roomId="1" type="AD" name="First Adult Name" surname="Surname"/>
                     < /paxes>
                     < rates>
                         <rate rateClass="NOR" net="302.25" rateComments="1x Double or Twin Estimated total amount of taxes &amp; fees for this booking: 5.00 Europayable on arrival&#xd;. Car park NO. Key Collection 14:00 &ndash; 00:00. Check-in hour 14:00 &ndash; 00:00. . This rate is not applicable to Spain, Italy &amp; Portugal market/country or passport holders otherwise the reservation will not be accepted or supplement fees can be charged on arrival." paymentType="AT_WEB" packaging="false" boardCode="RO" boardName="ROOM ONLY" rooms="1" adults="2" children="0">
                             <cancellationPolicies>
                               ;<cancellationPolicy amount="140.98" from="2017-09-14T23:59:00+02:00"/>
                               ;<cancellationPolicy amount="70.49" from="2017-09-12T23:59:00+02:00"/>
                             </cancellationPolicies>
                         </rate>
                     </rates>
                 </room>
                 <room status="CONFIRMED" id="2" code="DBT.ST-2" name="Double or Twin MONOPARENTAL 1 ADULT 1 CHILD">
                     <paxes>
                         <pax roomId="1" type="AD" name="Third Adult Name" surname="Surname"/>
                         <pax roomId="1" type="CH" age="2" name="First Child Name"/>
                     </paxes>
                     <rates>
                         <rate rateClass="NOR" net="226.72" rateComments="1x Double or Twin Estimated total amount of taxes &amp; fees for this booking: 2.50 Europayable on arrival&#xd;. Car park NO. Key Collection 14:00 &ndash; 00:00. Check-in hour 14:00 &ndash; 00:00. . This rate is not applicable to Spain, Italy &amp; Portugal market/country or passport holders otherwise the reservation will not be accepted or supplement fees can be charged on arrival." paymentType="AT_WEB" packaging="false" boardCode="RO" boardName="ROOM ONLY" rooms="1" adults="1" children="1">
                             <cancellationPolicies>
                                 <cancellationPolicy amount="105.76" from="2017-09-14T23:59:00+02:00"/>
                                 <cancellationPolicy amount="52.88" from="2017-09-12T23:59:00+02:00"/>
                             </cancellationPolicies>
                         </rate>
                     </rates>
                 </room>
             </rooms>
             <supplier name="HOTELBEDS PRODUCT,S.L.U." vatNumber="ESB38877676"/>
         </hotel>
     </booking>
</bookingDetailRS>

 

BookingChangeRQ

 <bookingChangeRQ xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <mode>UPDATE</mode>
     <booking reference="52-1274419" clientReference="INTEGRATIONAGENCY" creationDate="2017-08-31" status="CONFIRMED" creationUser="wuupfvswdqfz342cejxfv3ku" totalNet="528.97" pendingAmount="528.97" currency="EUR">
         <modificationPolicies cancellation="true" modification="true"/>
         <holder name="INTEGRATIONTESTFIRSTNAME" surname="INTEGRATIONTESTLASTNAME"/>
         <hotel checkOut="2017-09-20" checkIn="2017-09-15" code="1" name="Villa Dorada" categoryCode="3EST" categoryName="3 STARS" destinationCode="SAL" destinationName="Salou Area / Costa Dorada" zoneCode="10" zoneName="Salou" latitude="41.06865947991072" longitude="1.1524744666303377" totalNet="528.97" currency="EUR">
             <rooms>
                 <room status="CONFIRMED" id="1" code="DBT.ST" name="Double or Twin 2 ADULTS">
                     <paxes>
                         <pax roomId="1" type="AD" name="Second Adult Name" surname="Surname"/>
                         <pax roomId="1" type="AD" name="First Adult Name" surname="Surname"/>
                     </paxes>
                     <rates>
                         <rate rateClass="NOR" net="302.25" rateComments="1x Double or Twin Estimated total amount of taxes &amp; fees for this booking: 5.00 Euro   payable on arrival  &#xd;. Car park NO   . Key Collection 14:00 – 00:00. Check-in hour 14:00 – 00:00. . This rate is not applicable to Spain, Italy &amp; Portugal market/country or passport holders otherwise the reservation will not be accepted or supplement fees can be charged on arrival." paymentType="AT_WEB" packaging="false" boardCode="RO" boardName="ROOM ONLY" rooms="1" adults="2" children="0">
                             <cancellationPolicies>
                                 <cancellationPolicy amount="140.98" from="2017-09-14T23:59:00+02:00"/>
                                 <cancellationPolicy amount="70.49" from="2017-09-12T23:59:00+02:00"/>
                             </cancellationPolicies>
                         </rate>
                     </rates>
                 </room>
             </rooms>
             <supplier name="HOTELBEDS PRODUCT,S.L.U." vatNumber="ESB38877676"/>
         </hotel>
     </booking>
 </bookingChangeRQ>

 

Request JSON Example

 

BookingDetails

{    
 "auditData": {
         "processTime": "216",
         "timestamp": "2017-08-31 14:57:10.953",
         "requestHost": "212.170.239.110",
         "serverId": "sa3RKSJACHXE79K.env#PL",
         "environment": "[int]",
         "release": "23c542efb2ca3c1642f5f0d87c6c410b81c52ee3",
         "token": "b6848acf-b248-47e1-a8fd-3318e786186b"
     },
     "booking": {
         "reference": "258-555201",
         "clientReference": "INTEGRATIONAGENCY",
         "creationDate": "2017-08-31",
         "status": "CONFIRMED",
         "modificationPolicies": {
             "cancellation": true,
             "modification": true
         },
         "creationUser": "wuupfvswdqfz342cejxfv3ku",
         "holder": {
             "name": "INTEGRATIONTESTFIRSTNAME",
             "surname": "INTEGRATIONTESTLASTNAME"
         },
         "hotel": {
             "checkOut": "2017-11-15",
             "checkIn": "2017-11-14",
             "code": 424819,
             "name": "America Do Sul",
             "categoryCode": "3EST",
             "categoryName": "3 STARS",
             "destinationCode": "SAO",
             "destinationName": "Sao Paulo",
             "zoneCode": 1,
             "zoneName": "Sao Paulo - City",
             "latitude": "-23.540438",
             "longitude": "-46.642541",
             "rooms": [                {
                     "status": "CONFIRMED",
                     "id": 1,
                     "code": "DBL.ST",
                     "name": "DOUBLE STANDARD",
                     "paxes": [
                         {
                             "roomId": 1,
                             "type": "AD",
                             "name": "Second Adult Name",
                             "surname": "Surname"
                         },
                         {
                             "roomId": 1,
                             "type": "AD",
                             "name": "First Adult Name",
                             "surname": "Surname"
                         }
                     ],
                     "rates": [
                         {
                             "rateClass": "NOR",
                             "net": "34.02",
                             "rateComments": "Car park NO   . Check-in hour 14:00 – 14:00. ",
                             "paymentType": "AT_WEB",
                             "packaging": false,
                             "boardCode": "BB",
                             "boardName": "BED AND BREAKFAST",
                             "cancellationPolicies": [
                                 {
                                     "amount": "34.02",
                                     "from": "2017-11-10T23:59:00-03:00"
                                 }
                             ],
                             "rooms": 1,
                             "adults": 2,
                             "children": 0
                         }
                     ]
                 },
                 {
                     "status": "CONFIRMED",
                     "id": 2,
                     "code": "DBL.ST",
                     "name": "DOUBLE STANDARD",
                     "paxes": [
                         {
                             "roomId": 1,
                             "type": "AD",
                             "name": "Third Adult Name",
                             "surname": "Surname"
                         },
                         {
                             "roomId": 1,
                             "type": "CH",
                             "age": 2,
                             "name": "First Child Name"
                         }
                     ],
                     "rates": [
                         {
                             "rateClass": "NOR",
                             "net": "34.02",
                             "rateComments": "Car park NO   . Check-in hour 14:00 – 14:00. ",
                             "paymentType": "AT_WEB",
                             "packaging": false,
                             "boardCode": "BB",
                             "boardName": "BED AND BREAKFAST",
                             "cancellationPolicies": [
                                 {
                                     "amount": "34.02",
                                     "from": "2017-11-10T23:59:00-03:00"
                                 }
                             ],
                             "rooms": 1,
                             "adults": 1,
                             "children": 1
                         }
                     ]
                 }
             ],
             "totalNet": "68.04",
             "currency": "USD",
             "supplier": {
                 "name": "ADVANTOS BRASIL OPERADORA DE TURISMO, LTDA",
                 "vatNumber": "BR16847249000177"
             }
         },
         "totalNet": 68.04,
         "pendingAmount": 68.04,
         "currency": "USD"
     }
 }

 

BookingChangeRQ

{
  "mode": "UPDATE",
  "booking": { 
    "reference": "258-555201",
    "clientReference": "INTEGRATIONAGENCY",
    "creationDate": "2017-08-31",
    "status": "CONFIRMED",
    "modificationPolicies": {
        "cancellation": true,
        "modification": true
    },
    "creationUser": "wuupfvswdqfz342cejxfv3ku",
    "holder": {
      "name": "INTEGRATIONTESTFIRSTNAME",
      "surname": "INTEGRATIONTESTLASTNAME"
    },
    "hotel": {
      "checkOut": "2017-11-15",
      "checkIn": "2017-11-14",
      "code": 424819,
      "name": "America Do Sul",
      "categoryCode": "3EST",
      "categoryName": "3 STARS",
      "destinationCode": "SAO",
      "destinationName": "Sao Paulo",
      "zoneCode": 1,
      "zoneName": "Sao Paulo - City",
      "latitude": "-23.540438",
      "longitude": "-46.642541",
      "rooms": [
        {
        "status": "CONFIRMED",
        "id": 1,
        "code": "DBL.ST",
        "name": "DOUBLE STANDARD",
        "paxes": [
          { 
          "roomId": 1,
          "type": "AD",
          "name": "Second Adult Name",
          "surname": "Surname" 
          },
          {
          "roomId": 1,
          "type": "AD",
          "name": "First Adult Name",
          "surname": "Surname"
          }
        ],
        "rates": [
          {
          "rateClass": "NOR",
          "net": "34.02",
          "rateComments": "Car park NO   . Check-in hour 14:00 – 14:00. ",
          "paymentType": "AT_WEB",
          "packaging": false,
          "boardCode": "BB",
          "boardName": "BED AND BREAKFAST",
          "cancellationPolicies":  [
                {
                "amount": "34.02",
                "from": "2017-11-10T23:59:00-03:00"
                }
              ],
          "rooms": 1,
          "adults": 2,
          "children": 0
          }]
        }],
    "totalNet": "68.04",
    "currency": "USD", 
    "supplier": {
      "name": "ADVANTOS BRASIL OPERADORA DE TURISMO, LTDA",
      "vatNumber": "BR16847249000177"
      }
    },
  "totalNet": 68.04,
  "pendingAmount": 68.04,
  "currency": "USD"
  }
}
	

 

Modification Response

When a booking is modified, details of the booking are returned. The format of the response is the same no matter what modification was performed. Among the info returned you can find:

  • The booking status.
  • Booking and client references.
  • Cancellation fees if applicable
  • Hotel, paxes, and rates of the modified booking

Response parameters

Node/Attribute

Type

Description

bookingChangeRS

Element

Top Element

bookingChangeRS/auditData

Element

Relevant internal information

bookingChangeRS/auditData/@processTime

Float

Server process time in milliseconds

bookingChangeRS/auditData/@timestamp

Date

Date/time when the requests have been processed

bookingChangeRS/auditData/@requestHost String IP address of the system host

bookingChangeRS/auditData/@serverId

String

Server code or ID (for internal use)

bookingChangeRS/auditData/@environment

String

Environment where the request has been sent and processed

bookingChangeRS/auditData/@release String Release version identifier
bookingChangeRS/auditData/@token String Token identifier of the operation
bookingChangeRS/auditData/@internal String Internal identifier of the parameters of the operation

bookingChangeRS/booking/@reference

String

Booking reference

Format: XXX-XXXXXX

bookingChangeRS/booking/@clientReference

String

Client internal booking reference

bookingChangeRS/booking/@creationDate

Date

Booking creation date

Format: YYYY-MM-DD

bookingChangeRS/booking/@status

String

Booking status:

  • CONFIRMED
  • CANCELLED
bookingChangeRS/booking/@creationUser String apiKey used to make the booking

bookingChangeRS/booking/@totalNet

Float

Total amount of the booking

bookingChangeRS/booking/@pendingAmount Float Remaining amount to be paid

bookingChangeRS/booking/@currency

String

Currency of the amount to be paid

bookingChangeRS/booking/modificationPolicies Element Information regarding the allowed modifications to the booking
bookingChangeRS/booking/modificationPolicies/@cancellation Boolean Indicates if the booking can be cancelled
bookingChangeRS/booking/modificationPolicies/@modification Boolean Indicates if the booking can be modified
bookingChangeRS/booking/holder Element Information of the booking holder
bookingChangeRS/booking/holder/@name String Booking holder name
bookingChangeRS/booking/holder/@surname String Booking holder surname

bookingChangeRS/booking/hotel

Element

Element that contains information about the hotel and associated rates

bookingChangeRS/booking/hotel/@checkOut Date

Check-out date

Format: YYYY-MM-DD

bookingChangeRS/booking/hotel/@checkIn Date

Check-in date Format:

YYYY-MM-DD

bookingChangeRS/booking/hotel/@code Int

Hotebeds internal hotel code

bookingChangeRS/booking/hotel/@name

String

Hotel name

bookingChangeRS/booking/hotel/@categoryCode

String

Hotel category code

bookingChangeRS/booking/hotel/@categoryName

String

Category name

bookingChangeRS/booking/hotel/@destinationCode

String

Destination code for hotel location

bookingChangeRS/booking/hotel/@destinationName

String

Destination name for hotel location

bookingChangeRS/booking/hotel/@zoneCode

Int

Zone code for hotel location

bookingChangeRS/booking/hotel/@zoneName

String

Zone name for hotel location

bookingChangeRS/booking/hotel/@latitude

Float

Latitude data for geolocation

bookingChangeRS/booking/hotel/@longitude

Float

Longitude data for geolocation

bookingChangeRS/booking/hotel/@totalNet Float Total amount of the booking

bookingChangeRS/booking/hotel/@currency

String

Client currency 

bookingChangeRS/booking/hotels/hotel/rooms

Array of room elements

List of rooms booked for the hotel of the reservation

bookingChangeRS/booking/hotels/hotel/rooms/room/

Element

Element that contains information about the room and associated rates

bookingChangeRS/booking/hotel/rooms/room/@status

String

Booking status:

  • CONFIRMED
  • CANCELLED
bookingChangeRS/booking/hotel/rooms/room/@id Int Room reservation identifier

bookingChangeRS/booking/hotel/rooms/room/@code

Int

Internal room code

bookingChangeRS/booking/hotel/rooms/room/@name

String

Room name/description

bookingChangeRS/booking/hotel/rooms/room/paxes Array of pax elements List of paxes for the room
bookingChangeRS/booking/hotel/rooms/room/paxes/pax Element Element that describes pax information
bookingChangeRS/booking/hotel/rooms/room/paxes/pax/@roomId Int Room where the pax is located
bookingChangeRS/booking/hotel/rooms/room/paxes/pax/@type String

Pax type 

Two values are permitted for the attribute:

  • AD for adults
  • CH for child
bookingChangeRS/booking/hotel/rooms/room/paxes/pax/@name String Pax name
bookingChangeRS/booking/hotel/rooms/room/paxes/pax/@surname String Pax surname

bookingChangeRS/booking/hotel/rooms/room/rates

Array of rate elements

List of rates for a particular hotel

bookingChangeRS/booking/hotel/rooms/room/rates/rate

Element

Price information for a room type and board

bookingChangeRS/booking/hotel/rooms/room/rates/rate/@rateClass

String

Internal rate class type (NOR, NRF, SPE, OFE, PAQ ...)

bookingChangeRS/booking/hotel/rooms/room/rates/rate/@net Float Room net price
bookingChangeRS/booking/hotel/rooms/room/rates/rate/@rateComments String Rate comments that contain important information (max lenght = 4000 characters)

bookingChangeRS/booking/hotel/rooms/room/rates/rate/@rateType

String

Whether the booking can be confirmed in two steps (BOOKABLE) or three steps (RECHECK)

bookingChangeRS/booking/hotel/rooms/room/rates/rate/@paymentType

String

Identifies if it is pay at hotel or merchant 

bookingChangeRS/booking/hotel/rooms/room/rates/rate/@packaging

String

Identifies if the rate is for packaging

bookingChangeRS/booking/hotel/rooms/room/rates/rate/@boardCode

String

Internal board code

bookingChangeRS/booking/hotel/rooms/room/rates/rate/@boardName String Board name/description

bookingChangeRS/booking/hotel/rooms/room/rates/rate/@sellingPrice

Float

Room gross price, if it is included

bookingChangeRS/booking/hotel/rooms/room/rates/rate/@comission

Float 

Commission

bookingChangeRS/booking/hotel/rooms/room/rates/rate/@hotelSellingRate

Float

Room gross price in hotelCurrency (for the pay at hotel model)

bookingChangeRS/booking/hotel/rooms/room/rates/rate/@hotelCurrency

String

Hotel currency (for the pay at hotel model)

bookingChangeRS/booking/hotel/rooms/room/rates/rate/@hotelMandatory

Boolean

Identifies if the selling rate is recommended

bookingChangeRS/booking/hotel/rooms/room/rates/rate/@rateComments String Rate comments that contain important information (max lenght = 4000 characters)

bookingChangeRS/booking/hotel/rooms/room/rates/rate/@rooms

Int

Number of rooms requested with the same occupancy

bookingChangeRS/booking/hotel/rooms/room/rates/rate/@adults

Int

Number of adults requested per room

bookingChangeRS/booking/hotel/rooms/room/rates/rate/@children

Int

Number of children requested per room

bookingChangeRS/booking/hotel/rooms/room/rates/rate/cancellationPolicies

Array of policies elements

List of cancellation policies

bookingChangeRS/booking/hotel/rooms/room/rates/rate/cancellationPolicies/policy

Element

Cancellation policies

bookingChangeRS/booking/hotel/rooms/room/rates/rate/cancellationPolicies/policy/@amount

Float

Amount that will be charged after date from

bookingChangeRS/booking/hotel/rooms/room/rates/rate/cancellationPolicies/policy/@from

Date

Beginning date when the amount will be charged

bookingChangeRS/booking/hotel/rooms/room/rates/rate/cancellationPolicies/policy/@hotelAmount

Float

Amount that will be charged after date from in hotel currency (for the pay at hotel model)

bookingChangeRS/booking/hotel/rooms/room/rates/rate/cancellationPolicies/policy/@hotelCurrency

String

Currency in which the booking must be paid on arrival

bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown

Element

Rate breakdown element

bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/@agComission

Float

Agency commission

bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/@comissionPct

Float

Commission percentage

bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/@comissionVat

Float

Commission taxes

bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts Array of rateDiscounts elements List of discounts for a particular rate
bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts/rateDiscount Element Discount element
bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts/rateDiscount/@code Int Discount internal code
bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts/rateDiscount/@name String Discount name/description
bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateDiscounts/rateDiscount/@amount Float Amount of the discount

bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements

Array of rateSupplements elements

List of supplements for a particular rate

bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement Element Rate supplements element
bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@code Int Supplement code
bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@name String Supplement name
bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@from Date

Date from when the supplement begins to apply

bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@to Date Date that the supplement no longer applies

bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@amount

Float

Supplement amount

bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@nights

Int

Number of nights the supplement applies

bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@paxNumber

Int

Number of paxes to whom the supplement applies

bookingChangeRS/booking/hotel/rooms/room/rates/rate/rateBreakDown/rateSupplements/rateSupplement/@paxType

String

Type of pax

bookingChangeRS/booking/hotel/rooms/room/rates/rate/taxes

Array of tax elements

List of prices with taxes included or excluded

bookingChangeRS/booking/hotel/rooms/room/rates/rate/taxes/@allIncluded

Boolean

Indicates if all taxes are included or not

bookingChangeRS/booking/hotel/rooms/room/rates/rate/taxes/tax

Element

Element that contains the information about the tax

bookingChangeRS/booking/hotel/rooms/room/rates/rate/taxes/tax/@included

Boolean

Indicates if the tax is included in the price or not

bookingChangeRS/booking/hotel/rooms/room/rates/rate/taxes/tax/@import

Float

Value of the tax

bookingChangeRS/booking/hotel/rooms/room/rates/rate/taxes/tax/@hotelImport

Float

Value of the tax in hotel currency if the tax is not included in the price

bookingChangeRS/booking/hotel/rooms/room/rates/rate/taxes/tax/@hotelCurrency

String

Hotel currency

bookingChangeRS/booking/hotel/rooms/room/rates/rate/taxes/tax/@percentage

Float

Percentage to be paid at the hotel

bookingChangeRS/booking/hotel/supplier

Element

Element that contains supplier information

bookingChangeRS/booking/hotel/supplier/@name

String

Supplier name

bookingChangeRS/booking/hotel/supplier/@vatNumber

String

Supplier VAT number

 

Response XML Example

<?xml version="1.0" encoding="UTF-8"?><bookingChangeRS xmlns="http://www.hotelbeds.com/schemas/messages" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" schemaLocation="http://www.hotelbeds.com/schemas/messages">
     <auditData processTime="2978" timestamp="2017-08-31 12:00:25.320" requestHost="58.82.138.226" serverId="sa37AUX3ROLBLIS.env#PL" environment="[int]" release="23c542efb2ca3c1642f5f0d87c6c410b81c52ee3" token="6e486723-6ee7-4715-9145-afbf9fd19acf" internal="null||||0|0||||||||||||0||||0||0|wuupfvswdqfz342cejxfv3ku||"/>
     <booking reference="52-1274418" clientReference="AGENCYTEST" creationDate="2017-08-31" status="CONFIRMED" creationUser="wuupfvswdqfz342cejxfv3ku" totalNet="302.26" pendingAmount="302.26" currency="EUR">
         <modificationPolicies cancellation="true" modification="true"/>
         <holder name="INTEGRATIONTESTFIRSTNAME" surname="INTEGRATIONTESTLASTNAME"/>
         <hotel checkOut="2017-09-20" checkIn="2017-09-15" code="1" name="Villa Dorada" categoryCode="3EST" categoryName="3 STARS" destinationCode="SAL" destinationName="Salou Area / Costa Dorada" zoneCode="10" zoneName="Salou" latitude="41.06865947991072" longitude="1.1524744666303377" totalNet="302.26" currency="EUR">
             <rooms>
                 <room status="CONFIRMED" id="1" code="DBT.ST-3" name="Double or Twin MONOPARENTAL 1 ADULT 2 CHILDREN">
                     <paxes>
                         <pax roomId="1" type="AD" name="First Adult Name" surname="Surname"/>
                         <pax roomId="1" type="CH" age="6" name="Second Child Name"/>
                         <pax roomId="1" type="CH" age="5" name="First Child Name"/>
                     </paxes>
                     <rates>
                         <rate rateClass="NOR" net="302.26" rateComments="1x Double or Twin Estimated total amount of taxes &amp; fees for this booking: 2.50 Euro   payable on arrival  &#xd;. Car park NO   . Key Collection 14:00 – 00:00. Check-in hour 14:00 – 00:00. . This rate is not applicable to Spain, Italy &amp; Portugal market/country or passport holders otherwise the reservation will not be accepted or supplement fees can be charged on arrival." paymentType="AT_WEB" packaging="false" boardCode="RO" boardName="ROOM ONLY" rooms="1" adults="1" children="2">
                             <cancellationPolicies>
                                 <cancellationPolicy amount="141.00" from="2017-09-14T23:59:00+02:00"/>
                                 <cancellationPolicy amount="70.50" from="2017-09-12T23:59:00+02:00"/>
                             </cancellationPolicies>
                         </rate>
                     </rates>
                 </room>
             </rooms>
             <supplier name="HOTELBEDS PRODUCT,S.L.U." vatNumber="ESB38877676"/>
         </hotel>
     </booking>
 </bookingChangeRS>

 

Response JSON example

{
     "auditData": {
         "processTime": "3705",
         "timestamp": "2017-08-31 11:54:19.670",
         "requestHost": "212.170.239.110",
         "serverId": "sa3RKSJACHXE79K.env#PL",
         "environment": "[int]",
         "release": "23c542efb2ca3c1642f5f0d87c6c410b81c52ee3",
         "token": "2fcceecb-acf5-4f8a-a0f3-983eba2978a5",
         "internal": "null||||0|0||||||||||||0||||0||0|wuupfvswdqfz342cejxfv3ku||"
     },
     "booking": {
         "reference": "52-1274417",
         "clientReference": "AGENCYTEST",
         "creationDate": "2017-08-31",
         "status": "CONFIRMED",
         "modificationPolicies": {
             "cancellation": true,
             "modification": true
         },
         "creationUser": "wuupfvswdqfz342cejxfv3ku",
         "holder": {
             "name": "INTEGRATIONTESTFIRSTNAME",
             "surname": "INTEGRATIONTESTLASTNAME"
         },
         "hotel": {
             "checkOut": "2017-09-20",
             "checkIn": "2017-09-15",
             "code": 1,
             "name": "Villa Dorada",
             "categoryCode": "3EST",
             "categoryName": "3 STARS",
             "destinationCode": "SAL",
             "destinationName": "Salou Area / Costa Dorada",
             "zoneCode": 10,
             "zoneName": "Salou",
             "latitude": "41.06865947991072",
             "longitude": "1.1524744666303377",
             "rooms": [
                 {
                     "status": "CONFIRMED",
                     "id": 1,
                     "code": "DBT.ST-3",
                     "name": "Double or Twin MONOPARENTAL 1 ADULT 2 CHILDREN",
                     "paxes": [
                         {
                             "roomId": 1,
                             "type": "AD",
                             "name": "First Adult Name",
                             "surname": "Surname"
                         },
                         {
                             "roomId": 1,
                             "type": "CH",
                             "age": 6,
                             "name": "Second Child Name"
                         },
                         {
                             "roomId": 1,
                             "type": "CH",
                             "age": 5,
                             "name": "First Child Name"
                         }
                     ],
                     "rates": [
                         {
                             "rateClass": "NOR",
                             "net": "302.26",
                             "rateComments": "1x Double or Twin Estimated total amount of taxes & fees for this booking: 2.50 Euro   payable on arrival  \r. Car park NO   . Key Collection 14:00 – 00:00. Check-in hour 14:00 – 00:00. . This rate is not applicable to Spain, Italy & Portugal market/country or passport holders otherwise the reservation will not be accepted or supplement fees can be charged on arrival.",
                             "paymentType": "AT_WEB",
                             "packaging": false,
                             "boardCode": "RO",
                             "boardName": "ROOM ONLY",
                             "cancellationPolicies": [
                                 {
                                     "amount": "141.00",
                                     "from": "2017-09-14T23:59:00+02:00"
                                 },
                                 {
                                     "amount": "70.50",
                                     "from": "2017-09-12T23:59:00+02:00"
                                 }
                             ],
                             "rooms": 1,
                             "adults": 1,
                             "children": 2
                         }
                     ]
                 }
             ],
             "totalNet": "302.26",
             "currency": "EUR",
             "supplier": {
                 "name": "HOTELBEDS PRODUCT,S.L.U.",
                 "vatNumber": "ESB38877676"
             }
         },
         "totalNet": 302.26,
         "pendingAmount": 302.26,
         "currency": "EUR"
     }
 }

Docs Navigation