Skip Navigation

Get Hotel Lead Rate

5.0.0
Hotel
Search
SOAP API
Travel Agency

Not Signed In.

Looks like you may not have access to all of the resources and documentation for this page.
Please log-in or contact your support desk team if you believe you should have access.

The Get Hotel Lead Rate (GetHotelLeadRateRQ) API provides the lowest available product from aggregators and GDS based on the search criteria entered.

Target Audience
Travel Agency
API Version
5.0.0
Authentication
Session or Sessionless Tokens
Service Action Code
GetHotelLeadRateRQ

What is it?

The Get Hotel Lead Rate API obtains the lowest available priced product (room/rate) from the requested supply sources based on stay criteria which includes stay dates and occupancy status. It also comes with multiple search parameters and filters.

Why use it?

The Get Hotel Lead Rate API allows you to find the best possible stay rates for your booking. You can select to see the lowest available rate per each property, or from each supply source per property. The `Rate Key` which is returned in the response allows you to select the product for your booking.

How does it work?

This API contains multiple search parameters and filters:

Search Parameters

  •  Hotel IDs – information for up to 200 properties can be included in a single request
  • Supply sources – you can specify the sources which need to be included in the search criteria and the necessary access which needs to be enabled. You can also specify if the API should return with the below points:
    • The lowest rate across all supply sources – this would return with a single rate for each property.
    • The lowest rate for each supply source – this would return with one rate per property per source based on the availability.
  • The currency code in which the rates should be returned.
  • Stay dates
  • Number of rooms
  • The number of guests, including children, along with their age group.
  • Rate plans (including any negotiated or contractual rates)
  • Corporate discount codes
  • Loyalty IDs and/or frequent flyer numbers
  • Filter based on Rate Type – prepaid vs post-paid

Response

  • Property ID 
  • Lead rate  
    • Rate before and after tax  
    • Average nightly rate  before and after tax
    • MinSellingRate
    • Supply source of rate  
    • Commission information – the commission which is made from the point of sale  
    • Unique Rate Key for the rate, which is used in the HotelPriceCheck API to book the rate  
  • Currency  
  • Room type  
  • Bed type  
  • Rate plan  
  • Cancel policies and any penalties associated with the rate  
  • Guarantee information
  • Amenities available at the property

Note: To book the rate(s) provided, use the returned Rate Key returned in your HotelPriceCheck request.

How do I use it?

Utilize the following parameters to customize your search:

  • Property ID  
  • Code Context (Sabre ID or Global ID)  
  • Occupancy and Rooms  
  • Stay Dates  
  • Prepaid Qualifier  
  • Currency  
  • Rate Range  
  • Rate Plan Type, Negotiated Rates, Corporate Rates, Publicly Available Rates  
  • Loyalty IDs, Corporate Discount Codes, Frequent Flyer IDs  
  • Supply Sources  
  • Lead Rate per property or from each supply source per property  

The response will return rate information, including amounts before and after tax, the tax/fee breakdown, cancel penalty information, and commission information.

Request structure

Refer to the Request Design Documentation for an XML view of the request structure.

Response structure

Refer to the Response Design Documentation for an XML view of the response structure.

