Hotel Availability v10 API Reference

POST

availability/v10/catalogofferingshospitality

Base path:

Pre-production https://api.apim-a.adc.pp.travelport.io/hotel/

Production https://api.apim-a.adc.prod.travelport.io/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

Object

Description

Required/Optional

CatalogOfferingsQueryRequest

Top level request object.

Required

CatalogOfferingsRequest

Top level request object.

Includes StayDates, HotelSearchCriterion.

Required

requestedCurrency

String. 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

maxResponseWaitTime

String. 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

verboseResponseInd

Boolean. When set to true, verboseResponseInd prevents the grouping of common property details in the response's ReferenceList object and instead returns them in Offer/Products/Product for each property. By default, verboseResponseInd is false, which groups these details in the ReferenceList object.

Optional

StayDates

Check-in and -out dates.

Required

start

String. Check-in date in YYYY-MM-DD format.

Required

end

String. Check-out date in YYYY-MM-DD format.

Required

specific

String. Same day check-in and -out date in YYYY-MM-DD format.

Optional

HotelSearchCriterion

Top-level object for hotel search data.

Includes rateCandidates, PropertyRequest, and RoomStayCandidates objects.

Required

numberOfRooms

Number. Number of rooms requested at a single property. Value 1-9.

Required

rateCandidates

Rate plans, access codes, and rate categories. Send only if requesting rate plans.

Optional

rateCode

String. One or more negotiated rate codes. Each rateCode must be associated with a chainCode per below.

Optional

ratePlanType

String. One or more rate categories to search for, such as Weekend or Government. If the supplier has rates available for the requested type, the response contains those rates and indicates them as such. Note that some properties do not return these rates unless explicitly requested.

Supported values and their definitions are below. Send only the number value (e.g., 1), not the definition:

1: Association

2: Club

3: Convention

4: Corporate

7: Family Plan

8: Government

9: Military

10: Multi-level/Negotiated/Secure

11: Package

12: Promotional

13: Rack General

14: Senior Citizen

15: Tour

16: Industry/Travel Agent Rate

17: Weekend

26: Multi-day Package

27: Weekly

28: Monthly

Optional

PropertyRequest

Property details for each property requested. Use a separate instance of PropertyRequest to request each property. You can request up to 10 properties.

Includes PropertyKey object.

Required

moreRatesToken

String. On second and subsequent Availability requests, it is optional to send the moreRatesToken from the previous Availability response to retrieve as many rates as returned by the provider. See above for more information.

Optional

PropertyKey

Chain and property codes.

Required

chainCode

String. Chain code for the property.

Required

propertyCode

String. Property code number.

Required

RoomStayCandidates

Top-level object for traveler information.

Includes RoomStayCandidate object.

Required

RoomStayCandidate

Top-level object for traveler information.

Includes GuestCounts object.

Required

GuestCounts

Top-level object for traveler information.

Includes GuestCount object.

Required

GuestCount

Guest count and age(s).

Required

count

Number. Number of travelers.

Required

ageQualifyingCode

String. Required only if traveler age is relevant to a code.

Optional

age

String. Age of traveler. Required only when request includes a child in room.

Optional

PseudoCity

PCC emulation is no longer supported.

Object to send for PCC emulation requested and arranged through Travelport provisioning.

Optional

value

String. The PCC to emulate.

Optional

Response

CatalogOffering objects are sorted by total price from low to high. No other preferencing is applied to how the offers are returned in the response. If you requested rates and availability based on a negotiated rate code or a specific rate category, the actual amount for these rates (if available for that property) determines where they are returned in the list of offers.
By default, common information from each room offer is consolidated into the single object ReferenceList. If the optional verboseResponseInd indicator is sent in the request, ReferenceList is not returned and common property details are not grouped. See the description for the Product object. Note that the objects in the table below display in a different order depending on whether information is grouped in ReferenceList or returned in each Product object.

Object

Description

CatalogOfferingsHospitalityResponse

Top level object for response.

Key value pair:

transactionId: Internal identifier for the response.

Includes CatalogOfferings and ReferenceList unless the verboseResponseInd was sent to disable grouping of common property information.

CatalogOfferings

Top level object.

CatalogOffering

Each instance of CatalogOffering provides information related to one bookable room.

Key value pair:

id: Identifier for the CatalogOffering. Unique offer ID to be used in Rules and Book requests (offered with v11).

Includes the Identifier, ProductOptions, Price, and TermsAndConditions objects.

Identifier

Defines which supplier system returned that specific room rate (offer).

Key value pair:

authority: Indicates which supplier returned the lowest available rate for that property. Acceptable values are:

  • TVPT: Travelport
  • EXPE: Expedia
  • BKNG: Booking.com

ProductOptions

