What is it?
The Hotel Lead Availability API returns Lead rates over a date range for one or more hotels. The output is a list of hotels and for each hotel, if it is available, failure reason(s) and pricing information including:
- Average: The total price of all products divided by the number of products. The amount does not reflect the price of a specific product.
- Maximum: The maximum total priced product.
- Minimum: The minimum total priced product.
- Maximum Average: The maximum daily average across all products. The amount does not reflect the price of a specific product.
- Minimum Average: The minimum daily average across all products. The amount does not reflect the price of a specific product.
- Maximum First Night: The maximum first-night price across all products.
- Minimum First Night: The minimum first-night price across all products.
- Maximum Highest Price with Inclusive Tax: The maximum highest room price inclusive of taxes across all products.
- Minimum Highest Price with Inclusive Tax: The minimum highest room price inclusive of taxes across all products.
Why use it?
- Lead Availability responses are most commonly used to provide a “From: $XXX” price to a consumer on a website as a general price guide that displays before actual dates are shopped.
- Nightly rates, also referred to as Calendar Availability, can be requested by including the @lengthOfStay parameter. Calendar Availability responses are most commonly used to provide rates and availability per night on a calendar. A guest can view which dates the hotel is available and the lowest price per day.
How to use
Supported Use Cases
Access Codes - Include Corporate, Group, Promotion of Channel Access Rates in the availability response. The response is almost identical in terms of structure to the unqualified search but it includes more products since the access code unlocks the usage of additional products.
Agent - Booker, Travel Agent or Chain Agent Specific Rates - Unlock rates assigned to a Booker, IATA or Chain Agent
Calendar Availability - Request pricing elements per night, per hotel, across a stay interval
Central Reservation Office (CRO) Rates - Search for rates assigned to a CRO
Currency Code - Request rates to be converted to a specified currency. Note: Converting rates to the requested currency is only done as a courtesy for the client. Rates must be booked and paid for in the currency they are configured, not based on currency conversion.
Language - Request the hotel name and other descriptive information to be returned in a specified language Note: If content doesn’t exist in the requested language or isn't supported by the system then the default language English (en) is used.
Loyalty Program - Request cash rates based on loyalty program code and level
Note: Point Redemption Rates are not supported in the Lead Availability API. Only cash rates or the cash amount for Points or Cash rates are supported.
Pagination - Used to access the response data in smaller sets
Price Range - Request rates by specifying a minimum and/or maximum price
Rate - Request specific rate codes to include in the response
Rate Class - Include or exclude rates assigned to a rate class
Rate Filter - Include rates assigned to a rate filter
Room Code - Request specific room codes to include in the response
Sample Request and Response (2 adults, 1 room, 29 nights)
[GET] /v1/api/hotel/leadAvailability?adults=2&hotelId=13098&chainId=12723&primaryChannel=WEB&secondaryChannel=WEB&numRooms=1&startDate=2022-02-01&endDate=2022-02-29
{
"paging": {
"Size": 1,
"Start": 0,
"Total": 1
},
"leadAvailabilityList": [{
"Hotel": {
"Id": 13098
},
"AllocationBlockList": [],
"LeastRestrictiveFailure": {
"AdditionalInformation": "9",
"Cause": "MaxStayArrive",
"Level": "HotelControl",
"OverrideAllowed": false
},
"Failures": [{
"Cause": "MaxStayThrough",
"Percentage": 100
}, {
"Cause": "MaxStayArrive",
"Percentage": 100
}, {
"Cause": "NoAvailableInventory",
"Percentage": 8
}, {
"Cause": "NoSeasonOrOverride",
"Percentage": 36
}, {
"Cause": "ZeroFinalPrice",
"Percentage": 36
}, {
"Cause": "LeadDaysTime",
"Percentage": 12
}],
"Price": [{
"Product": {
"Room": {
"Code": "LUXT"
},
"Rate": {
"Code": "BAR"
}
},
"Tax": {
"Amount": 106.04
},
"Amount": 3005.04,
"AmountWithTaxesFees": 3111.08,
"CurrencyCode": "USD",
"Type": "Maximum"
}, {
"Product": {
"Room": {
"Code": "SUPK"
},
"Rate": {
"Code": "COUPONPROMO"
}
},
"Tax": {
"Amount": 89.84
},
"Amount": 2430.16,
"AmountWithTaxesFees": 2520.0,
"CurrencyCode": "USD",
"Type": "Minimum"
}, {
"Amount": 2587.91,
"AmountWithTaxesFees": 2682.22,
"CurrencyCode": "USD",
"Type": "Average"
}, {
"Amount": 107.32,
"AmountWithTaxesFees": 111.11,
"CurrencyCode": "USD",
"Type": "MaximumAvg"
}, {
"Amount": 86.79,
"AmountWithTaxesFees": 90.0,
"CurrencyCode": "USD",
"Type": "MinimumAvg"
}, {
"Amount": 89.29,
"AmountWithTaxesFees": 90.0,
"CurrencyCode": "USD",
"Type": "MinimumFirstNight"
}, {
"Amount": 110.40,
"AmountWithTaxesFees": 111.11,
"CurrencyCode": "USD",
"Type": "MaximumFirstNight"
}, {
"Amount": 111.11,
"CurrencyCode": "USD",
"Type": "MaximumHighestPriceWithInclusiveTax"
}, {
"Amount": 90.0,
"CurrencyCode": "USD",
"Type": "MinimumHighestPriceWithInclusiveTax"
}],
"PriceGroup": [{
"Product": {
"Room": {
"Code": "LUXT"
},
"Rate": {
"Code": "BAR"
}
},
"Tax": {
"Amount": 106.04
},
"Amount": 3005.04,
"AmountWithTaxesFees": 3111.08,
"CurrencyCode": "USD",
"Type": "Maximum"
}, {
"Product": {
"Room": {
"Code": "SUPK"
},
"Rate": {
"Code": "COUPONPROMO"
}
},
"Tax": {
"Amount": 89.84
},
"Amount": 2430.16,
"AmountWithTaxesFees": 2520.0,
"CurrencyCode": "USD",
"Type": "Minimum"
}, {
"Amount": 2587.91,
"CurrencyCode": "USD",
"Type": "Average"
}, {
"Amount": 107.32,
"AmountWithTaxesFees": 111.11,
"CurrencyCode": "USD",
"Type": "MaximumAvg"
}, {
"Amount": 86.79,
"AmountWithTaxesFees": 90.0,
"CurrencyCode": "USD",
"Type": "MinimumAvg"
}, {
"Amount": 89.29,
"AmountWithTaxesFees": 90.0,
"CurrencyCode": "USD",
"Type": "MinimumFirstNight"
}, {
"Amount": 110.40,
"AmountWithTaxesFees": 111.11,
"CurrencyCode": "USD",
"Type": "MaximumFirstNight"
}, {
"Amount": 111.11,
"CurrencyCode": "USD",
"Type": "MaximumHighestPriceWithInclusiveTax"
}, {
"Amount": 90.0,
"CurrencyCode": "USD",
"Type": "MinimumHighestPriceWithInclusiveTax"
}],
"Available": false,
"ArrivalDate": "2022-02-01",
"DepartureDate": "2022-02-29"
}]
}