Sample Request
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Header>
        <eb:MessageHeader eb:version="" xmlns:eb="http://www.ebxml.org/namespaces/messageHeader">
            <eb:From>
                <eb:PartyId>777</eb:PartyId>
            </eb:From>
            <eb:To>
                <eb:PartyId>webservices.sabre.com</eb:PartyId>
            </eb:To>
            <eb:CPAId>TM61</eb:CPAId>
            <eb:ConversationId>1234567890</eb:ConversationId>
            <eb:Action>GetHotelLeadRateRQ</eb:Action>
            <eb:MessageData>
                <eb:MessageId>LbQ26Jnofb4Q8f3Pk15Mg5</eb:MessageId>
                <eb:Timestamp>2015-05-12T13:23:00Z</eb:Timestamp>
                <eb:TimeToLive>2015-05-12T13:23:00Z</eb:TimeToLive>
            </eb:MessageData>
        </eb:MessageHeader>
        <wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/12/secext">
            <wsse:BinarySecurityToken>{{usg-session-token}}</wsse:BinarySecurityToken>
        </wsse:Security>
    </soap:Header>
    <soap:Body>
        <GetHotelLeadRateRQ xmlns="http://services.sabre.com/hotel/leadrate/v5_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="5.0.0" xsi:schemaLocation="http://services.sabre.com/hotel/leadrate/v5_0_0 GetHotelLeadRateRQ_V5.xsd">
            <!-- POS tag can be used in place of calling ContextChangeLLSRQ - availability will be done assuming you've already AAAed into the PCC in the Source // @PseudoCityCode -->
            <POS>
                <Source PseudoCityCode="TM61"/>
            </POS>
            <HotelRefs>
                <HotelRef HotelCode="53434"/>
            </HotelRefs>
            <RateInfoRef CurrencyCode="INR" BestOnly="1" PrepaidQualifier="IncludePrepaid" RefundableOnly="false" ConvertedRateInfoOnly="false" TravellerCountry="US">
                <StayDateTimeRange StartDate="2023-12-01" EndDate="2023-12-06"/>
                <Rooms>
                    <Room Index="1" Adults="1" Children="2">
                        <ChildAges>1,2</ChildAges>
                    </Room>
                </Rooms>
                <RatePlanCandidates OtherAvailableRatePlans="true">
                    <RatePlanCandidate RatePlanCode="BAK"/>
                    <RatePlanCandidate RatePlanCode="JOV"/>
                    <RatePlanCandidate RatePlanCode="CWT"/>
                </RatePlanCandidates>
            </RateInfoRef>
            <TPAExtensions>
                <auto-generated_for_wildcard/>
            </TPAExtensions>
        </GetHotelLeadRateRQ>
    </soap:Body>