Top level object.

Product

Information about the room offer.

By default, the Availability response groups common property information in ReferenceList and returns only the following key value pairs in Product:

propertyDatesRef: Key to the corresponding ReferenceList object, which groups common property information such as chain and property code. To identify which property is making the offer and see property level details, match the propertyDatesRef value to ReferenceList/PropertyDates @id.

bookingCode: Booking code that must be sent in any follow-on booking request.

Quantity: The number of rooms available for this rate.

However, if the optional verboseResponseInd indicator is set to true in the request, ReferenceList is not returned. Instead, common property details are returned individually for each property in Product as follows:

bookingCode: Booking code that must be sent in any follow-on booking request.

availability: Open indicates the property is available for booking. Closed indicates the property is not bookable.

adaCompliant: Yes, No, or Unknown indicator for ADA compliance.

PropertyKey, DateRange, and RoomType objects detailed below.

RoomType

Room type detail.

Key value pairs:

numberOfUnits: The number of rooms combined to create this room type.

reqdGuaranteeType: Denotes the form of guarantee for this room.

Includes the RoomCharacteristics, Description, and RoomAmenity objects.

RoomCharacteristics

Room details.

Key value pairs:

category: Category of the room.

smokingAllowed: Yes or No indicator for smoking.

wifiIncluded: Yes or No indicator for wifi.

nonSmokingInd: true or false indicator for non-smoking.

Includes BedConfiguration object.

BedConfiguration

Configuration of bed(s) in room.

Key value pairs:

quantity: Number of beds in the room.

bedType: Bed type values as follows:

  • FUTON 200
  • KING 58
  • QUEEN 86
  • TWIN 113
  • TATAMI 202
  • SOFA 102
  • ROLLAWAY 91
  • MURPHY 201
  • CRIB 26
  • WATERBED 195
  • FULL 249
  • ROUND 250

size: Size of bed(s) in the room.

Description

A room description text string.

Key value pairs:

languages: The language code of the description text.

title: The title of the description.

value: Room description text (e.g. Save 15 Pct Off Studio King Suite Full Breakfast:Free WiFi:32in TV).

RoomAmenity

Room amenity name and description.

Key value pairs:

description: Text string describing room amenity.

Name: Room amenity name.

RoomOccupancy

Room occupancy value.

Key value pair:

maxOccupancy: The maximum number of room occupants.

Price

Top-level pricing object.

Key value pairs:

currencyCode

Base

TotalTaxes

TotalFees

TotalPrice

Includes VendorCurrencyTotal and PriceBreakdown objects.

At this time the key value pairs above are included in the Price object only for backward compatibility and will be deprecated after all existing Alpha customers convert to the endpoints in the new Model X schema. Note: Customers coding to Model 10 (Model X) should use the Price/VendorCurrencyTotal object listed next instead of the above Price key value pairs.

VendorCurrencyTotal

Default pricing based on the location of the hotel along with the currency code of that location.

VendorCurrencyTotal includes the following key value pairs:

CurrencyCode: The currency code based on the location of the hotel.

Base: Total price before fees and taxes.

Total: Sum of total base price, tax amount, and any fees.

Includes Taxes and Fees objects.

VendorCurrencyTotal/Taxes

Tax amount of the total base price.

Key value pair:

TotalTaxes: The sum of the taxes.

VendorCurrencyTotal/Fees

Any fees to be added to the total price.

Key value pair:

TotalFees: The sum of the fees.

PriceBreakdown

The information returned in PriceBreakdown can vary by provider and location.

Key value pairs:

roomPricingType: A string provided by the hotel to describe the rate, such as per night or per stay.

ratePlanCode: If a negotiated rate or rates were sent in the request, the response identifies rates corresponding to those rate codes. This information is returned only if sent to Travelport by the provider.

Only offers supporting the ratePlanCode submitted in the request will have the association identified in the response.

ratePlanId: May or may not be returned by supplier. Note: If a ratePlanId is returned it must be sent in the Reservation request along with the ratePlanCode.

Description: A rate description text string, e.g., Advance Purchase-Ro-Free WiFi.

May include either NightlyRate (if roomPricingType is per night) or Amount (if other than per night) object, and AverageNightlyRate, AmenitySurcharges, and Commission objects.

NightlyRate

Rate per night. Returned if PriceBreakdown @roomPricingType is per night. In the U.S. this amount generally does not include taxes and fees. Multiple NightlyRate objects may be returned when the price changes during the stay.

startDate: Start date for the nightly rate in YYYY-MM-DD format.

nights: Number of nights the nightly rate is valid.

Includes Amount object.

Amount

Key value pairs:

CurrencyCode: Currency in which the amounts in this object are returned.

Base: Base amount not including taxes or fees.

