Skip to content

Hotel Pre Book (Hotel Reprice)

Note:
Few attributes in below sample response are supplier specific, hence there can be possibility these attributes will not appear in the response. We recommend you to parse these fields as mentioned in the sample responses.

api/v1/reservation/hotel-pre-book
  • This service method is used to make a provisional booking of the selected room(s) for a hotel. It will consist of room wise detail and also contain a booking key which will be used in hotel booking service to confirm booking and this service shows that the final price (with price change indicator) for the selected room has changed or not and it is mandatory to call before making a booking call.
  • bookingKey value will be valid for 15 minutes only after that it will expire and you will have research & select room to book the hotel.

This service must be called before booking to get an updated booking amount of selected hotel rooms and get a booking key to book a room.


Hotel Pre Book Request

Tags Attribute Description
HotelPreBookCriteria (JsonObject)
hotelKey*
(String)
Unique Key for Hotels . This should be taken from Hotel search response
searchKey*
(String)
Unique Key for the search.This should be taken from Hotel search response
culture*
(String)
en
rooms (JsonArray)
room (JsonObject)
roomIndex*
(Integer)
this attribute represents the room number.This should be taken from Hotel search response
roomKey*
(String)
this is the unique key for the room .This should be taken from Hotel search response
supplementKeys supplementKey
(List of String)
unique ID list for supplements will come under this list
Not released yet


hotel pre book request
{
   "rooms": [
         {
           "roomIndex": 1,
           "roomKey": "f08c9141-1863-47ca-8e98-0df27662a5d90000DOTWHTR00000000RCMB00000000",
           "supplementKey":["suppKey1","suppKey2"]
         }
       ],
   "hotelKey": "f08c9141-1863-47ca-8e98-0df27662a5d90000DOTWHTR00000000",
   "searchKey": "f08c9141-1863-47ca-8e98-0df27662a5d9",
   "culture": "en"
}



Hotel Pre Book Response

Tags Attribute Description
meta meta
(Object)
success
(String)
Response status will be return Ex: "true"
statusCode
(Boolean)
Response statusCode will be return Ex: "1"
statusMessage
(String)
Response statusMessage will be return Ex: "SUCCESS"
actionType
(String)
This attribute will indicate that client request type such as Hotel search , Prov book and Book etc... . This is for information purpose.
conversationId
(String)
conversationId a unique identifier of current conversation .
commonData (JsonObject)
commonData searchKey*
(String)
This attribute contains a unique search key.
commonData productCode*
(String)
Product code for hotels - H
commonData culture*
(String)
en
data hotels(JsonArray) This encloses hotel information.
data bookingKey*
(String)
This attribute contains a unique booking id., which needs to be sent/passed in the final booking request and this key will be available for 15 min after pre-book response.
data hotelKey*
(String)
This attribute contains a unique hotel id.
data name*
(String)
This attribute contains hotel name.
data totalNet*
(String)
This attribute contains selling price.
data currency*
(String)
This attribute contains currency of booking price.
data priceChangeIndicator*
(String)
This attribute indicates if room price is changed or not.
checkInDate*
(String)
This attribute contains the check-in date.
checkoutDate*
(String)
This attribute contains the check-out date.
mandatoryBookData (JsonObject)
taxDetails taxDetails*
(Boolean)
This attribute indicate that tax details required to sent in booking request
rooms (JsonArray)* This encloses room information
room (JsonObject)
room roomKey*
(String)
This attribute contains the room's unique id.
room roomIndex*
(String)
represents the room number
room roomId*
(String)
This attribute contains the room id.
38_1
room ruleInfo
(String)
This attribute contains data for room rules.
38
room roomTypeName *
(String)
Room type Eg: Deluxe Room
room standardizedRoomName
(String)
Standard room name provided by hotel content solution provider (CSP). This tag will only come if any Hotel CSP enabled.
room roomTypeDesc *
(String)
Room type description
room bedType
(String)
bed type provided in the room Eg: Double
room roomView
(String)
room view description Eg: mountain view
room maxOccupancy
(Integer)
Max occupancy of a room.
room sizeMeasurement
(String)
size of the room.
room rateNotes
(String)
Eg: Please note that three Bedroom Residence is Located in the Residence Building
(This information is very important)
ratePlan (JsonObject) *
ratePlan supplierCode *
(String)
ratePlan meal *
(String)
Meal plan
ratePlan standardizedMeal
(String)
Standard meal plan provided by hotel content solution provider (CSP). This tag will only come if any Hotel CSP enabled.
ratePlan availableStatus *
(String)
availability status of the room
ratePlan cancelPolicyIndicator
(String)
The cancel policy indicators Eg: refundable
ratePlan code *
(String)
This attribute contains the room contract details
ratePlan isPackage
(String)
Shows if the room rate is a package.
ratePlan combinePolicy *
(Boolean)
Shows if cancellation policy is combined or roomwise.
ratePlan inclusions
(String)
Room inclusion details Eg: ["Free Wifi", "Free pool"]
ratePlan rateType
(String)
Contains rate type Eg: Retail/Corporate
ratePlan gstAssured
(Boolean)
This indicated that available room hotel is GST assured and you can make request for GST invoices
ratePlan lastCancellationDate
(Date)
Indicates last cancellation date
ratePlan fixedCombo
(Boolean)
Shows room selection is combined or flexible.
roomRate (JsonObject)
roomRate currency*
(String)
Contains selling currency room price
roomRate netAmount*
(Double)
Selling price of a room.
taxes (JsonArray)
tax (JsonObject)
tax name
(String)
Tax name
tax amount
(Double)
Tax amount
tax included
(Boolean)
Shows if the tax is included in the room rate or not.
rates (JsonArray) *
rate (JsonObject)
rate name *
(String)
Name of the rate Eg: daily rates
rate amount *
(String)
Rate amount
rate from *
(Date)
Start date of room rate.
rate to *
(Date)
End date of room rate.
rate rateIndex *
(String)
Rate number
offers (JsonArray)
offer (JsonObject)
offer code
(String)
Offer Code
offer name
(String)
Offer name
offer from
(Date)
Start date from that date offer will apply
offer to
(Date)
End date where the offer will expire
offer amount
(Double)
Offer amount
offer included
(Boolean)
indicate that the offer is applied or not
supplements (JsonArray)
supplement (JsonObject)
supplement supplementKey
(String)
Supplement key
supplement type
(String)
Supplement Type
supplement name
(String)
Supplement name
supplement from
(Date)
Start date from that date supplement will apply
supplement to
(Date)
End date that the supplement will expire
supplement amount
(Double)
supplement charges
supplement included
(Boolean)
indicate that the supplement is applied or not to given room
supplement currency
(String)
supplement charges currency
financialInfo (JsonObject)
financialInfo tmc
(String)
This tag contains supplier owner name.
tmc - Travel Management Company. Eg: VE
financialInfo supplier
(String)
Name of the supplier
payment (JsonObject)
payment paymentTypes
(String)
Payment types Eg: CARD,CR
payment paymentNetwork
(String)
Payment Network Codes
Not released yet


