Hotel Book Retrieve

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-book-retrieve

The Booking Enquiry operation allows you to retrieve booking details. The response body for the booking retrieval will be same as the booking response. If an issue arise while doing the booking, this could be used to verify the status of the booking. If somehow the bookingId is not available clientId or the bookingKey could be used

Hotel Book Retrieve Request

Tags	Attribute	Description
HotelBookRetrieveCriteria	(JsonObject)
	productType * (String)	For hotels the product type should be 'H'
	bookingReferenceId (String)	Identifies the booking after the booking creation
	clientReferenceId (String)	Clients unique id to identify a booking
	bookingKey (String)	Identifies the booking before booking creation

hotel booking retrieve request
{
  "bookingReferenceId": "BKR-2022-004052",
  "clientReferenceId": "2020-1004",
  "bookingKey": "e4785bee-92d5-4500-b96c-5dfc8f21c84a"
}

Hotel Book Retrieve Response

Tags	Attribute	Description
meta	meta (Object)
	success (Boolean)
	statusCode (String)
	statusMessage (String)
	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	productCode* (String)	Product code for hotels - H
commonData	culture* (String)	en

data	(JsonArray)	This encloses hotel information.
data	bookingReferenceId* (String)	This attribute contains the unique booking reference id.
data	clientReference * (String)	This attribute contains the client reference id.
data	supplierReferenceId * (String)	This attribute contains the supplier ReferenceId.
data	bookingStatus* (String)	This attribute contains the booking status.
data	transactionDate* (String)	Date of which the transaction has been placed.

hotel	name* (String)	This attribute contains hotel name.
	totalNet* (String)	This attribute contains selling price.
	currency* (String)	This attribute contains currency of booking price.
	checkInDate* (String)	This attribute contains the check-in date.
	checkoutDate* (String)	This attribute contains the check-out date.

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.
room	ruleInfo (String)	This attribute contains data for room rules.
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

passengerMandatoryData	(JsonObject)
	isEmailId (Boolean)	If the value of the attribute is true then send email id details in the booking request Not released yet
	isPAN (Boolean)	If the value of the attribute is true then send pan details in the booking request. Not released yet
	isPassport (Boolean)	If the value of the attribute is true then send passport details in the booking request. Not released yet
	isPhoneNo (Boolean)	If the value of the attribute is true then send phone number details in the booking request. Not released yet

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	fixedCombinations * (Boolean)	Shows room selection is combined or flexible.
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

roomRate	(JsonObject)
roomRate	currency* (String)	Contains selling currency room price
roomRate	netAmount* (Double)	Selling price of a room.
supplierAdditionalFareInfo	(JsonObject)	Not released yet
supplierAdditionalFareInfo	currency (String)	Not released yet
supplierAdditionalFareInfo	discount (Double)	Not released yet
supplierAdditionalFareInfo	publishedFare (Double)	Not released yet
supplierAdditionalFareInfo	commissionEarned (Double)	Not released yet
supplierAdditionalFareInfo	offeredFare (Double)	Not released yet
supplierAdditionalFareInfo	tdsOnCommission (Double)	Not released yet
supplierAdditionalFareInfo	serviceFee (Double)	Not released yet

customerAdditionalFareInfo	(JsonObject)	Not released yet
customerAdditionalFareInfo	transactionFeeEarned (Double)	Not released yet
customerAdditionalFareInfo	tdsOnCommission (Double)	Not released yet
customerAdditionalFareInfo	commissionEarned (Double)	Not released yet
customerAdditionalFareInfo	markupEarned (Double)	Not released yet
customerAdditionalFareInfo	discount (Double)	Not released yet
customerAdditionalFareInfo	vat (Double)	Not released yet
customerAdditionalFareInfo	cgst (Double)	Not released yet
customerAdditionalFareInfo	sgst (Double)	Not released yet
customerAdditionalFareInfo	igst (Double)	Not released yet

taxes	(JsonArray)
tax	(JsonObject)
tax	name (String)	Tax name Not released yet
tax	amount (Double)	Tax amount Not released yet
tax	included (Boolean)	Shows if the tax is included in the room rate or not. Not released yet

rates	(JsonArray) *
rate	(JsonObject)
rate	name * (String)	Name of the rate Eg: daily rates Not released yet
rate	amount * (String)	Rate amount Not released yet
rate	from * (Date)	Start date of room rate. Not released yet
rate	to * (Date)	End date of room rate. Not released yet
rate	rateIndex * (String)	Rate number Not released yet

