Skip to main content

Hotel Lead Availability

Hotel
Search
REST API
Hospitality
Try Now

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 reasons and pricing information including:

  • Average: The sum of all product total prices divided by the number of products. The amount does not reflect the price of any product.
  • Maximum/Minimum: The maximum/minimum total price across all products, including any product matching that total.
  • Maximum/Minimum Average: The maximum/minimum daily average across all products. There is at least one matching product in the response.
  • Maximum/Minimum First Night: The maximum/minimum first-night price across all products. There is at least one matching product in the response.
  • Maximum/Minimum Highest Price with Inclusive Tax: The maximum/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 set up in an alternate currency Note: Only rates set up in the requested currency are returned. Rate currency is not converted.

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 rates based on loyalty program code and level

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=2020-02-01&endDate=2020-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.03999999999999
            },
            "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.32285714285715,
            "AmountWithTaxesFees": 111.11,
            "CurrencyCode": "USD",
            "Type": "MaximumAvg"
        }, {
            "Amount": 86.791428571428568,
            "AmountWithTaxesFees": 90.0,
            "CurrencyCode": "USD",
            "Type": "MinimumAvg"
        }, {
            "Amount": 89.285714285714292,
            "AmountWithTaxesFees": 90.0,
            "CurrencyCode": "USD",
            "Type": "MinimumFirstNight"
        }, {
            "Amount": 110.39571428571429,
            "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.03999999999999
            },
            "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.32285714285715,
            "AmountWithTaxesFees": 111.11,
            "CurrencyCode": "USD",
            "Type": "MaximumAvg"
        }, {
            "Amount": 86.791428571428568,
            "AmountWithTaxesFees": 90.0,
            "CurrencyCode": "USD",
            "Type": "MinimumAvg"
        }, {
            "Amount": 89.285714285714292,
            "AmountWithTaxesFees": 90.0,
            "CurrencyCode": "USD",
            "Type": "MinimumFirstNight"
        }, {
            "Amount": 110.39571428571429,
            "AmountWithTaxesFees": 111.11,
            "CurrencyCode": "USD",
            "Type": "MaximumFirstNight"
        }, {
            "Amount": 111.11,
            "CurrencyCode": "USD",
            "Type": "MaximumHighestPriceWithInclusiveTax"
        }, {
            "Amount": 90.0,
            "CurrencyCode": "USD",
            "Type": "MinimumHighestPriceWithInclusiveTax"
        }],
        "Available": false,
        "ArrivalDate": "2020-02-01",
        "DepartureDate": "2020-02-29"
    }]
}

Resources