</soap:Envelope>
Sample Response
<GetHotelLeadRateRS>
    <HotelRateInfos>
        <HotelRateInfo>
            <HotelInfo HotelCode="100102626" ChainCode="HY" CodeContext="GLOBAL" SabreHotelCode="53434"/>
            <RateInfos>
                <RateInfo HighestNightlyRate="112.10" AverageNightlyRate="134.89" RateKey="YRQQTH3AIKdbf7tdfq7djpPOVHwVsjxjCzkG68LCvjy1uuCezWhLL4pZD3cu25KNvfLH5hXR7GShZye6vStBVvrdmZrLmq+mUlVHcZkRbcbc1vZWiKI2eY6vEycVBVRExuJqITLOqzriKk/C2UgJCFK1b4B2Rx0gcmro+8pdXQPJ+1cvCpiiFVDmQBRcDWW1/7c3Z7owhQeMZMSJ909K7Ci5WaHsOBv/gbXsn96Q3BgjcQlTwMzNUWuyy5qsdTHuGCjPBDJtN6PvOC6Iai1bWel2TlVWm3hkfI90Wdq3Y3k2O3aSP/jOhhsZIXQ07iD7HtlwF1esnAeYUniQjrzKrle6d9PbSd2Hjf1KXze6p4hg2DOceWOoT7X5GUadjKfavdEY2MoizBTnKreoF+GQ2j4HxmdG57agPfjttrsHE5CwLl95tkg2mbU1EKYBmE+r7nrIT1jpvXwm4KDk/ILJSBmTvDzmveMZwPYambiDAPwB5mJlve1nLbusL/FV4zOX6UZE35I7QFAghUOjlsZxKmbJf8s6+QA4GJpLMNY2ao+/cBgDoQVW9bE2epj4zI52gELQHK1dKzW/vqga6P69Lo1LbgbVOo7cqIiKbRsCf+4cIvy7vJqy3IAIq9+UwMrt6MA9Lo92vhZCHfFe5CSXy/v7eiUAk+lpghV5p4pPQYJS/MKnM/YI9yP10P1VIj6DEkS7tFtoAHDlOdAEbXqYSc4M7HKa6hMF4vhdK1gvoxNesh0aihWRjo79E09NFQqbyNoOsIIo/y25z41ALPH3CVEdDWiCtESQh2Cv7FZ0udQvPNxFsnrJIfTYC1fB9VDe70ypIuQZWNmrGQ+SrMq1QOlMall5WH18wogFbkunv6gKsbKUS9ODJruFChZ7HFKmk/Fojseu/Do0m/+v1+34cTVBu9TSpbY+B639Hj7fqjD9MS10o2JbPiVX3YsgTCYPF99E41xsHMWQwu4n05ZKmikOMd+Kvy7hlSs6d4ymKYn+EV38FtZt6A7Azr0+nleihcC2sOrMjkhHO49y6Bt227aHJz3gBDTYcOydjAXk1XmzNFexuLfkjBQBUuL8bYsnKP2meexAv6EJ5DVaYDgIR+uvOlAdYs/w/t0fVOKsqf5F1kJ2s/JXQ5+P03NQxyzD" ApproxTotalPrice="674.45" AverageNightlyRateBeforeTax="112.10" EndDate="2023-12-06" StartDate="2023-12-01" CurrencyCode="USD" AmountAfterTax="674.45" AdditionalFeesInclusive="false" AmountBeforeTax="560.50" RateSource="110" TaxInclusive="true">
                    <Commission CurrencyCode="USD" Type="Amount" Amount="5.72"/>
                </RateInfo>
                <ConvertedRateInfo HighestNightlyRate="9220" AverageNightlyRate="11094" RateKey="YRQQTH3AIKdbf7tdfq7djpPOVHwVsjxjCzkG68LCvjy1uuCezWhLL4pZD3cu25KNvfLH5hXR7GShZye6vStBVvrdmZrLmq+mUlVHcZkRbcbc1vZWiKI2eY6vEycVBVRExuJqITLOqzriKk/C2UgJCFK1b4B2Rx0gcmro+8pdXQPJ+1cvCpiiFVDmQBRcDWW1/7c3Z7owhQeMZMSJ909K7Ci5WaHsOBv/gbXsn96Q3BgjcQlTwMzNUWuyy5qsdTHuGCjPBDJtN6PvOC6Iai1bWel2TlVWm3hkfI90Wdq3Y3k2O3aSP/jOhhsZIXQ07iD7HtlwF1esnAeYUniQjrzKrle6d9PbSd2Hjf1KXze6p4hg2DOceWOoT7X5GUadjKfavdEY2MoizBTnKreoF+GQ2j4HxmdG57agPfjttrsHE5CwLl95tkg2mbU1EKYBmE+r7nrIT1jpvXwm4KDk/ILJSBmTvDzmveMZwPYambiDAPwB5mJlve1nLbusL/FV4zOX6UZE35I7QFAghUOjlsZxKmbJf8s6+QA4GJpLMNY2ao+/cBgDoQVW9bE2epj4zI52gELQHK1dKzW/vqga6P69Lo1LbgbVOo7cqIiKbRsCf+4cIvy7vJqy3IAIq9+UwMrt6MA9Lo92vhZCHfFe5CSXy/v7eiUAk+lpghV5p4pPQYJS/MKnM/YI9yP10P1VIj6DEkS7tFtoAHDlOdAEbXqYSc4M7HKa6hMF4vhdK1gvoxNesh0aihWRjo79E09NFQqbyNoOsIIo/y25z41ALPH3CVEdDWiCtESQh2Cv7FZ0udQvPNxFsnrJIfTYC1fB9VDe70ypIuQZWNmrGQ+SrMq1QOlMall5WH18wogFbkunv6gKsbKUS9ODJruFChZ7HFKmk/Fojseu/Do0m/+v1+34cTVBu9TSpbY+B639Hj7fqjD9MS10o2JbPiVX3YsgTCYPF99E41xsHMWQwu4n05ZKmikOMd+Kvy7hlSs6d4ymKYn+EV38FtZt6A7Azr0+nleihcC2sOrMjkhHO49y6Bt227aHJz3gBDTYcOydjAXk1XmzNFexuLfkjBQBUuL8bYsnKP2meexAv6EJ5DVaYDgIR+uvOlAdYs/w/t0fVOKsqf5F1kJ2s/JXQ5+P03NQxyzD" ApproxTotalPrice="55474" AverageNightlyRateBeforeTax="9220" EndDate="2023-12-06" StartDate="2023-12-01" CurrencyCode="INR" AmountAfterTax="55474" AdditionalFeesInclusive="false" AmountBeforeTax="46102" RateSource="110" TaxInclusive="true">
                    <Commission CurrencyCode="INR" Type="Amount" Amount="470"/>
                </ConvertedRateInfo>
            </RateInfos>
            <Rooms>
                <Room RoomIndex="1">
                    <RoomDescription Name="Room, 1 King Bed, Accessible, Bathtub">
                        <Text>Room, 1 King Bed, Accessible, Bathtub</Text>
                    </RoomDescription>
                    <RatePlans>
                        <RatePlan RatePlanType="13" RatePlanName="Room, 1 King Bed, Accessible, Bathtub" RateKey="YRQQTH3AIKdbf7tdfq7djpPOVHwVsjxjCzkG68LCvjy1uuCezWhLL4pZD3cu25KNvfLH5hXR7GShZye6vStBVvrdmZrLmq+mUlVHcZkRbcbc1vZWiKI2eY6vEycVBVRExuJqITLOqzriKk/C2UgJCFK1b4B2Rx0gcmro+8pdXQPJ+1cvCpiiFVDmQBRcDWW1/7c3Z7owhQeMZMSJ909K7Ci5WaHsOBv/gbXsn96Q3BgjcQlTwMzNUWuyy5qsdTHuGCjPBDJtN6PvOC6Iai1bWel2TlVWm3hkfI90Wdq3Y3k2O3aSP/jOhhsZIXQ07iD7HtlwF1esnAeYUniQjrzKrle6d9PbSd2Hjf1KXze6p4hg2DOceWOoT7X5GUadjKfavdEY2MoizBTnKreoF+GQ2j4HxmdG57agPfjttrsHE5CwLl95tkg2mbU1EKYBmE+r7nrIT1jpvXwm4KDk/ILJSBmTvDzmveMZwPYambiDAPwB5mJlve1nLbusL/FV4zOX6UZE35I7QFAghUOjlsZxKmbJf8s6+QA4GJpLMNY2ao+/cBgDoQVW9bE2epj4zI52gELQHK1dKzW/vqga6P69Lo1LbgbVOo7cqIiKbRsCf+4cIvy7vJqy3IAIq9+UwMrt6MA9Lo92vhZCHfFe5CSXy/v7eiUAk+lpghV5p4pPQYJS/MKnM/YI9yP10P1VIj6DEkS7tFtoAHDlOdAEbXqYSc4M7HKa6hMF4vhdK1gvoxNesh0aihWRjo79E09NFQqbyNoOsIIo/y25z41ALPH3CVEdDWiCtESQh2Cv7FZ0udQvPNxFsnrJIfTYC1fB9VDe70ypIuQZWNmrGQ+SrMq1QOlMall5WH18wogFbkunv6gKsbKUS9ODJruFChZ7HFKmk/Fojseu/Do0m/+v1+34cTVBu9TSpbY+B639Hj7fqjD9MS10o2JbPiVX3YsgTCYPF99E41xsHMWQwu4n05ZKmikOMd+Kvy7hlSs6d4ymKYn+EV38FtZt6A7Azr0+nleihcC2sOrMjkhHO49y6Bt227aHJz3gBDTYcOydjAXk1XmzNFexuLfkjBQBUuL8bYsnKP2meexAv6EJ5DVaYDgIR+uvOlAdYs/w/t0fVOKsqf5F1kJ2s/JXQ5+P03NQxyzD" RateSource="110" PrepaidIndicator="true" AvailableQuantity="5">
                            <RatePlanDescription>
                                <Text>Room, 1 King Bed, Accessible, Bathtub</Text>
                            </RatePlanDescription>
                            <RateInfo StartDate="2023-12-01" HighestNightlyRate="112.10" CurrencyCode="USD" AmountAfterTax="674.45" AdditionalFeesInclusive="false" AmountBeforeTax="560.50" AverageNightlyRate="134.89" ApproxTotalPrice="674.45" AverageNightlyRateBeforeTax="112.10" EndDate="2023-12-06" TaxInclusive="true">
                                <Taxes CurrencyCode="USD" Amount="113.95">
                                    <TaxGroups>
                                        <TaxGroup CurrencyCode="USD" Description="Property Fee" Amount="4.05" Code="200">
                                            <TaxDescription>
                                                <Text>Property Fee</Text>
                                            </TaxDescription>
                                        </TaxGroup>
                                        <TaxGroup CurrencyCode="USD" Description="Tax Recovery Charges and Service Fees" Amount="109.90" Code="201">
                                            <TaxDescription>
                                                <Text>Tax Recovery Charges and Service Fees</Text>
                                            </TaxDescription>
                                        </TaxGroup>
                                    </TaxGroups>
                                </Taxes>
                                <Fees CurrencyCode="USD" Amount="3.55">
                                    <FeeGroups>
                                        <FeeGroup CurrencyCode="USD" Description="Miscellaneous fee" Amount="3.55" Code="54">
                                            <FeeDescription>
                                                <Text>Mandatory Fee</Text>
                                            </FeeDescription>
                                        </FeeGroup>
                                    </FeeGroups>
                                </Fees>
                                <CancelPenalties>
                                    <CancelPenalty Refundable="false"/>
                                </CancelPenalties>
                                <Guarantee GuaranteeType="DEP">
                                    <GuaranteesAccepted>
                                        <GuaranteeAccepted GuaranteeTypeCode="5" GuaranteeTypeDescription="Credit card"/>
                                    </GuaranteesAccepted>
                                </Guarantee>
                            </RateInfo>
                            <ConvertedRateInfo StartDate="2023-12-01" HighestNightlyRate="9220" CurrencyCode="INR" AmountAfterTax="55474" AdditionalFeesInclusive="false" AmountBeforeTax="46102" AverageNightlyRate="11094" ApproxTotalPrice="55474" AverageNightlyRateBeforeTax="9220" EndDate="2023-12-06" TaxInclusive="true">
                                <Taxes CurrencyCode="INR" Amount="9372">
                                    <TaxGroups>
                                        <TaxGroup CurrencyCode="INR" Description="Property Fee" Amount="333" Code="200">
                                            <TaxDescription>
                                                <Text>Property Fee</Text>
                                            </TaxDescription>
                                        </TaxGroup>
                                        <TaxGroup CurrencyCode="INR" Description="Tax Recovery Charges and Service Fees" Amount="9039" Code="201">
                                            <TaxDescription>
                                                <Text>Tax Recovery Charges and Service Fees</Text>
                                            </TaxDescription>
                                        </TaxGroup>
                                    </TaxGroups>
                                </Taxes>
                                <Fees CurrencyCode="INR" Amount="291">
                                    <FeeGroups>
                                        <FeeGroup CurrencyCode="INR" Description="Miscellaneous fee" Amount="291" Code="54">
                                            <FeeDescription>
                                                <Text>Mandatory Fee</Text>
                                            </FeeDescription>
                                        </FeeGroup>
                                    </FeeGroups>
                                </Fees>
                                <CancelPenalties>
                                    <CancelPenalty Refundable="false"/>
                                </CancelPenalties>
                                <Guarantee GuaranteeType="DEP">
                                    <GuaranteesAccepted>
                                        <GuaranteeAccepted GuaranteeTypeCode="5" GuaranteeTypeDescription="Credit card"/>
                                    </GuaranteesAccepted>
                                </Guarantee>
                            </ConvertedRateInfo>
                        </RatePlan>
                    </RatePlans>
                </Room>
            </Rooms>
            <AvailableRatePlans>
                <AvailableRatePlan RatePlanType="10" ClientId="BAK" RateSource="100" RatePlanCode="DAN"/>
                <AvailableRatePlan RatePlanType="10" ClientId="JOV" RateSource="100" RatePlanCode="MAR"/>
                <AvailableRatePlan RatePlanType="22" ClientId="CWT" RateSource="100" RatePlanCode="CWT"/>
            </AvailableRatePlans>
        </HotelRateInfo>
    </HotelRateInfos>
</GetHotelLeadRateRS>