offers	(JsonArray)
offer	(JsonObject)
offer	code (String)	Offer Code Not released yet
offer	name (String)	Offer name Not released yet
offer	from (Date)	Start date from that date offer will apply Not released yet
offer	to (Date)	End date where the offer will expire Not released yet
offer	amount (Double)	Offer amount Not released yet
offer	included (Boolean)	indicate that the offer is applied or not Not released yet

supplements	(JsonArray)
supplement	(JsonObject)
supplement	supplementKey (String)	ABFJKHEJHBMNSDFH Not released yet
supplement	type (String)	Supplement Type Not released yet
supplement	name (String)	Supplement name Not released yet
supplement	from (Date)	Start date from that date supplement will apply Not released yet
supplement	to (Date)	End date that the supplement will expire Not released yet
supplement	amount (Double)	supplement charges Not released yet
supplement	included (Boolean)	indicate that the supplement is applied or not to given room Not released yet
supplement	currency (String)	supplement charges currency Not released yet

financialInfo	(JsonObject)
financialInfo	tmc (String)	This tag contains supplier owner name. tmc - Travel Management Company. Eg: VE
financialInfo	supplier (String)	Name of the supplier
financialInfo	subSupplierCode (String)	Supplier code Not released yet
payment	(JsonObject)
payment	paymentTypes (String)	Payment types Eg: CARD,CR
payment	paymentNetwork (String)	Payment Network Codes Not released yet

passengers	(JsonArray)	This encloses passenger information. Not released yet
passenger	(JsonObject)	This encloses passenger information. Not released yet
	passengerKey (String)	passenger key Not released yet
	isLead (String)	true if the lead passenger Codes Not released yet
	ptc (String)	passenger type (ADT for adult,CHD for child)

passengerInfo	birthDate (String)	birthdate of the passenger Not released yet
	gender (String)	gender of the passenger Not released yet
	nameTitle (String)	salutation (Mr., Ms,) Not released yet
	givenName (String)	first name Not released yet
	middleName (String)	middle name Not released yet
	surName (String)	last name Not released yet

loyaltyProgramAccount	(String)	This encloses loyalty information Not released yet
	accountNumber (String)	account number Not released yet
	providerName (String)	provider name Not released yet
	tierCode (String)	tier code Not released yet
	programName (String)	program name Not released yet

identityDocument	(JsonObject)	This encloses identity documents Not released yet
	idType (String)	id type (PAN, PASSPORT) Not released yet
	issuingCountryCode (String)	issuing country Not released yet
	applicableCountry (String)	applicable country Not released yet
	placeOfBirth (String)	place of birth Not released yet
	dateOfIssue (String)	date of issue Not released yet
	residenceCountryCode (String)	residence country code Not released yet
	expiryDate (String)	expiry date Not released yet

Contact	(JsonObject)	This tag encloses contact
PostalAddress	label (JsonObject)
	street (String)
	postalCode (String)
	cityName (String)
	countryCode (String)
	contactsProvided (String)
	emailAddress (String)
Phone	(JsonObject)
	label (String)
	countryCode (String)
	phoneNumber (String)

hotelRequests	(JsonObject)
	ssr (StringArray)


voucherDocuments	(JsonObject)	This tag encloses the voucher specific information of booking.This information is needed to show on voucher.
	hotelConfirmationNumber (String)	Most of the cases this will be available only for Booking retrieve call.
	status (String)

roomBookingInfo	(JsonObject)
	roomIndex (String)
	status (String)

essentialNotes	(JsonObject)	This tag encloses the remark for room. This is mandatory information which must be displayed to the end user before booking and voucher also.
	name (String)
	isMandatory (String)
	description (String)