Includes Taxes and Fees objects.

Taxes

Tax details.

Includes Tax and TaxPercent objects.

Tax

Breakdown of the tax.

Key value pairs:

CurrencyCode: Currency in which the tax is returned.

Description: Description of tax.

includedInBase: Indicates whether tax is included in Amount @Base value. Possible values are Yes, No, Unknown.

taxCode: Any code for the tax.

value: The amount of the tax

TaxPercent

Used when the tax is expressed as a percentage of the amount.

Key value pairs:

taxCode: Any code for the tax.

includedInBase: Indicates whether tax is included in the base amount. Options are Yes, No, or Unknown.

value: The tax percentage amount.

Fees

Parent object which can include Fee by rate or by property.

Includes Fee object.

Fee

Fee details.

Key value pairs:

CurrencyCode: The fee currency code.

description: Hotel provider's text explanation of the fee, e.g. Resort Fee.

feeCode: Hotel provider's explanation of the fee; can be returned either as a code or as text.

feeApplication: When the fee is applied. Possible values are:

  • PERPERSON
  • PERROOM
  • PERACCOMMODATION
  • PERHOUSE
  • PERAPARTMENT
  • PERADULT

feeFrequency: The frequency of the fee. Possible values are:

  • PERNIGHT
  • PERDAY
  • PERSTAY
  • PERWEEK
  • ROUNDTRIP
  • ONEWAY

includedInBase: Indicates whether fee is included in the base amount.

value: The amount of the fee.

FeePercent

Fee details used when the fee is expressed as a percentage of the nightly rate base amount.

Key value pairs:

Description: Hotel provider's text explanation of fee, e.g., Resort Fee.

feeApplication: When the fee is applied. Possible values are:

  • PERPERSON
  • PERROOM
  • PERACCOMMODATION
  • PERHOUSE
  • PERAPARTMENT
  • PERADULT

feeCode: Hotel provider's explanation of the fee; can be returned either as a code or as text.

feeFrequency: The frequency of the fee. Possible values are:

  • PERNIGHT
  • PERDAY
  • PERSTAY
  • PERWEEK
  • ROUNDTRIP
  • ONEWAY

includedInBase: Indicates whether fee is included in the base amount.

Commission

Commission details.

Key value pairs:

type application: A value of Commissionable indicates the rate pays commission. Noncommissionable indicates no commission.

Percent: Provides the commission percentage.

TermsAndConditions

The terms and conditions applicable to that CatalogOffering.

Key value pairs:

RatePaymentInfo: PrePay, PostPay, or Unknown rate payment information.

Includes Guarantee, CancelPenalty, AcceptedCreditCard, Description, MealsIncluded, and ProductRateCode Info objects.

Guarantee

If sent by the provider, Guarantee indicates whether payment is required to hold the room.

Key value pairs:

code: The guarantee code.

type: The type of guarantee.

GuaranteeRequired: A credit card number is required for reservation but will not be charged.

DepositRequired: A deposit is charged to a credit card to make a reservation. Send a rules request with the booking code to get all terms and the amount of the deposit.

PrepayRequired: The entire amount for the stay is charged to the credit card to make a reservation. This amount is usually nonrefundable. Send a rules request with the booking code to verify.

CancelPenalty

Cancellation penalty details.

Key value pair:

Refundable: A Yes or No value.

Includes Deadline and HotelPenalty objects.

Deadline

Cancellation penalty deadline details.

Key value pair:

Time: The deadline time in 24-hour HH:MM:SS format.

Includes SpecificDate object.

SpecificDate

Details on cancellation penalty.

Key value pairs:

specific: Date in YYYY-MM-DD format.

duration: Duration from start date.

durationUnit: Duration measurement unit in elapsed time or day of the week. Possible values include:

  • Minutes
  • Hours
  • Days
  • Months
  • SUN
  • MON
  • TUES
  • WED
  • THU
  • FRI
  • SAT

HotelPenalty

Cancellation penalty amount.

Key value pairs:

Percent: Used if provider charges a cancellation fee as a percentage of the nighty rate.

Nights:The number of nights charged at the nightly rate if provider charges a cancellation fee.

Includes Amount object.

Amount

Cancellation penalty amount.

Key value pairs:

code: The penalty currency code.

value: The numeric penalty amount.

AcceptedCreditCard

A list of accepted credit cards.

Key value pair:

value: Two-character code of credit card type.

Returned only for an HPL hotel provider.

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 and set to true if applicable:

breakfastInd

lunchInd

dinnerInd

ProductRateCodeInfo

Top-level object.

Includes RateCodeInfo.

RateCodeInfo

Rate code information.

Key value pairs:

value: The negotiated rate plan code.

rateName: Name of the rate plan.

