Attention: Please check the Hotel Release Notes page for the latest updates and enhancements.
Hotel Standard Availability API Reference
|
POST |
availability/catalogofferingshospitality Base path: Pre-production https://api.pp.travelport.com/11/hotel/ Production https://api.travelport.com/11/hotel/ |
Related Content: Hotel Guide, Hotel Workflow Diagram
Hotel Availability returns room types and rates available at one or more specified properties on specified dates.
Request
Also see Authorization and Common Hotel API Headers.
Query Parameters
None.
Request Body
Show Request Body Table
|
Object |
Description |
Required/Optional |
|---|---|---|
|
CatalogOfferingsQueryRequest |
Top level object. |
Required |
|
CatalogOfferingsRequest |
Top level object. Includes StayDates and HotelSearchCriterion objects. |
Required |
|
Code for currency to display results in. If sent, the response includes a currency rate conversion value for the currency specified. This value can be applied to the hotel's local pricing. |
Optional |
|
Supports a timeout in milliseconds when requesting availability for multiple properties. If sent, the request times out at the specified time and returns all properties retrieved at that point. |
Optional |
|
Boolean: true disables the grouping of common property details in the response's ReferenceList object and instead returns them for each property in Offer/Products/Product. If sent with false or not sent, common details are returned in ReferenceList. |
Optional If not sent default is false |
|
StayDates |
Check-in and -out dates. |
Required |
|
String. Check-in date in YYYY-MM-DD format. |
Required |
|
String. Check-out date in YYYY-MM-DD format. |
Required |
|
HotelSearchCriterion |
Top level object for hotel search data. Includes RateCandidates, PropertyRequest, and RoomStayCandidates objects. |
Required |
|
Number. Supports values 1-9 inclusive. Number of rooms requested at a single property. |
Required |
|
Restrict the search to a specific aggregator. Accepted values are:
User must be authorized for any aggregator selected. |
Optional |
|
RateCandidates |
Rate plans, access codes, and rate categories. Send only if requesting rate plans. Includes RateCandidate object. |
Optional |
|
Boolean: true returns only pre-paid rates; false allows the return of all rates. A prepay rate charges the full amount on the credit card immediately on booking.
|
Optional |
|
Boolean: true returns only post-paid rates; false allows the return of all rates. A postpay rate (most common in the US) charges the credit card at the property when the guest checks in.
|
Optional |
|
Boolean (true/false). Used to request the removal of rate category (Promotional/Package/etc.) rates that may have been returned by the supplier as typical published rates.
|
Optional |
|
RateCandidate |
Rate plan details, if requesting. Send one instance of RateCandidate for each rate plan to request. The values required differ according to whether you are sending a negotiated rate code or a rate category. |
Optional |
|
One or more negotiated rate codes. Each rateCode must be associated with a chainCode per below.
|
Required for negotiated rate code N/A for rate category |
|
Send a supported value of Multi-level/Negotiated/Secure for negotiated rate code. For a rate category, send one or up to 8 rate categories to search for, such as Weekend or Government. If the supplier has rates available for the requested category, the response contains those rates and indicates them as such. Note that some properties do not return these rates unless explicitly requested. Categories are spelled for readability in this document. Please consult the swagger file for exact spelling. Travelport translates the category of “All” into the category set of Promotional, Package, Senior Citizen, Family Plan, Weekend, Association, Corporate, Government. Supported values are as follows:
|
Optional Required for rate category |
|
ID of the rate plan associated with the negotiated rate. |
Optional; will be added automatically if missing |
|
Chain code for the property. |
Required for negotiated rate code Optional for rate category |
|
Code for the property within the hotel chain. |
Required for negotiated rate code Optional for rate category |
|
PropertyRequest |
Property details for each property requested, up to 10 properties. Send a separate instance of PropertyRequest for each property. Includes PropertyKey object. |
Required |
|
PropertyKey |
Chain and property codes. |
Required |
|
String. Chain code for the property. |
Required |
|
String. Property code for the property. |
Required |
|
RoomStayCandidates |
Top level object for traveler information. Includes RoomStayCandidate object. |
Required |
|
RoomStayCandidate |
Top level object. Includes GuestCounts object. |
Required |
|
GuestCounts |
Top level object. Includes GuestCount object. |
Required |
|
GuestCount |
Guest count and age(s). |
Required |
|
Number. Number of travelers. |
Required |
|
String. Required only if traveler age is relevant to a code. Adult code: 10 Child code: 8 |
Optional |
|
String. Age of traveler. Required only when request includes a child in room. |
Optional |
|
CustomerLoyalty |
String. One frequent guest number. |
Optional |
|
String. Two character hotel supplier code or brand code of the loyalty program for frequent guest use. Two character air supplier code of loyalty program for frequent flyer use. |
Optional |
|
String. Number on loyalty card. |
Optional |
Response
Show Response Body Table
Top level objects
The top level objects in the Availability response are listed below. For details see the individual tables following.
|
Object |
Description |
|---|---|
|
CatalogOfferingsHospitalityResponse |
Top level object for response. Key value pair:
Includes CatalogOfferings and CurrencyRateConversion objects. Includes ReferenceList object unless verboseResponseInd was set to true to disable consolidating common property information. |
|
CatalogOfferings |
Top level object that groups all offers in the response. In the hotel APIs an offer is a unique rate for one bookable room at specified terms and conditions. Key value pairs:
Includes CatalogOffering object. |
|
CatalogOffering |
Array. Each instance returns information related to one bookable room. Key value pair:
Includes the Identifier, ProductOptions, Price, and TermsAndConditions objects. Each instance of CatalogOffering object returns a unique rate. A response returns a maximum of 100 rates. The first rate in the list is the single lowest rate returned no matter how many aggregators respond. The remaining rates are grouped in the order of rates returned from Travelport, rates returned from Booking.com, and rates returned from Expedia.
|
|
Identifier |
Defines which supplier system returned that specific room rate (offer). Key value pair:
Booking.com and Expedia access require additional provisioning and a direct agreement with the supplier. Contact your Travelport account manager for details.
|
|
ProductOptions |
Top level object. Includes Product object. See table below. |
|
Price |
Price details for the room in this this offer. See table below. |
|
TermsAndConditions |
The terms and conditions applicable to this offer. See table below. |
|
CurrencyRateConversion |
Returned when a target currency type is requested by sending requestedCurrency. See table below. |
|
ReferenceList |
Returned by default to consolidate common property details. See table below. |
CatalogOffering/ProductOptions/Product object
| Object | Description |
|---|---|
|
Product |
Array. One instance for each product, type ProductHospitality. Product is a common object in the model. Not all objects in this table may be returned in this specific API. Key value pairs:
Includes PropertyKey, PropertyAddress, RoomType, and DateRange objects. |
|
PropertyKey |
When ReferenceList is returned, PropertyKey includes the key value pairs:
|
|
PropertyAddress |
Top level property address object. |
|
Address |
Property address. Key value pairs:
Includes AddressLine, StateProv, and Country objects. |
|
AddressLine |
Text string for property street address. |
|
StateProv |
Property state or province. Key value pair:
|
|
Country |
Property country. Key value pairs:
|
|
RoomType |
Room type detail. Includes RoomCharacteristics, Description, and RoomAmenity objects. |
|
RoomCharacteristics |
Room details. Key value pairs:
Includes BedConfiguration object. |
|
BedConfiguration |
Configuration of bed(s) in room. Key value pairs:
|
|
Description |
A room description text string. Key value pairs:
|
|
RoomAmenity |
Room amenity name and description. Key value pairs:
|
|
RoomOccupancy |
Room occupancy value. Key value pair:
|
|
DateRange |
Check-in and -out dates. Key value pairs:
|
CatalogOffering/Price object
| Object | Description |
|---|---|
|
Price |
Price details for this offer or rate. Price is a common object in the model. Not all objects in this table may be returned in this specific API. Key value pairs:
Includes CurrencyCode and PriceBreakdown objects. |
|
CurrencyCode |
The currency code the amount is provided in. Key value pairs:
|
|
PriceBreakdown |
The information returned in PriceBreakdown can vary by provider and location. Key value pairs:
If roomPricingType = Per night,
If roomPricingType = Per stay,
|
|
NightlyRate |
Rate per night. Key value pairs:
Includes Amount object. If the nightly rate changes during the stay, multiple NightlyRate objects are returned.
|
|
Amount |
The rate amount. Key value pairs:
Includes CurrencyCode (see above), Taxes, and Fees objects. |
|
Taxes |
Tax details.
Includes Tax and TaxPercent objects. |
|
Tax |
Breakdown of the tax. Key value pairs:
|
|
TaxPercent |
Returned when the tax is expressed as a percentage of the amount. Key value pairs:
|
|
Fees |
Parent object which can include Fee by rate or by property. Travelport defines fees as any extra payment due at the property. Key value pair:
Includes Fee object. |
|
Fee |
Fee details. Key value pairs:
Includes FeeAmountOrPercent object. |
|
FeeAmountOrPercent |
Object defining the amount or percent charged as a fee. Key value pairs:
|
|
Commission |
Commission details. Key value pairs: When returned with type: CommissionPercent:
When returned with type: CommissionAmount
|
|
AverageNightlyRate |
The average nightly rate of the request. Key value pairs:
|
|
AmenitySurcharges |
Amenity surcharges detail. Includes Surcharge object. |
|
Surcharge |
Additional charges related to requested amenities. Key value pairs:
|
CatalogOffering/TermsAndConditions object
|
Object |
Description |
|---|---|
|
TermsAndConditions |
The terms and conditions applicable to this offer CatalogOffering. Key value pairs:
Depending on details returned from supplier, may include Guarantee, CancelPenalty, DepositPolicy, AcceptedCreditCard, Description, MealsIncluded, and ProductRateCodeInfo objects. |
|
Guarantee |
If returned by the provider, Guarantee indicates whether payment is required to hold the room. Key value pairs:
|
|
CancelPenalty |
Cancellation penalty details. Key value pair:
Includes Deadline and HotelPenalty objects. CancelPenalty is an array. When there is a refundable period and a non-refundable period for a rate, there will be two instances of information to designate the Deadline and HotelPenalty differences. |
|
Deadline |
Cancellation penalty deadline details. Key value pair:
Includes SpecificDate object. |
|
SpecificDate |
Details on cancellation penalty. Key value pairs:
|
|
HotelPenalty |
Cancellation penalty amount. Key value pairs: If returned with type: HotelPenaltyNights
If returned with type: HotelPenaltyPercent
If returned with type: HotelPenaltyAmount
|
|
DepositPolicy |
If returned by the provider, DepositPolicy indicates whether a deposit is required to hold the room. Includes the Deposit object. |
|
Deposit |
Deposit amount in relation to TotalPrice. Key value pairs: CurrencyAmount: Three-character currency code. value: Deposit amount. remainderInd: true or false indicating if a deposit was part of the total price. |
|
AcceptedCreditCard |
A list of accepted credit cards. Key value pair:
|
|
Description |
Free-form text for a room and rate description. This duplicates the room description in RoomType and the rate description in Price and will be removed in a future release. |
|
MealsIncluded |
The following meal attributes are returned with a value of true if applicable:
|
|
ProductRateCodeInfo |
Top level object for rate code details if applicable to this offer. Includes RateCodeInfo object. |
|
RateCodeInfo |
Rate code information for this offer, if applicable. Key value pairs:
|
|
RatePaymentInfo |
They type of rate for this offer. Possible values are:
|
CurrencyRateConversion object
| Object | Description |
|---|---|
|
CurrencyRateConversion |
CurrencyRateConversion is returned only if requestedCurrency was sent in the request. By default the Hotel APIs return all rates in the currency of the hotel's location. If requestedCurrency was sent in the request, the response returns currency conversion information per below. Includes SourceCurrency, TargetCurrency, and ConversionRate objects. |
|
SourceCurrency |
The currency code based on the location of the hotel and used for all rates in the response. Key value pairs:
|
|
TargetCurrency |
Currency code sent in the request in requestedCurrency. Key value pairs:
|
|
ConversionRate |
Current conversion rate of the user-specified currency (the TargetCurrency value). Key value pair:
|
ReferenceList object
|
Object |
Description |
|---|---|
|
ReferenceList |
Returned by default to consolidate common property details. Not returned if verboseResponseInd was set to true in the request. Includes the PropertyDates object. |
|
PropertyDates |
Key value pairs:
Includes the PropertyKey, Address, GeoLocation, and DateRange objects |
|
PropertyKey |
When ReferenceList is returned per above, PropertyKey is returned. Key value pairs:
|
|
Address |
Property address. Key value pairs:
Includes AddressLine, StateProv, and Country objects. |
|
AddressLine |
Text string for property street address. |
|
StateProv |
Property state or province. |
|
Country |
Property country. Key value pairs:
|
|
GeoLocation |
Geographic coordinates of the property. Key value pairs:
|
|
DateRange |
Check-in and -out dates. Key value pairs:
|
Error object
|
Object |
Description |
|---|---|
|
Result |
Top level object when an error is returned. Includes the Error object. |
|
Error |
An array of error information returned at the property level for a response. Key value pairs: Message: Error text usually presented to end user. StatusCode: Error code usually presented to end user. Includes the NameValuePair object. |
|
NameValuePair |
Further details describing error response. Key value pairs:
Code snippet
"CatalogOfferingsHospitalityResponse": {
"@type": "CatalogOfferingsHospitalityResponse",
"Result": {
"@type": "Result",
"Error": [
{
"@type": "ErrorDetail",
"Message": "No Room Stays/Rate Plans received from any provider",
"NameValuePair": [
{
"name": "ChainCode",
"value": "PT"
},
{
"name": "PropertyCode",
"value": "E5355"
},
{
"name": "MessageDetail",
"value": "No Room Stays/Rate Plans received from the provider"
},
{
"name": "MessageDetail",
"value": "Hotel requested not available"
}
],
"StatusCode": 404
}
]
},
|
Example Request
Show Example Request
{
"CatalogOfferingsQueryRequest": {
"CatalogOfferingsRequest": [
{
"verboseResponseInd": true,
"@type": "CatalogOfferingsRequestHospitality",
"StayDates": {
"start": "2022-11-19",
"end": "2022-11-20"
},
"HotelSearchCriterion": {
"numberOfRooms": 1,
"@type": "HotelSearchCriterion",
"PropertyRequest": [
{
"@type": "PropertyRequest",
"PropertyKey": {
"propertyCode": "02772",
"chainCode": "HH",
"@type": "PropertyKey"
}
},
{
"PropertyKey": {
"propertyCode": "66338",
"chainCode": "PS",
"@type": "PropertyKey"
}
}
],
"RoomStayCandidates": {
"@type": "RoomStayCandidates",
"RoomStayCandidate": [
{
"@type": "RoomStayCandidate",
"GuestCounts": {
"@type": "GuestCounts",
"GuestCount": [
{
"ageQualifyingCode": "10",
"count": 1,
"@type": "GuestCount"
},
{
"ageQualifyingCode": "8",
"count": 1,
"age": 5,
"@type": "GuestCount"
},
]
}
}
]
}
}
}
]
}
}
Example Response
The following example Availability response has been edited for brevity to return four instances of CatalogOfferingHospitality; each instance is one offer, or rate. A typical Availability response returns more instances.
Show Example Response
{
"CatalogOfferingsHospitalityResponse": {
"transactionId": "31601a88-4bdd-4b6a-adba-37ae551b71ab",
"CatalogOfferings": {
"CatalogOffering": [
{
"type": "CatalogOfferingHospitality",
"id": "855d81ce-dadf-43b9-8b00-73efe658df5b",
"Identifier": {
"authority": "BKNG"
},
"ProductOptions": [
{
"Product": [
{
"type": "ProductHospitality",
"bookingCode": "147245304_298459072_2_2_0",
"Quantity": 2,
"PropertyKey": {
"chainCode": "CN",
"propertyCode": "B6381"
},
"RoomType": {
"type": "RoomTypeDetail",
"RoomCharacteristics": {
"smokingAllowed": "No",
"wifiIncluded": "No",
"BedConfiguration": [
{
"quantity": 1,
"bedType": "King",
"size": "131-150 cm wide"
}
]
},
"Description": {
"value": "King Room. This room is equipped with a king bed accessible room specially designed who need additional space and amenities with smart controls. Unwind in the spacious five fixture bathroom with a roll-in shower, lowered basin and support handles. Use the bedside sensor touch panel to operate lights and open curtains"
},
"RoomAmenity": [
{
"description": "Tea/Coffee maker",
"code": "19",
"includedInd": true
},
{
"description": "Shower",
"code": "142",
"includedInd": true
}
],
"RoomOccupancy": [
{
"maxOccupancy": 2
}
]
},
"DateRange": {
"start": "2021-10-22",
"end": "2021-10-25"
}
}
]
}
],
"Price": {
"type": "PriceDetail",
"CurrencyCode": {
"value": "INR"
},
"Base": 25200,
"TotalTaxes": 4536,
"TotalPrice": 29736,
"PriceBreakdown": [
{
"type": "PriceBreakdownHospitality",
"roomPricingType": "Per stay",
"Amount": {
"CurrencyCode": {
"value": "INR"
},
"Base": 25200,
"Taxes": {
"type": "TaxesDetail",
"Tax": [
{
"currencyCode": "INR",
"taxCode": "VAT",
"includedInBase": "No",
"value": 4536
}
]
},
"Total": 29736
},
"Commission": {
"type": "CommissionAmount",
"application": "Non-paying",
"Amount": {
"code": "INR",
"value": 0
}
},
"Description": "King Room - Mobility Accessible - Free cancellation - Booking.com rate"
},
{
"type": "PriceBreakdownHospitality",
"roomPricingType": "Per night",
"AverageNightlyRate": [
{
"code": "INR",
"approximateInd": true,
"value": 8400
}
]
}
]
},
"TermsAndConditions": {
"type": "TermsAndConditionsHospitality",
"Guarantee": [
{
"GuaranteeType": "PrepayRequired"
}
],
"CancelPenalty": [
{
"Deadline": {
"SpecificDate": {
"start": "2021-09-27",
"end": "2021-10-19"
},
"Time": "23:59:59"
},
"HotelPenalty": {
"type": "HotelPenaltyAmount",
"Amount": [
{
"code": "INR",
"value": 0
}
]
},
"Refundable": "Yes"
},
{
"Deadline": {
"SpecificDate": {
"start": "2021-10-20",
"end": "2021-10-21"
},
"Time": "23:59:59"
},
"HotelPenalty": {
"type": "HotelPenaltyAmount",
"Amount": [
{
"code": "INR",
"value": 8400
}
]
},
"Refundable": "No"
}
],
"RatePaymentInfo": "PrePay"
}
},
{
"type": "CatalogOfferingHospitality",
"id": "c825ff99-5443-4453-ab4e-28ede96558b8",
"Identifier": {
"authority": "TVPT"
},
"ProductOptions": [
{
"Product": [
{
"type": "ProductHospitality",
"bookingCode": "A00A0N",
"PropertyKey": {
"chainCode": "CN",
"propertyCode": "B6381"
},
"RoomType": {
"type": "RoomTypeDetail",
"RoomCharacteristics": {
"viewCode": "Various Views",
"smokingAllowed": "No"
},
"RoomAmenity": [
{
"description": "Air conditioning",
"code": "2",
"includedInd": true
}
]
},
"DateRange": {
"start": "2021-10-22",
"end": "2021-10-25"
}
}
]
}
],
"Price": {
"type": "PriceDetail",
"CurrencyCode": {
"value": "INR"
},
"Base": 22780,
"TotalTaxes": 4100.4,
"TotalPrice": 26880.4,
"PriceBreakdown": [
{
"type": "PriceBreakdownHospitality",
"roomPricingType": "Per night",
"priceChangesDuringStayInd": false,
"NightlyRate": [
{
"startDate": "2021-10-22",
"nights": 3,
"Amount": {
"CurrencyCode": {
"value": "INR"
},
"Base": 7593.33
}
}
],
"AverageNightlyRate": [
{
"code": "INR",
"approximateInd": true,
"value": 7593.33
}
]
},
{
"type": "PriceBreakdownHospitality",
"roomPricingType": "Per stay",
"Commission": {
"type": "CommissionPercent",
"application": "Commissionable",
"Percent": 10
},
"Base": 22780,
"TotalTaxes": 4100.4,
"Total": 26880.4
}
]
},
"TermsAndConditions": {
"type": "TermsAndConditionsHospitality",
"Guarantee": [
{
"GuaranteeType": "GuaranteeRequired"
}
],
"CancelPenalty": [
{
"@type": "CancelPenalty",
"Deadline": {
"@type": "Deadline",
"SpecificDate": {
"start": "2021-10-19",
"end": "2021-10-22"
},
"Time": "16:00:00"
},
"HotelPenalty": {
"@type": "HotelPenaltyAmount",
"Amount": [
{
"code": "INR",
"value": 0
}
]
},
"Refundable": "Yes"
},
{
"@type": "CancelPenalty",
"Deadline": {
"@type": "Deadline",
"SpecificDate": {
"start": "2021-10-22",
"end": "9999-12-31"
},
"Time": "16:00:00"
},
"HotelPenalty": {
"@type": "HotelPenaltyNights",
"Nights": 1
},
"Refundable": "No"
}
],
"Description": [
"GOVERNMENT RATE ON DUTY TRAVEL",
"KING DELUXE ROOM",
"42 SQM/WIFI/MINIBAR/DESK/SOAKTUB"
],
"RatePaymentInfo": "PostPay"
}
},
{
"type": "CatalogOfferingHospitality",
"id": "18c8d982-c695-4d11-b2b8-b7b476cfa82d",
"Identifier": {
"authority": "EXPE"
},
"ProductOptions": [
{
"Product": [
{
"type": "ProductHospitality",
"bookingCode": "3f360eb5-2859-4b60-b60e-b52859cb6062:201285595:380081723:P:37321",
"Quantity": 2,
"PropertyKey": {
"chainCode": "CN",
"propertyCode": "B6381"
},
"RoomType": {
"type": "RoomTypeDetail",
"RoomCharacteristics": {
"BedConfiguration": [
{
"quantity": 1,
"bedType": "KingBed",
"size": "King"
}
]
},
"Description": {
"value": "King Room, Room, 1 King Bed, Accessible"
},
"RoomAmenity": [
{
"description": "Free self parking",
"code": "0",
"includedInd": true
},
{
"description": "Free WiFi",
"code": "123",
"includedInd": true
}
]
},
"DateRange": {
"start": "2021-10-22",
"end": "2021-10-25"
}
}
]
}
],
"Price": {
"type": "PriceDetail",
"CurrencyCode": {
"value": "INR"
},
"Base": 26700,
"TotalTaxes": 4806,
"TotalPrice": 31506,
"PriceBreakdown": [
{
"type": "PriceBreakdownHospitality",
"roomPricingType": "Per night",
"NightlyRate": [
{
"startDate": "2021-10-22",
"nights": 3,
"Amount": {
"CurrencyCode": {
"value": "INR"
},
"Base": 8900,
"Taxes": {
"type": "TaxesDetail",
"Tax": [
{
"currencyCode": "INR",
"taxCode": "tax_and_service_fee",
"includedInBase": "No",
"value": 1602
}
]
}
}
}
],
"AverageNightlyRate": [
{
"code": "INR",
"approximateInd": true,
"value": 8900
}
]
},
{
"type": "PriceBreakdownHospitality",
"roomPricingType": "Per stay",
"Amount": {
"CurrencyCode": {
"value": "INR"
},
"Base": 26700,
"TotalTaxes": 4806,
"Total": 31506
},
"Description": "Best available rate deposit required"
}
]
},
"TermsAndConditions": {
"type": "TermsAndConditionsHospitality",
"Guarantee": [
{
"GuaranteeType": "DepositRequired"
}
],
"CancelPenalty": [
{
"@type": "CancelPenalty",
"Deadline": {
"@type": "Deadline",
"SpecificDate": {
"start": "2021-10-19",
"end": "2021-10-22"
},
"Time": "16:00:00"
},
"HotelPenalty": {
"@type": "HotelPenaltyAmount",
"Amount": [
{
"code": "INR",
"value": 0
}
]
},
"Refundable": "Yes"
},
{
"@type": "CancelPenalty",
"Deadline": {
"@type": "Deadline",
"SpecificDate": {
"start": "2021-10-22",
"end": "9999-12-31"
},
"Time": "16:00:00"
},
"HotelPenalty": {
"@type": "HotelPenaltyNights",
"Nights": 1
},
"Refundable": "No"
}
],
"MealsIncluded": {
"breakfastInd": true
},
"ProductRateCodeInfo": [
{
"RateCodeInfo": {
"rateID": "380081723"
}
}
],
"RatePaymentInfo": "PrePay"
}
},
{
"type": "CatalogOfferingHospitality",
"id": "f13c858d-d68d-496a-81ee-8982d7f72dee",
"Identifier": {
"authority": "BKNG"
},
"ProductOptions": [
{
"Product": [
{
"type": "ProductHospitality",
"bookingCode": "304096402_115195368_2_41_0",
"Quantity": 5,
"PropertyKey": {
"chainCode": "CY",
"propertyCode": "E4446"
},
"RoomType": {
"type": "RoomTypeDetail",
"RoomCharacteristics": {
"smokingAllowed": "No",
"wifiIncluded": "No",
"BedConfiguration": [
{
"quantity": 1,
"bedType": "King",
"size": "181-210 cm wide"
}
]
},
"Description": {
"value": "Deluxe King Room with City View with 24 Hrs Check-in & Check-out. Our cleverly designed deluxe rooms are the perfect setting to take a break and re-energize your senses before you start your day with high speed internet access, Flat screen led television with a wide selection of International HD channels, well lit work stations, and I-home docking system to help you succeed at your game."
},
"RoomAmenity": [
{
"description": "Tea/Coffee maker",
"code": "19",
"includedInd": true
},
{
"description": "TV",
"code": "251",
"includedInd": true
}
],
"RoomOccupancy": [
{
"maxOccupancy": 2
}
]
},
"DateRange": {
"start": "2021-10-22",
"end": "2021-10-25"
}
}
]
}
],
"Price": {
"type": "PriceDetail",
"CurrencyCode": {
"value": "INR"
},
"Base": 17650,
"TotalTaxes": 2118,
"TotalPrice": 19768,
"PriceBreakdown": [
{
"type": "PriceBreakdownHospitality",
"roomPricingType": "Per stay",
"Amount": {
"CurrencyCode": {
"value": "INR"
},
"Base": 17650,
"Total": 19768,
"Taxes": {
"type": "TaxesDetail",
"Tax": [
{
"currencyCode": "INR",
"taxCode": "VAT",
"includedInBase": "No",
"value": 2118
}
]
}
},
"Commission": {
"type": "CommissionAmount",
"application": "Non-paying",
"Amount": {
"code": "INR",
"value": 0
}
},
"Description": "Deluxe King Room with City View with 24 Hrs Check-in & Check-out - Free cancellation - Breakfast included in the price - Booking.com rate"
},
{
"type": "PriceBreakdownHospitality",
"roomPricingType": "Per night",
"AverageNightlyRate": [
{
"code": "INR",
"approximateInd": true,
"value": 5883.33
}
]
}
]
},
"TermsAndConditions": {
"type": "TermsAndConditionsHospitality",
"Guarantee": [
{
"GuaranteeType": "GuaranteeRequired"
}
],
"CancelPenalty": [
{
"Deadline": {
"SpecificDate": {
"start": "2021-09-27",
"end": "2021-10-21"
},
"Time": "23:59:59"
},
"HotelPenalty": {
"type": "HotelPenaltyAmount",
"Amount": [
{
"code": "INR",
"value": 0
}
]
},
"Refundable": "Yes"
},
{
"Deadline": {
"SpecificDate": {
"start": "2021-10-22",
"end": "9999-12-31"
},
"Time": "23:59:59"
},
"HotelPenalty": {
"type": "HotelPenaltyAmount",
"Amount": [
{
"code": "INR",
"value": 5883.33
}
]
}
}
],
"MealsIncluded": {
"breakfastInd": true
},
"RatePaymentInfo": "PostPay"
}
}
]
},
"CurrencyRateConversion": [
{
"SourceCurrency": {
"decimalPlace": 2,
"value": "INR"
},
"TargetCurrency": {
"decimalPlace": 2,
"value": "EUR"
},
"ConversionRate": {
"value": 0.0113606052
}
},
{
"SourceCurrency": {
"decimalPlace": 2,
"value": "JPY"
},
"TargetCurrency": {
"decimalPlace": 2,
"value": "EUR"
},
"ConversionRate": {
"value": 0.170409
}
}
]
}
}If the Availability request has CatalogOfferingsRequest with verboseResponseInd=false or no verboseReponseInd is sent, common details are returned in ReferenceList.
Show Example Response
{
"CatalogOfferingsHospitalityResponse": {
"@type": "CatalogOfferingsHospitalityResponse",
"transactionId": "hotelts-v11",
"CatalogOfferings": {
"@type": "CatalogOfferings",
"CatalogOffering": [
{
"type": "CatalogOfferingHospitality",
"id": "a3a060e1-02fe-47da-9c9b-1d308cf8a62e:e4deec58-f435-4f9f-91dc-ea3978200c4a",
"Identifier": {
"authority": "TVPT"
},
"ProductOptions": [
{
"type": "ProductOptions",
"Product": [
{
"type": "ProductHospitalityOffer",
"propertyDatesRef": "ea741dfa-9ed9-4085-b41d-fa9ed900857a",
"bookingCode": "AJSS23",
"Quantity": 1,
"RoomType": {
"type": "RoomType",
"RoomCharacteristics": {
"type": "RoomCharacteristics",
"viewCode": "Various Views",
"BedConfiguration": [
{
"bedType": "3"
}
]
},
"Description": {
"value": "1 King Bed Sofa Bed Fridge Microwave 340 Square Feet Free WiFi Free Airport Shuttle"
},
"RoomAmenity": [
{
"type": "RoomAmenity",
"description": "AM/FM radio",
"code": "5",
"includedInd": true
},
{
"type": "RoomAmenity",
"description": "Tea/Coffee maker",
"code": "19",
"includedInd": true
},
{
"type": "RoomAmenity",
"description": "Microwave",
"code": "68",
"includedInd": true
},
{
"type": "RoomAmenity",
"description": "Cable channels",
"code": "18",
"includedInd": true
},
{
"type": "RoomAmenity",
"description": "Sofa",
"code": "270",
"includedInd": true
}
]
}
}
]
}
],
"Price": {
"type": "PriceDetail",
"CurrencyCode": {
"value": "USD"
},
"Base": 136,
"TotalTaxes": 23.46,
"TotalFees": 0,
"TotalPrice": 159.46,
"PriceBreakdown": [
{
"type": "PriceBreakdownHospitality",
"roomPricingType": "Per night",
"NightlyRate": [
{
"type": "NightlyRate",
"startDate": "2022-05-19",
"nights": 1,
"Amount": {
"type": "Amount",
"CurrencyCode": {
"value": "USD"
},
"Base": 136
}
}
],
"AverageNightlyRate": [
{
"code": "USD",
"approximateInd": true,
"value": 136
}
]
},
{
"type": "PriceBreakdownHospitality",
"roomPricingType": "Per stay",
"Amount": {
"type": "Amount",
"Taxes": {
"type": "TaxesDetail",
"Tax": [
{
"currencyCode": "USD",
"taxCode": "17",
"includedInBase": "Unknown",
"value": 23.46
}
],
"TaxPercent": {
"taxCode": "27",
"includedInBase": "Unknown",
"value": 5
}
}
},
"Commission": {
"type": "CommissionPercent",
"application": "Commissionable",
"Percent": 10
},
"Description": "Senior Rate"
}
]
},
"TermsAndConditions": {
"type": "TermsAndConditionsHospitality",
"Guarantee": [
{
"type": "Guarantee",
"guaranteeType": "GuaranteeRequired"
}
],
"CancelPenalty": [
{
"@type": "CancelPenalty",
"Deadline": {
"@type": "Deadline",
"SpecificDate": {
"start": "2022-05-10",
"end": "2023-02-19"
},
"Time": "23:59:59"
},
"HotelPenalty": {
"@type": "HotelPenaltyAmount",
"Amount": [
{
"code": "USD",
"value": 0.00
}
]
},
"Refundable": "Yes"
},
{
"@type": "CancelPenalty",
"Deadline": {
"@type": "Deadline",
"SpecificDate": {
"start": "2023-02-19",
"end": "9999-12-31"
},
"Time": "24:00:00"
},
"HotelPenalty": {
"@type": "HotelPenaltyAmount",
"Amount": [
{
"code": "USD",
"value": 170.40
}
]
}
}
],
"AcceptedCreditCard": [
{
"value": "AX"
},
{
"value": "DC"
},
{
"value": "DS"
},
{
"value": "CA"
},
{
"value": "VI"
}
],
"Description": [
"Senior'S Rate",
"1 King Bed Sofa Bed Fridge Microwave",
"340 Square Feet Free WiFi Free Airport Shuttle"
],
"ProductRateCodeInfo": [
{
"type": "ProductRateCodeInfo",
"RateCodeInfo": {
"rateCategory": "Promotional",
"value": ""
}
}
],
"RatePaymentInfo": "PostPay"
}
},
{
"type": "CatalogOfferingHospitality",
"id": "a3a060e1-02fe-47da-9c9b-1d308cf8a62e:4bf8dae1-14b6-4539-a79e-23a9ac1bd256",
"Identifier": {
"authority": "TVPT"
},
"ProductOptions": [
{
"type": "ProductOptions",
"Product": [
{
"type": "ProductHospitalityOffer",
"propertyDatesRef": "ea741dfa-9ed9-4085-b41d-fa9ed900857a",
"bookingCode": "C2DBAR",
"Quantity": 1,
"RoomType": {
"type": "RoomType",
"RoomCharacteristics": {
"type": "RoomCharacteristics",
"viewCode": "Various Views",
"smokingAllowed": "No",
"nonSmokingInd": true
},
"Description": {
"value": "2 Double Beds 340 Square Feet Free WiFi Free Airport Shuttle"
},
"RoomAmenity": [
{
"type": "RoomAmenity",
"description": "AM/FM radio",
"code": "5",
"includedInd": true
},
{
"type": "RoomAmenity",
"description": "Tea/Coffee maker",
"code": "19",
"includedInd": true
},
{
"type": "RoomAmenity",
"description": "Iron",
"code": "55",
"includedInd": true
},
]
}
}
]
}
],
"Price": {
"type": "PriceDetail",
"CurrencyCode": {
"value": "USD"
},
"Base": 155,
"TotalTaxes": 26.74,
"TotalFees": 0,
"TotalPrice": 181.74,
"PriceBreakdown": [
{
"type": "PriceBreakdownHospitality",
"roomPricingType": "Per night",
"NightlyRate": [
{
"type": "NightlyRate",
"startDate": "2022-05-19",
"nights": 1,
"Amount": {
"type": "Amount",
"CurrencyCode": {
"value": "USD"
},
"Base": 155
}
}
],
"AverageNightlyRate": [
{
"code": "USD",
"approximateInd": true,
"value": 155
}
]
},
{
"type": "PriceBreakdownHospitality",
"roomPricingType": "Per stay",
"Amount": {
"type": "Amount",
"Taxes": {
"type": "TaxesDetail",
"Tax": [
{
"currencyCode": "USD",
"taxCode": "17",
"includedInBase": "Unknown",
"value": 26.74
}
],
"TaxPercent": {
"taxCode": "27",
"includedInBase": "Unknown",
"value": 5
}
}
},
"Commission": {
"type": "CommissionPercent",
"application": "Commissionable",
"Percent": 10
},
"Description": "Best Available Rate"
}
]
},
"TermsAndConditions": {
"type": "TermsAndConditionsHospitality",
"Guarantee": [
{
"type": "Guarantee",
"guaranteeType": "GuaranteeRequired"
}
],
"CancelPenalty": [
{
"@type": "CancelPenalty",
"Deadline": {
"@type": "Deadline",
"SpecificDate": {
"start": "2022-05-10",
"end": "2022-05-18"
},
"Time": "16:00:00"
},
"HotelPenalty": {
"@type": "HotelPenaltyAmount",
"Amount": [
{
"code": "USD",
"value": 0.00
}
]
},
"Refundable": "Yes"
},
{
"@type": "CancelPenalty",
"Deadline": {
"@type": "Deadline",
"SpecificDate": {
"start": "2022-05-18",
"end": "9999-12-31"
},
"Time": "16:00:00"
},
"HotelPenalty": {
"@type": "HotelPenaltyAmount",
"Amount": [
{
"code": "USD",
"value": 170.40
}
]
},
"Refundable": "No"
}
],
"AcceptedCreditCard": [
{
"value": "AX"
},
{
"value": "DC"
},
{
"value": "DS"
},
{
"value": "CA"
},
{
"value": "VI"
}
],
"Description": [
"Best Available Rate",
"2 Double Beds",
"340 Square Feet Free WiFi Free Airport Shuttle"
],
"ProductRateCodeInfo": [
{
"type": "ProductRateCodeInfo",
"RateCodeInfo": {
"rateCategory": "RackGeneral",
"value": ""
}
}
],
"RatePaymentInfo": "PostPay"
}
},
{
"type": "CatalogOfferingHospitality",
"id": "a3a060e1-02fe-47da-9c9b-1d308cf8a62e:ef5970fc-6d10-472c-80c1-62496db2c5c9",
"Identifier": {
"authority": "EXPE"
},
"ProductOptions": [
{
"type": "ProductOptions",
"Product": [
{
"type": "ProductHospitalityOffer",
"propertyDatesRef": "884d6d4a-bc6b-454b-8d6d-4abc6b954bc0",
"bookingCode": "a68c1ad8-915b-4d97-8c1a-d8915bed97db:377432:222049030:E:37321",
"Quantity": 4,
"RoomType": {
"type": "RoomTypeDetail",
"RoomCharacteristics": {
"type": "RoomCharacteristics",
"BedConfiguration": [
{
"quantity": 1,
"bedType": "KingBed",
"size": "King"
}
]
},
"Description": {
"languages": [],
"value": "Room, 1 King Bed, Accessible, Bathtub"
}
}
}
]
}
],
"Price": {
"type": "PriceDetail",
"CurrencyCode": {
"value": "USD"
},
"Base": 238.99,
"TotalTaxes": 38.54,
"TotalPrice": 277.53,
"PriceBreakdown": [
{
"type": "PriceBreakdownHospitality",
"roomPricingType": "Per night",
"NightlyRate": [
{
"type": "NightlyRate",
"startDate": "2022-05-19",
"nights": 1,
"Amount": {
"type": "Amount",
"CurrencyCode": {
"value": "USD"
},
"Base": 238.99,
"Taxes": {
"type": "TaxesDetail",
"TotalTaxes": 38.54,
"Tax": [
{
"currencyCode": "USD",
"taxCode": "14",
"purpose": "Tax Recovery Charges and Service Fees",
"description": "Service charge",
"includedInBase": "No",
"value": 38.54
}
]
},
"Total": 277.53
}
}
],
"AverageNightlyRate": [
{
"code": "USD",
"value": 238.99
}
]
},
{
"type": "PriceBreakdownHospitality",
"roomPricingType": "Per stay",
"Amount": {
"type": "Amount",
"CurrencyCode": {
"value": "USD"
},
"Base": 238.99,
"Taxes": {
"type": "TaxesDetail",
"TotalTaxes": 38.54,
"Tax": [
{
"currencyCode": "USD",
"taxCode": "14",
"purpose": "Tax Recovery Charges and Service Fees",
"description": "Service charge",
"includedInBase": "No",
"value": 38.54
}
]
},
"Fees": {
"type": "FeesDetail",
"Fee": [
{
"type": "Fee",
"feeCode": "12",
"purpose": "Resort fee",
"description": "Resort fee",
"feeApplication": "PerAccommodation",
"feeFrequency": "PerStay",
"FeeAmountOrPercent": {
"type": "FeeAmountOrPercentAmount",
"Amount": {
"code": "USD",
"value": 45
}
}
}
]
},
"Total": 277.53
},
"Commission": {
"type": "CommissionPercent",
"application": "Commissionable"
},
"Description": "Prepay rate Refundable"
}
]
},
"TermsAndConditions": {
"type": "TermsAndConditionsHospitality",
"Guarantee": [
{
"type": "Guarantee",
"guaranteeType": "PrepayRequired"
}
],
"CancelPenalty": [
{
"@type": "CancelPenalty",
"Deadline": {
"@type": "Deadline",
"SpecificDate": {
"start": "2022-05-10",
"end": "2022-05-19"
},
"Time": "16:00:00"
},
"HotelPenalty": {
"@type": "HotelPenaltyAmount",
"Amount": [
{
"code": "USD",
"value": 0.00
}
]
},
"Refundable": "Yes"
},
{
"@type": "CancelPenalty",
"Deadline": {
"@type": "Deadline",
"SpecificDate": {
"start": "2022-05-19",
"end": "9999-12-31"
},
"Time": "16:00:00"
},
"HotelPenalty": {
"@type": "HotelPenaltyNights",
"Nights": 1
},
"Refundable": "No"
}
],
"ProductRateCodeInfo": [
{
"type": "ProductRateCodeInfo",
"RateCodeInfo": {
"rateID": "222049030",
"value": ""
}
}
],
"RatePaymentInfo": "PrePay"
}
}
]
},
"ReferenceList": [
{
"type": "ReferenceListPropertyDates",
"PropertyDates": [
{
"type": "PropertyDates",
"id": "ea741dfa-9ed9-4085-b41d-fa9ed900857a",
"adaCompliant": "Yes",
"PropertyKey": {
"type": "PropertyKey",
"chainCode": "PS",
"propertyCode": "66338"
},
"DateRange": {
"start": "2022-05-19",
"end": "2022-05-20"
}
},
{
"type": "PropertyDates",
"id": "884d6d4a-bc6b-454b-8d6d-4abc6b954bc0",
"adaCompliant": "No",
"PropertyKey": {
"type": "PropertyKey",
"chainCode": "HH",
"propertyCode": "02772"
},
"DateRange": {
"start": "2022-05-19",
"end": "2022-05-20"
}
}
]
}
]
}
}
Error Messages
Show Error Messages
|
SourceCode |
StatusCode (HTTP code) |
Message |
|---|---|---|
|
|
400 |
The number of rooms exceeds the limit of 9. |
|
|
400 |
The list of PropertyIDs exceeds the limit of 10. |
|
|
400 |
Invalid number of guests |
|
|
400 |
numberOfGuests is required |
|
|
400 |
checkindate cannot be less than currentdate. |
|
|
400 |
checkoutdate cannot be less than currentdate. |
|
|
400 |
checkoutdate cannot be less than checkindate. |
|
|
400 |
checkoutdate cannot be equal to checkindate. |
|
|
400 |
checkinDate is required |
|
|
400 |
checkoutDate is required |
|
|
400 |
Bad Request |
|
|
400 |
Chain code is a required field. |
|
|
400 |
At least one valid set of ChainCode(2 Alphabetic characters) and PropertyCode(Alphanumeric) is required. |
|
|
400 |
The Property request format should be ChainCode(2 Alphabetic characters) and PropertyCode(Between 2 and 36 Alphanumeric characters). |
|
|
400 |
The list of PropertyIDs doesn't contain at least one valid property. |
|
|
400 |
Not able to reach IDM Authorization atomic or Authorization cannot be identified due to insufficient inputs. |
|
|
400 |
Cannot parse "2021-04-32": Value 32 for dayOfMonth must be in the range [1,30] |
|
|
400 |
Cannot parse "21-16-04": Value 16 for monthOfYear must be in the range [1,12] |
|
|
400 |
Invalid format: "13-04-2021" is malformed at "21" |
|
|
400 |
Invalid format: "1234" is too short |
|
|
400 |
Chain code or property code is missing. |
|
|
400 |
Property not allowed for Multi Source Content. |
|
|
400 |
Requested property was not found |
|
|
400 |
Not a number: A |
|
|
401 |
Unauthorized Access / Invalid Credential |
|
|
401 |
Unauthorised user. |
|
|
404 |
Travelport rates are unavailable for the property. |
|
|
404 |
No Room Stays/Rate Plans received from any provider. |
|
|
404 |
Property not found. Please verify request and retry. |
|
|
404 |
Not Found |
|
|
404 |
No data available for given identifier |
|
|
500 |
Unable to process request. Exception occurred. |
|
|
500 |
Error connecting to the provider |