hotel book retrieve response
{
  "meta": {
  "success": true,
  "statusCode": "",
  "statusMessage": "",
  "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 'bookingKey' can't be blank",
      "value": "Field 'bookingKey' can't be blank",
      "source": {
        "field": "bookingKey",
        "pointer": "/HotelSearchCriteria/city"
      },
      "title": "Required field",
      "type": "validation_error"
    }
  ],
  "commonData": {
    "productCode": "string",
    "culture": "string"
  },

  "data": {
    "bookingReferenceId": "BKR-2022-000012",
    "clientReference":"OTA-2022-is1522",
    "supplierReferenceId": "ABCDEF",
    "bookingStatus":"Confirmed",
    "transactionDate":"YYYY-MM-DD",
    "hotel": {
      "hotelKey": "fb0920a8-70b8-433a-a8e2-a8e32efeae5640htr00000000",
      "name": "caesarsPalaceBluewatersDubai",
      "totalNet": 6099.71,
      "currency": "AED",
      "checkInDate": "YYYY-MM-DD",
      "checkOutDate": "YYYY-MM-DD",
      "rooms": [
        {
          "roomIndex": "1",
          "roomKey": "fb0920a8-70b8-433a-a8e2-a8e32efeae5640htr00000001rcmb00000000",
          "roomId": "38_1",
          "ruleInfo": "38",
          "roomTypeName": "standard",
          "roomTypeDesc": "standard",
          "bedType": "double",
          "roomView": "mountainView",
          "maxOccupancy": 2,
          "sizeMeasurement": "275Sqm",
          "passengerMandatoryData": {
            "isEmailId": true,
            "isPAN": true,
            "isPassport": true,
            "isPhoneNo": true
          },
          "ratePlan": {
            "supplierCode": "1",
            "meal": "roomOnly",
            "availableStatus": "available",
            "cancelPolicyIndicator": "refundable",
            "code": "76-1360717",
            "isPackage": false,
            "fixedCombinations": true,
            "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",
            "subSupplierCode": "NCEPF3141",
            "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"
            }
          ]
        }

      ]
    },
    "financialInfo": {
      "tmc": "VE",
      "supplier": "Hotelbed",
      "subSupplierCode": "NCEPF3141",
      "payment": {
        "paymentTypes": "CARD,CR",
        "paymentNetwork": "DS,CA,DC,VI,AX"
      },
      "additionalProperties": [
        {
          "key": "key1",
          "value": "value1",
          "description": "description"
        },
        {
          "key": "key1",
          "value": "value1",
          "description": "description"
        }
      ]
    },
    "passengers": [
      {
        "passengerKey": "1",
        "isLead": true,
        "ptc": "ADT",
        "roomIndex": 1,
        "combId": "605468d722722a-acc0-4025-b2e5-f409b6a452ae40htr00000000rcmb00000000",
        "passengerInfo": {
          "birthDate": "YYYY-MM-DD",
          "gender": "Male",
          "nameTitle": "DR",
          "givenName": "TEST",
          "middleName": "Test",
          "surname": "ONE"
        },
        "loyaltyProgramAccount": [
          {
            "accountNumber": 20372591
          },
          {
            "providerName": "Avios",
            "accountNumber": 20372591,
            "tierCode": "GOLD"
          },
          {
            "airlineDesignator": "BA",
            "programName": "On Business",
            "accountNumber": "OB372591"
          }
        ],
        "identityDocuments": [
          {
            "idDocumentNumber": "12345678V",
            "idType": "PAN",
            "isCorporatePAN": false
          },
          {
            "idDocumentNumber": "12345678V",
            "idType": "VI",
            "issuingCountryCode": "GBR",
            "applicableCountry": "IND",
            "placeOfBirth": "IND",
            "dateOfIssue": "YYYY-MM-DD"
          },
          {
            "idDocumentNumber": "XYZ123456",
            "idType": "AEA",
            "issuingCountryCode": "USA",
            "residenceCountryCode": "IND",
            "expiryDate": "YYYY-MM-DD"
          }
        ],
        "contact": {
          "postalAddress": {
            "label": "AddressAtDestination",
            "street": [
              "Beeches Apartment",
              "200 Lampton Road"
            ],
            "postalCode": "TW345RT",
            "cityName": "NYK",
            "countryCode": "USA"
          },
          "contactsProvided": [
            {
              "emailAddress": [
                "AA@BA.COM"
              ],
              "phone": [
                {
                  "label": "Origin",
                  "areaCode": 44,
                  "phoneNumber": 2087385301
                }
              ]
            }
          ]
        },
        "hotelRequests": {
          "ssr": [
            {
              "text": "COT required"
            }
          ]
        },
        "additionalProperties": [
          {
            "key": "key1",
            "value": "value1",
            "description": "description"
          },
          {
            "key": "key1",
            "value": "value1",
            "description": "description"
          }
        ]
      }
    ],
    "voucherDocument":[
      {
      "hotelConfirmationNumber": "BKR-2023-005185/3003201",     
      "roomBookingInfo": [
        {
          "roomIndex": 1,
          "status": "Confirmed"
        },
        {
          "roomIndex": 2,
          "status": "Confirmed"
        }
      ],
      "essentialNotes": [
        {
          "name": "",
          "isMandatory": false,
          "description": "description"
        }
      ],
      "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"
      }
    ]
  }
}