rateID: ID of the rate plan associated with the negotiated rate plan code.

rateCategory: OTA rate category code. Values can be:

  • Military
  • Convention
  • Credential
  • Weekly
  • Association
  • All
  • FamilyPlan
  • Club
  • Monthly
  • RackGeneral
  • FullInclusive
  • Promotional
  • Government
  • Industry/TravelAgentRate
  • PrePaid
  • Weekend
  • Corporate
  • Mutli-DayPackage
  • Tour
  • Employee
  • MultLevel/Negotiated/Secure
  • Package
  • Other
  • Leisure
  • VIP
  • SeniorCitizen

ReferenceList

If the optional verboseResponseInd indicator is set to true in the request, ReferenceList is not returned. Instead, common property details are not grouped but instead are returned in the individual Product object.

ReferenceList consolidates the common information from each room offer.

Key value pairs:

availability: Open indicates the property is available for booking. Closed indicates the property is not bookable.

adaCompliant: Yes or No indicator for ADA compliance.

id: Key to matching the common information in ReferenceList with an Offer; corresponds to the propertyDatesRef value in each Offer/Products/Product.

moreRatesToken: Optional token to send in second and subsequent requests to retrieve as many rates as returned by the provider. See Additional Rates above for more information.

Includes the PropertyDates object.

PropertyDates

Key value pairs:

adaCompliant: Yes, No, or Unknown indicator for ADA compliance.

id: Key to matching the common information in ReferenceList with an Offer; corresponds to the propertyDatesRef value in each Offer/Products/Product.

moreRatesToken: Optional token to send in second and subsequent requests to retrieve as many rates as returned by the provider, if more rates are available. See Availability Features above for more information.

Includes the PropertyKey and DateRange objects.

PropertyKey

When ReferenceList is returned per above, PropertyKey has the following key value pairs:

chainCode: Chain code for the property

propertyCode: Property code for the property.

DateRange

Check-in and -out dates.

Key value pairs:

start: Check-in date in YYYY-MM-DD format.

end: Check-out date in YYYY-MM-DD format.

CurrencyRateConversion

When a target currency type is requested, the CurrencyRateConversion object is returned. CurrencyRateConversion is documented in Hotel Search.

Example Request