hotel pre book response
{
  "meta": {
    "success": true,
    "statusCode": "",
    "statusMessage": "",
    "additionalProperties": [
      {
        "key": "timeStamp",
        "value": "YYYY-MM-DD HH:MM:SST",
        "description": "description"
      },
      {
        "key": "serverKey",
        "value": "Server01",
        "description": "description"
      }
    ],
    "actionType": "",
    "conversationId": "fe22cb8d-67e9-4c29-92af-e44dffdcb9a9"
  },
  "warnings": [
    {
      "code": "validation_required",
      "documentationUrl": "api-doc/docs/troubleshoot/api-error-codes/index.html",
      "message": "Check In Time' can't be blank",
      "value": "Check In Time might be changed"
    }
  ],
  "errors": [
    {
      "code": "validation_required",
      "documentationUrl": "api-doc/docs/troubleshoot/api-error-codes/index.html",
      "message": "Field 'City' can't be blank",
      "value": "Field 'City' can't be blank",
      "source": {
        "field": "City",
        "pointer": "/HotelSearchCriteria/city"
      },
      "title": "Required field",
      "type": "validation_error"
    }
  ],
  "commonData": {
    "searchKey": "string",
    "productCode": "string",
    "culture": "string"
  },
  "data": [
    {
      "hotel": {
        "hotelKey": "fb0920a8-70b8-433a-a8e2-a8e32efeae5640htr00000000",
        "bookingKey": "ddb0cc7245e1c40415198428d31d8761|605468d722722a-acc0-4025-b2e5-f409b6a452ae40htr00000000rcmb00000000",
        "name": "caesarsPalaceBluewatersDubai",
        "totalNet": 6099.71,
        "currency": "aed",
        "checkInDate": "YYYY-MM-DD",
        "checkOutDate": "YYYY-MM-DD",
        "priceChangeIndicator": false,
        "rooms": [
          {
            "roomKey": "fb0920a8-70b8-433a-a8e2-a8e32efeae5640htr00000001rcmb00000000",
            "roomIndex": "1",
            "roomId": "38_1",
            "ruleInfo": "38",
            "roomTypeName": "standard",
            "roomTypeDesc": "standard",
            "bedType": "double",
            "roomView": "mountainView",
            "maxOccupancy": 2,
            "sizeMeasurement": "275Sqm",
            "roomImages": {
              "image": [
                {
                  "order": 1,
                  "type": "Room",
                  "description": "Room",
                  "path": "http://photos.hotelbeds.com/giata/42/428622/428622a_hb_ro_137.jpg"
                },
                {
                  "order": 2,
                  "type": "Room",
                  "description": "Room",
                  "path": "http://photos.hotelbeds.com/giata/42/428622/428622a_hb_ro_138.jpg"
                }
              ]
            },
            "ratePlan": {
              "supplierCode": "1",
              "meal": "roomOnly",
              "availableStatus": "available",
              "cancelPolicyIndicator": "refundable",
              "code": "76-1360717",
              "isPackage": false,
              "fixedCombo": false,
              "combinePolicy": false,
              "inclusions": [
                "Free Wifi",
                "Free pool"
              ],
              "rateType": "retail",
              "gstAssured": false,
              "lastCancellationDate": "YYYY-MM-DD",
              "additionalProperties": [
                {
                  "key": "key1",
                  "value": "value1",
                  "description": "description"
                },
                {
                  "key": "key1",
                  "value": "value1",
                  "description": "description"
                }
              ]
            },
            "roomRate": {
              "supplierAdditionalFareInfo": {
                "currency": "AED",
                "discount": 0,
                "publishedFare": 5184,
                "commissionEarned": 74.36,
                "offeredFare": 5109.64,
                "tdsOnCommission": 3.72,
                "serviceFee": 0,
                "additionalProperties": [
                  {
                    "key": "key1",
                    "value": "value1",
                    "description": "description"
                  },
                  {
                    "key": "key1",
                    "value": "value1",
                    "description": "description"
                  }
                ]
              },
              "customerAdditionalFareInfo": {
                "transactionFeeEarned": 5184,
                "tdsOnCommission": 3.72,
                "commissionEarned": 74.36,
                "markupEarned": 20,
                "discount": 0,
                "vat": 0,
                "cgst": 0,
                "sgst": 0,
                "igst": 0,
                "additionalProperties": [
                  {
                    "key": "key1",
                    "value": "value1",
                    "description": "description"
                  },
                  {
                    "key": "key1",
                    "value": "value1",
                    "description": "description"
                  }
                ]
              },
              "taxes": [
                {
                  "name": "VAT on NT & TF",
                  "amount": 54.45,
                  "included": true
                }
              ],
              "rates": [
                {
                  "name": "daily rates",
                  "amount": 1889.635,
                  "from": "YYYY-MM-DD",
                  "rateIndex": "1",
                  "to": "YYYY-MM-DD"
                }
              ],
              "currency": "INR",
              "netAmount": 1889.635,
              "additionalProperties": [
                {
                  "key": "key1",
                  "value": "value1",
                  "description": "description"
                },
                {
                  "key": "key1",
                  "value": "value1",
                  "description": "description"
                }
              ]
            },
            "offers": [
              {
                "code": "9002",
                "name": "earlyBookingDiscount",
                "from": "YYYY-MM-DD",
                "to": "YYYY-MM-DD",
                "amount": 19.86,
                "included": true,
                "additionalProperties": [
                  {
                    "key": "key1",
                    "value": "value1",
                    "description": "description"
                  },
                  {
                    "key": "key1",
                    "value": "value1",
                    "description": "description"
                  }
                ]
              }
            ],
            "supplements": [
              {
                "supplementKey": "ABFJKHEJHBMNSDFH",
                "type": "mandatory",
                "name": "testSupplement-1",
                "from": "YYYY-MM-DD",
                "to": "YYYY-MM-DD",
                "amount": 10,
                "included": true,
                "currency": "usd",
                "additionalProperties": [
                  {
                    "key": "key1",
                    "value": "value1",
                    "description": "description"
                  },
                  {
                    "key": "key1",
                    "value": "value1",
                    "description": "description"
                  }
                ]
              },
              {
                "supplementKey": "ergerhrth",
                "type": "optional",
                "name": "testSupplement-1",
                "from": "YYYY-MM-DD",
                "to": "YYYY-MM-DD",
                "amount": 10,
                "included": false,
                "currency": "usd",
                "additionalProperties": [
                  {
                    "key": "key1",
                    "value": "value1",
                    "description": "description"
                  },
                  {
                    "key": "key1",
                    "value": "value1",
                    "description": "description"
                  }
                ]
              }
            ],
            "rateNotes": "Please note that three Bedroom Residence is Located in the Residence Building",
            "financialInfo": {
              "tmc": "VE",
              "supplier": "Hotelbed",
              "payment": {
                "paymentTypes": "CARD,CR",
                "paymentNetwork": "DS,CA,DC,VI,AX"
              },
              "additionalProperties": [
                {
                  "key": "key1",
                  "value": "value1",
                  "description": "description"
                },
                {
                  "key": "key1",
                  "value": "value1",
                  "description": "description"
                }
              ]
            },
            "additionalProperties": [
              {
                "key": "key1",
                "value": "value1",
                "description": "description"
              },
              {
                "key": "key1",
                "value": "value1",
                "description": "description"
              }
            ]
          }
        ]
      },
      "mandatoryBookData": {
        "taxDetail": false,
        "additionalProperties": [
          {
            "key": "key1",
            "value": "value1",
            "description": "description"
          },
          {
            "key": "key1",
            "value": "value1",
            "description": "description"
          }
        ]
      },
      "additionalProperties": [
        {
          "key": "key1",
          "value": "value1",
          "description": "description"
        },
        {
          "key": "key1",
          "value": "value1",
          "description": "description"
        }
      ]
    }
  ]
}