{
  "CatalogOfferingsQueryRequest": {
    "CatalogOfferingsRequest": [
      {
        "verboseResponseInd": true,
        "@type": "CatalogOfferingsRequestHospitality",
        "agencyCode": "49736293",
        "sourceSystem": "1G",
        "StayDates": {
          "start": "2021-05-01",
          "end": "2021-05-02"
        },
        "HotelSearchCriterion": {
          "numberOfRooms": 5,
          "rateCandidates": {
            "prePayRatesOnlyInd": false,
            "postPayRatesOnlyInd": false,
            "rateCandidate": []
          },
          "@type": "HotelSearchCriterion",
          "PropertyRequest": [
            {
              "@type": "PropertyRequest",
              "PropertyKey": {
                "propertyCode": "81493",
                "chainCode": "HX",
                "@type": "PropertyKey"
              }
            },
            {
              "@type": "PropertyRequest",
              "PropertyKey": {
                "propertyCode": "2772",
                "chainCode": "HH",
                "@type": "PropertyKey"
              }
            },
            {
              "@type": "PropertyRequest",
              "PropertyKey": {
                "propertyCode": "44527",
                "chainCode": "HH",
                "@type": "PropertyKey"
              }
            }
          ],
          "RoomStayCandidates": {
            "@type": "RoomStayCandidates",
            "RoomStayCandidate": [
              {
                "roomAmenity": [],
                "@type": "RoomStayCandidate",
                "GuestCounts": {
                  "@type": "GuestCounts",
                  "GuestCount": [
                    {
                      "ageQualifyingCode": "10",
                      "count": 1,
                      "@type": "GuestCount"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    ]
  }
}

Example Response

The following example Availability response has been edited for brevity to return four instances of CatalogOfferingHospitality. Your Availability response is likely to return more instances. 

{
  "CatalogOfferingsHospitalityResponse": {
    "transactionId": "availrequestforOauth",
    "CatalogOfferings": {
      "@type": "CatalogOfferings",
      "CatalogOffering": [
        {
          "@type": "CatalogOfferingHospitality",
          "id": "2fb9a8c2-237c-4595-8258-5d4b5b6607fb:d6d189f7-c6e1-4b2c-aa03-81ec036f7e46",
          "ProductOptions": [
            {
              "@type": "ProductOptions",
              "Product": [
                {
                  "@type": "ProductHospitality",
                  "bookingCode": "A02LV8",
                  "adaCompliant": "No",
                  "Quantity": "9",
                  "PropertyKey": {
                    "chainCode": "HX",
                    "propertyCode": "81493"
                  },
                  "RoomType": {
                    "@type": "RoomTypeDetail",
                    "RoomCharacteristics": {
                      "typeCode": "A02",
                      "smokingAllowed": "No",
                      "nonSmokingInd": true,
                      "BedConfiguration": [
                        {
                          "quantity": 1,
                          "bedType": "king"
                        }
                      ]
                    },
                    "Description": {
                      "value": "1 King Bed Nonsmoking Free Wi-Fi/ Hot Breakfast Included/HDTV Work Area"
                    },
                    "RoomAmenity": [
                      {
                        "description": "king",
                        "quantity": 1
                      }
                    ]
                  },
                  "DateRange": {
                    "start": "2021-05-01",
                    "end": "2021-05-02"
                  }
                }
              ]
            }
          ],
          "Price": {
            "@type": "PriceDetail",
            "currencyCode": "USD",
            "Base": "63.00",
            "TotalTaxes": "11.34",
            "TotalFees": "0.00",
            "TotalPrice": "74.34",
            "VendorCurrencyTotal": {
              "currencyCode": "USD",
              "Base": "63.00",
              "Taxes": {
                "@type": "TaxesDetail",
                "TotalTaxes": "11.34"
              },
              "Fees": {
                "@type": "FeesDetail",
                "TotalFees": "0.00"
              },
              "Total": "74.34"
            },
            "PriceBreakdown": [
              {
                "@type": "PriceBreakdownHospitality",
                "roomPricingType": "Per night",
                "NightlyRate": [
                  {
                    "startDate": "2021-05-01",
                    "Amount": {
                      "currencyCode": "USD",
                      "Base": "63.00"
                    }
                  }
                ],
                "AverageNightlyRate": [
                  {
                    "code": "USD",
                    "value": 63
                  }
                ],
                "AmenitySurcharges": {
                  "@type": "AmenitySurchargesDetail",
                  "Surcharge": [
                    {
                      "currencyCode": "USD",
                      "description": "Crib Surcharge",
                      "value": 0
                    },
                    {
                      "currencyCode": "USD",
                      "description": "Rollaway Surcharge",
                      "value": 89
                    }
                  ]
                }
              },
              {
                "@type": "PriceBreakdownHospitality",
                "roomPricingType": "Per stay",
                "Commission": {
                  "@type": "CommissionPercent",
                  "type": "Commissionable",
                  "Percent": "10.0"
                },
                "Description": "Best Available Rate"
              }
            ]
          },
          "TermsAndConditions": {
            "@type": "TermsAndConditionsHospitality",
            "Guarantee": [
              {
                "code": "GTD",
                "type": "GuaranteeRequired"
              }
            ],
            "CancelPenalty": [
              {
                "Deadline": {
                  "SpecificDate": {
                    "specific": "2021-05-01"
                  }
                },
                "Refundable": "Yes"
              }
            ],
            "Description": [
              "Best Available Rate",
              "1 King Bed Nonsmoking",
              "Free Wi-Fi/ Hot Breakfast Included/HDTV",
              "Work Area"
            ],
            "MealsIncluded": {
              "breakfastInd": true
            },
            "ProductRateCodeInfo": [
              {
                "RateCodeInfo": {
                  "value": "LV8"
                }
              }
            ],
            "DepositPolicy": {
              "Deposit": [
                {
                  "@type": "DepositAmount",
                  "CurrencyAmount": {
                    "value": 0
                  }
                }
              ]
            },
            "RatePaymentInfo": "PostPay"
          }
        },
        {
          "@type": "CatalogOfferingHospitality",
          "id": "2fb9a8c2-237c-4595-8258-5d4b5b6607fb:4a6746ac-524b-4c21-9070-37c427f34ae3",
          "ProductOptions": [
            {
              "@type": "ProductOptions",
              "Product": [
                {
                  "@type": "ProductHospitality",
                  "bookingCode": "A09LV8",
                  "adaCompliant": "No",
                  "Quantity": "9",
                  "PropertyKey": {
                    "chainCode": "HX",
                    "propertyCode": "81493"
                  },
                  "RoomType": {
                    "@type": "RoomTypeDetail",
                    "RoomCharacteristics": {
                      "typeCode": "A09",
                      "smokingAllowed": "No",
                      "nonSmokingInd": true,
                      "BedConfiguration": [
                        {
                          "quantity": 2,
                          "bedType": "queen"
                        }
                      ]
                    },
                    "Description": {
                      "value": "2 Queen Beds Nonsmoking Free Wi-Fi/ Hot Breakfast Included/HDTV Work Area"
                    },
                    "RoomAmenity": [
                      {
                        "description": "queen",
                        "quantity": 2
                      }
                    ]
                  },
                  "DateRange": {
                    "start": "2021-05-01",
                    "end": "2021-05-02"
                  }
                }
              ]
            }
          ],
          "Price": {
            "@type": "PriceDetail",
            "currencyCode": "USD",
            "Base": "63.00",
            "TotalTaxes": "11.34",
            "TotalFees": "0.00",
            "TotalPrice": "74.34",
            "VendorCurrencyTotal": {
              "currencyCode": "USD",
              "Base": "63.00",
              "Taxes": {
                "@type": "TaxesDetail",
                "TotalTaxes": "11.34"
              },
              "Fees": {
                "@type": "FeesDetail",
                "TotalFees": "0.00"
              },
              "Total": "74.34"
            },
            "PriceBreakdown": [
              {
                "@type": "PriceBreakdownHospitality",
                "roomPricingType": "Per night",
                "NightlyRate": [
                  {
                    "startDate": "2021-05-01",
                    "Amount": {
                      "currencyCode": "USD",
                      "Base": "63.00"
                    }
                  }
                ],
                "AverageNightlyRate": [
                  {
                    "code": "USD",
                    "value": 63
                  }
                ],
                "AmenitySurcharges": {
                  "@type": "AmenitySurchargesDetail",
                  "Surcharge": [
                    {
                      "currencyCode": "USD",
                      "description": "Crib Surcharge",
                      "value": 0
                    },
                    {
                      "currencyCode": "USD",
                      "description": "Rollaway Surcharge",
                      "value": 89
                    }
                  ]
                }
              },
              {
                "@type": "PriceBreakdownHospitality",
                "roomPricingType": "Per stay",
                "Commission": {
                  "@type": "CommissionPercent",
                  "type": "Commissionable",
                  "Percent": "10.0"
                },
                "Description": "Best Available Rate"
              }
            ]
          },
          "TermsAndConditions": {
            "@type": "TermsAndConditionsHospitality",
            "Guarantee": [
              {
                "code": "GTD",
                "type": "GuaranteeRequired"
              }
            ],
            "CancelPenalty": [
              {
                "Deadline": {
                  "SpecificDate": {
                    "specific": "2021-05-01"
                  }
                },
                "Refundable": "Yes"
              }
            ],
            "Description": [
              "Best Available Rate",
              "2 Queen Beds Nonsmoking",
              "Free Wi-Fi/ Hot Breakfast Included/HDTV",
              "Work Area"
            ],
            "ProductRateCodeInfo": [
              {
                "RateCodeInfo": {
                  "value": "LV8"
                }
              }
            ],
            "DepositPolicy": {
              "Deposit": [
                {
                  "@type": "DepositAmount",
                  "CurrencyAmount": {
                    "value": 0
                  }
                }
              ]
            },
            "RatePaymentInfo": "PostPay"
          }
        },
        {
          "@type": "CatalogOfferingHospitality",
          "id": "2fb9a8c2-237c-4595-8258-5d4b5b6607fb:314ff388-18b1-45bb-bf51-b1299b341982",
          "ProductOptions": [
            {
              "@type": "ProductOptions",
              "Product": [
                {
                  "@type": "ProductHospitality",
                  "bookingCode": "A02ACF",
                  "adaCompliant": "No",
                  "Quantity": "9",
                  "PropertyKey": {
                    "chainCode": "HX",
                    "propertyCode": "81493"
                  },
                  "RoomType": {
                    "@type": "RoomTypeDetail",
                    "RoomCharacteristics": {
                      "typeCode": "A02",
                      "smokingAllowed": "No",
                      "nonSmokingInd": true,
                      "BedConfiguration": [
                        {
                          "quantity": 1,
                          "bedType": "king"
                        }
                      ]
                    },
                    "Description": {
                      "value": "1 King Bed Nonsmoking Free Wi-Fi/ Hot Breakfast Included/HDTV Work Area"
                    },
                    "RoomAmenity": [
                      {
                        "description": "double",
                        "quantity": 1
                      },
                      {
                        "description": "king",
                        "quantity": 1
                      }
                    ]
                  },
                  "DateRange": {
                    "start": "2021-05-01",
                    "end": "2021-05-02"
                  }
                }
              ]
            }
          ],
          "Price": {
            "@type": "PriceDetail",
            "currencyCode": "USD",
            "Base": "64.89",
            "TotalTaxes": "11.68",
            "TotalFees": "0.00",
            "TotalPrice": "76.57",
            "VendorCurrencyTotal": {
              "currencyCode": "USD",
              "Base": "64.89",
              "Taxes": {
                "@type": "TaxesDetail",
                "TotalTaxes": "11.68"
              },
              "Fees": {
                "@type": "FeesDetail",
                "TotalFees": "0.00"
              },
              "Total": "76.57"
            },
            "PriceBreakdown": [
              {
                "@type": "PriceBreakdownHospitality",
                "roomPricingType": "Per night",
                "NightlyRate": [
                  {
                    "startDate": "2021-05-01",
                    "Amount": {
                      "currencyCode": "USD",
                      "Base": "64.89"
                    }
                  }
                ],
                "AverageNightlyRate": [
                  {
                    "code": "USD",
                    "value": 64.89
                  }
                ],
                "AmenitySurcharges": {
                  "@type": "AmenitySurchargesDetail",
                  "Surcharge": [
                    {
                      "currencyCode": "USD",
                      "description": "Crib Surcharge",
                      "value": 0
                    },
                    {
                      "currencyCode": "USD",
                      "description": "Rollaway Surcharge",
                      "value": 89
                    }
                  ]
                }
              },
              {
                "@type": "PriceBreakdownHospitality",
                "roomPricingType": "Per stay",
                "Commission": {
                  "@type": "CommissionPercent",
                  "type": "Commissionable",
                  "Percent": "10.0"
                },
                "Description": "2X Points Package Get Rewarded With Double Honors Points. Not A Member, Join At Hiltonhonors.Com/Join"
              }
            ]
          },
          "TermsAndConditions": {
            "@type": "TermsAndConditionsHospitality",
            "Guarantee": [
              {
                "code": "GTD",
                "type": "GuaranteeRequired"
              }
            ],
            "CancelPenalty": [
              {
                "Deadline": {
                  "SpecificDate": {
                    "specific": "2021-05-01"
                  }
                },
                "Refundable": "Yes"
              }
            ],
            "Description": [
              "2X Points Package",
              "Get Rewarded With Double Honors Points.",
              "Not A Member, Join At Hiltonhonors.Com/Join",
              "1 King Bed Nonsmoking",
              "Free Wi-Fi/ Hot Breakfast Included/HDTV",
              "Work Area"
            ],
            "MealsIncluded": {
              "breakfastInd": true
            },
            "ProductRateCodeInfo": [
              {
                "RateCodeInfo": {
                  "value": "ACF"
                }
              }
            ],
            "DepositPolicy": {
              "Deposit": [
                {
                  "@type": "DepositAmount",
                  "CurrencyAmount": {
                    "value": 0
                  }
                }
              ]
            },
            "RatePaymentInfo": "PostPay"
          }
        },
        {
          "@type": "CatalogOfferingHospitality",
          "id": "2fb9a8c2-237c-4595-8258-5d4b5b6607fb:69e872b8-12c2-4898-afbe-deba74aed942",
          "ProductOptions": [
            {
              "@type": "ProductOptions",
              "Product": [
                {
                  "@type": "ProductHospitality",
                  "bookingCode": "A09ACF",
                  "adaCompliant": "No",
                  "Quantity": "9",
                  "PropertyKey": {
                    "chainCode": "HX",
                    "propertyCode": "81493"
                  },
                  "RoomType": {
                    "@type": "RoomTypeDetail",
                    "RoomCharacteristics": {
                      "typeCode": "A09",
                      "smokingAllowed": "No",
                      "nonSmokingInd": true,
                      "BedConfiguration": [
                        {
                          "quantity": 2,
                          "bedType": "queen"
                        }
                      ]
                    },
                    "Description": {
                      "value": "2 Queen Beds Nonsmoking Free Wi-Fi/ Hot Breakfast Included/HDTV Work Area"
                    },
                    "RoomAmenity": [
                      {
                        "description": "double",
                        "quantity": 1
                      },
                      {
                        "description": "queen",
                        "quantity": 2
                      }
                    ]
                  },
                  "DateRange": {
                    "start": "2021-05-01",
                    "end": "2021-05-02"
                  }
                }
              ]
            }
          ],
          "Price": {
            "@type": "PriceDetail",
            "currencyCode": "USD",
            "Base": "64.89",
            "TotalTaxes": "11.68",
            "TotalFees": "0.00",
            "TotalPrice": "76.57",
            "VendorCurrencyTotal": {
              "currencyCode": "USD",
              "Base": "64.89",
              "Taxes": {
                "@type": "TaxesDetail",
                "TotalTaxes": "11.68"
              },
              "Fees": {
                "@type": "FeesDetail",
                "TotalFees": "0.00"
              },
              "Total": "76.57"
            },
            "PriceBreakdown": [
              {
                "@type": "PriceBreakdownHospitality",
                "roomPricingType": "Per night",
                "NightlyRate": [
                  {
                    "startDate": "2021-05-01",
                    "Amount": {
                      "currencyCode": "USD",
                      "Base": "64.89"
                    }
                  }
                ],
                "AverageNightlyRate": [
                  {
                    "code": "USD",
                    "value": 64.89
                  }
                ],
                "AmenitySurcharges": {
                  "@type": "AmenitySurchargesDetail",
                  "Surcharge": [
                    {
                      "currencyCode": "USD",
                      "description": "Crib Surcharge",
                      "value": 0
                    },
                    {
                      "currencyCode": "USD",
                      "description": "Rollaway Surcharge",
                      "value": 89
                    }
                  ]
                }
              },
              {
                "@type": "PriceBreakdownHospitality",
                "roomPricingType": "Per stay",
                "Commission": {
                  "@type": "CommissionPercent",
                  "type": "Commissionable",
                  "Percent": "10.0"
                },
                "Description": "2X Points Package Get Rewarded With Double Honors Points. Not A Member, Join At Hiltonhonors.Com/Join"
              }
            ]
          },
          "TermsAndConditions": {
            "@type": "TermsAndConditionsHospitality",
            "Guarantee": [
              {
                "code": "GTD",
                "type": "GuaranteeRequired"
              }
            ],
            "CancelPenalty": [
              {
                "Deadline": {
                  "SpecificDate": {
                    "specific": "2021-05-01"
                  }
                },
                "Refundable": "Yes"
              }
            ],
            "Description": [
              "2X Points Package",
              "Get Rewarded With Double Honors Points.",
              "Not A Member, Join At Hiltonhonors.Com/Join",
              "2 Queen Beds Nonsmoking",
              "Free Wi-Fi/ Hot Breakfast Included/HDTV",
              "Work Area"
            ],
            "MealsIncluded": {
              "breakfastInd": true
            },
            "ProductRateCodeInfo": [
              {
                "RateCodeInfo": {
                  "value": "ACF"
                }
              }
            ],
            "DepositPolicy": {
              "Deposit": [
                {
                  "@type": "DepositAmount",
                  "CurrencyAmount": {
                    "value": 0
                  }
                }
              ]
            },
            "RatePaymentInfo": "PostPay"
          }
        },
      ]
    }
  }
}

Error Messages

SourceCode

StatusCode (HTTP Code)

 Message

NO_RATEPLAN_AVAILABILITY

98

No requested Rate Plans received from the provider

INVALID_PROMO_CODE

306

Invalid Promotion Code

CLOSED_TO_ARRIVALS

346

Closed to Arrivals
INVALID_REQUEST

367

 Invalid Request

EXCESS_OCCUPANCY

378

Max Allowed Number of Rooms or Guests Exceeded

INVALID_CHECKIN

381

Invalid Check-in Date

INVALID_ADULT_GUEST_COUNT

397

Invalid Number of Adults

INVALID_PROPERTY

400

Requested property was not found

INVALID_PROPERTY

400

The list of PropertyIDs exceeds the limit of 10

INVALID_PROPERTY

400

This list of PropertyIDs doesn't contain at least one valid property

INVALID_PROPERTY

400

Chain code or property code is missing

INVALID_PROPERTY

400

The Property request format should be ChainCode (2 alphabetic characters) and PropertyCode (between 2 and 36 alphanumeric characters)

INVALID_PROPERTY

400

At least one valid set of ChainCode (2 alphabetic characters) and Property Code (alphanumeric) is required

INVALID_PROPERTY

400

Request contains duplicate Property IDs

INVALID_FREQUENT_GUEST_NUMBER

400

Invalid frequent guest number

INVALID_PROMO_CODE

400

Invalid promo code or association ID

INACTIVE_PROPERTY

400

Requested property is inactive

INVALID_INDATE_OUTDATE

400

Invalid in date or out date

INVALID_NUMBER_OF_ROOMS

400

Invalid number of rooms

INVALID_NUMBER_OF_NIGHTS

400

Invalid number of nights

INVALID_NUMBER_OF_GUESTS

400

Invalid number of guests

INVALID_RATE_PLANS

400

Invalid rate plans

Bad Request

400

The number of rooms exceeds the limit of 9

Bad Request

400

Maximum number of rooms exceeded

Bad Request

400

Number of occupancies must be less than 9

DEFAULT_WARNING

400

null

DEFAULT_ERROR

400

null

NO_AVAILABILITY

404

No Room Stays/Rate Plans received from the provider

SYSTEM_ERROR

448

System Error

UNABLE_TO_PROCESS

450

Unable to Process

MAX_WAIT_TIME_REACHED

500

No rates returned within the requested maximum wait time

INVOCATION_FAILURE

500

Error connecting to the provider

UNKNOWN_ERROR

500

Unable to process request. Exception occurred.

VENDOR_RESPONSE_ERROR

724

Vendor Response Error