Skip to main content

Get Hotel Avail

4.0.0
Hotel
Search
SOAP API
Travel Agency

The Get Hotel Availability (GetHotelAvailRQ) API is used to retrieve hotel availability by customizable parameters and filters.

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.

Target Audience
Travel Agency
API Version
4.0.0
Authentication
Session or Sessionless Tokens
Service Action Code
GetHotelAvailRQ

What is it?

The Get Hotel Availability API provides multiple location resolution methods (or a specific property search) for a specific stay period and occupancy. It has multiple advanced search filter options based on property/image content and enables customization of the availability response. It returns up to 200 hotels per page, sorted on one of three user-selectable criteria: Rate, Distance, and Rating.

Why use it?

Use this API to see an orchestrated response that includes a list of properties with their leading image, static content (such as amenities offered and location information), and the lowest rate available for each property through multiple channels.

How does it work?

  1. Hotels falling within a user's search location are retrieved using the Geo Search API.
  2. User requested filters, such as Rating, are applied to the list of hotels.
  3. Static information, a default image, and the lowest rate for each source, is then fetched for the filtered list of hotels.
  4. The Get Hotel Availability SOAP API then orchestrates all this information in its response.

This orchestrated API can be used in multiple ways and includes multiple search parameters and filters. 

How do I use it?

Search for hotels in a general location using any of the following location formats: ​​​​

  • Latitude and Longitude
  • Address of the location
  • Airport Codes
  • Nearest point(s) of interest
  • If you already know the HotelCodes you want to shop, you can also input these directly.

Decide on filtering criteria: 

  1. Decide on filtering criteria if you wish to apply any filters to the response.
  2. Specify the stay period and occupancy.
  3. With all required parameters complete, make a call to GetHotelAvailRQ.

The response will include a unique rate code for each rate, which can be used to book that rate. The Rate Key returned in Shopping responses does not expire so can be used in the HotelPriceCheck request at any time. The rate itself may have expired, but this will be reflected in the HotelPriceCheck response.

Important! The rate code has to be referenced in the Hotel Price Check API.

Request structure

Refer to the Request Design XML under the Resources tab for an XML view of the request structure.

Response structure

Refer to the Response Design XML under the Resources tab for an XML view of the response structure.

Sample Request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <SOAP-ENV:Header>
        <eb:MessageHeader eb:version="3.0.0" xmlns:eb="http://www.ebxml.org/namespaces/messageHeader">
            <eb:From>
                <eb:PartyId>1900</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>GetHotelAvailRQ</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:CustomerAppId xmlns:ns10="http://webservices.sabre.com/">SWS1:SBR-GetThere:01a86cdc9c</eb:CustomerAppId>
        </eb:MessageHeader>
        <wsse:Security xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/12/secext">
            <wsse:BinarySecurityToken>{{usg-session-token}}</wsse:BinarySecurityToken>
        </wsse:Security>
    </SOAP-ENV:Header>
    <SOAP-ENV:Body>
        <GetHotelAvailRQ xmlns="http://services.sabre.com/hotel/avail/v4_0_0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="4.0.0" xsi:schemaLocation="http://services.sabre.com/hotel/avail/v4_0_0 GetHotelAvailRQ_v4.0.0.xsd">
            <SearchCriteria OffSet="2" SortBy="DistanceFrom" SortOrder="DESC" PageSize="2" TierLabels="true" RateDetailsInd="true">
                <GeoSearch>
                    <GeoRef Radius="200" UOM="MI">            
                        <RefPoint Value="DFW" ValueContext="CODE" RefPointType="6" StateProv="TX" CountryCode="US"/>          
                    </GeoRef>
                </GeoSearch>
                <RateInfoRef CurrencyCode="USD" BestOnly="1" PrepaidQualifier="IncludePrepaid" RefundableOnly="true" ConvertedRateInfoOnly="true">
                    <StayDateTimeRange StartDate="2021-05-20" EndDate="2021-05-23"/>          
                    <Rooms>
                        <Room Index="1" Adults="1" Children="1">
                            <ChildAges>1</ChildAges>
                        </Room>
                    </Rooms>          
                    <RateSource>100</RateSource>
                </RateInfoRef>
                <HotelPref>
                    <SabreRating Min="1" Max="5"/>
                </HotelPref>
                <ImageRef Type="ORIGINAL" CategoryCode="2" LanguageCode="EN"/>
            </SearchCriteria>
        </GetHotelAvailRQ>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Sample Response
<GetHotelAvailRS>
    <HotelAvailInfos MaxSearchResults="1000" ShopKey="95fc6db5-6c0d-45bd-8645-032e72fa0986" OffSet="1" SearchLongitude="-97.041111" SearchLatitude="32.896111">
        <HotelAvailInfo>
            <HotelInfo HotelCode="100097608" SabreRating="3.0" BrandCode="10000" Direction="E" Logo="http://vcmp-hotels.cert.sabre.com/image/upload/f_auto,q_auto:best,t_vcmp_logo/hotel/l/xv/XV.png" BrandName="undefined" UOM="MI" ChainName="Springhill Suites" ChainCode="XV" CodeContext="GLOBAL" Ordinal="1" SabreHotelCode="50740" HotelName="Springhill Suites By Marriott Shreveport Bossier City" Distance="199.72">
                <LocationInfo Latitude="32.54992" Longitude="-93.629739">
                    <Address>
                        <AddressLine1>8010 East Texas Street</AddressLine1>
                        <CityName CityCode="SHV">Bossier City</CityName>
                        <StateProv StateCode="LA"/>
                        <PostalCode>71111</PostalCode>
                        <CountryName Code="US">United States of America</CountryName>
                    </Address>
                    <Contact Phone="318-747-7772" Fax="318-747-7727"/>
                </LocationInfo>
                <Amenities>
                    <Amenity Description="Meal plan available" Code="162"/>
                    <Amenity Description="Onsite laundry" Code="168"/>
                    <Amenity Description="Non-smoking rooms (generic)" Code="198"/>
                    <Amenity Description="Stay Safe" Code="2002"/>
                    <Amenity Description="Local Calls" Code="2004"/>
                    <Amenity Description="Family Room" Code="2014"/>
                    <Amenity Description="Crib charge" Code="2017"/>
                    <Amenity Description="Extra person" Code="2018"/>
                    <Amenity Description="Complimentary breakfast" Code="227"/>
                    <Amenity Description="Conference facilities" Code="24"/>
                    <Amenity Description="Data port" Code="255"/>
                    <Amenity Description="High speed internet access" Code="259"/>
                    <Amenity Description="Interior corridors" Code="260"/>
                    <Amenity Description="Free parking" Code="42" ComplimentaryInd="true"/>
                    <Amenity Description="Game room" Code="44"/>
                    <Amenity Description="Health club" Code="48"/>
                    <Amenity Description="Indoor pool" Code="54"/>
                    <Amenity Description="Pool" Code="71"/>
                    <Amenity Description="Dry cleaning" Code="96"/>
                </Amenities>
                <SecurityFeatures>
                    <SecurityFeature Description="Complies with Local/State/Federal fire laws" Code="9"/>
                </SecurityFeatures>
                <PropertyTypeInfo>
                    <PropertyType Description="All suite" Code="1"/>
                </PropertyTypeInfo>
                <PropertyQualityInfo>
                    <PropertyQuality Description="Regular" Code="5"/>
                </PropertyQualityInfo>
            </HotelInfo>
            <HotelRateInfo>
                <RateInfos>
                    <ConvertedRateInfo StartDate="2021-05-20" CurrencyCode="USD" AmountAfterTax="334.59" AdditionalFeesInclusive="true" AmountBeforeTax="289.80" AverageNightlyRate="111.53" RateKey="n7d7EwYGfD2zRTuNXA9Y4cDBxThsaE3RNx4jYdfRwOoH08r4s+89KhD+9UtEE3BIWQfGZFdCo4WE5ZFQq2yRaxZqezIXpgBwu45kSHVQZTwX2KFJuhoyhJfGLEu3N2lVI+cYcPqopaEERoPV2FS+nfxGVPO+fl04/6maG+cAqLRYmQLMf83lXoNsVFOzzKaGMaWDfbHx6Io3ytKkJipZ41yO392IOcM+vDxSHmAB61Zu6bQjKQyAwZ3vopQEjZg7iGaGBuzVsDVWPpr3q9On4WKGJIYcwuCCD1zuD6yiO77QN30zC37MlpOXZ85XIft6zPmCQfGbmZX/yx0vWR9dS3u7O+dSk95KIskspD0hYc8xvKVr3b3Umri4pvLApZVOnaRkpDs5VuVFPBapY9D20OleuXIcKGCt62eBHIWgwAmVEtgUTYvgYn42XTeXo/Y43G6v79VXjmnxoiL3SB3lEg==" AverageNightlyRateBeforeTax="96.60" RateSource="100" EndDate="2021-05-23" TaxInclusive="true">
                        <Commission Type="Variable">
                            <CommissionDescription>
                                <Text>COMMISSIONABLE</Text>
                            </CommissionDescription>
                        </Commission>
                    </ConvertedRateInfo>
                </RateInfos>
                <Rooms>
                    <Room RoomIndex="1">
                        <RoomDescription Name="AAA HOT DEALS">
                            <Text>AAA HOT DEALS, STUDIO, 1 KING, SOFA BED</Text>
                        </RoomDescription>
                        <RatePlans>
                            <RatePlan RatePlanType="13" ProductCode="AABS00" RatePlanName="AAA HOT DEALS" RateKey="n7d7EwYGfD2zRTuNXA9Y4cDBxThsaE3RNx4jYdfRwOoH08r4s+89KhD+9UtEE3BIWQfGZFdCo4WE5ZFQq2yRaxZqezIXpgBwu45kSHVQZTwX2KFJuhoyhJfGLEu3N2lVI+cYcPqopaEERoPV2FS+nfxGVPO+fl04/6maG+cAqLRYmQLMf83lXoNsVFOzzKaGMaWDfbHx6Io3ytKkJipZ41yO392IOcM+vDxSHmAB61Zu6bQjKQyAwZ3vopQEjZg7iGaGBuzVsDVWPpr3q9On4WKGJIYcwuCCD1zuD6yiO77QN30zC37MlpOXZ85XIft6zPmCQfGbmZX/yx0vWR9dS3u7O+dSk95KIskspD0hYc8xvKVr3b3Umri4pvLApZVOnaRkpDs5VuVFPBapY9D20OleuXIcKGCt62eBHIWgwAmVEtgUTYvgYn42XTeXo/Y43G6v79VXjmnxoiL3SB3lEg==" RateSource="100" PrepaidIndicator="false" LimitedAvailability="false" RatePlanCode="Z2H">
                                <ConvertedRateInfo StartDate="2021-05-20" CurrencyCode="USD" AmountAfterTax="334.59" AdditionalFeesInclusive="true" AmountBeforeTax="289.80" AverageNightlyRate="111.53" AverageNightlyRateBeforeTax="96.60" EndDate="2021-05-23" TaxInclusive="true">
                                    <Rates>
                                        <Rate StartDate="2021-05-20" CurrencyCode="USD" AmountBeforeTax="92.70" EndDate="2021-05-21"/>
                                        <Rate StartDate="2021-05-21" CurrencyCode="USD" AmountBeforeTax="104.40" EndDate="2021-05-22"/>
                                        <Rate StartDate="2021-05-22" CurrencyCode="USD" AmountBeforeTax="92.70" EndDate="2021-05-23"/>
                                    </Rates>
                                    <Taxes CurrencyCode="USD" Amount="44.79">
                                        <Tax StartDate="2021-05-20" CurrencyCode="USD" Amount="14.32" EndDate="2021-05-21"/>
                                        <Tax StartDate="2021-05-21" CurrencyCode="USD" Amount="16.13" EndDate="2021-05-22"/>
                                        <Tax StartDate="2021-05-22" CurrencyCode="USD" Amount="14.32" EndDate="2021-05-23"/>
                                    </Taxes>
                                    <RoomExtras>
                                        <RoomExtra CurrencyCode="USD" Description="Extra adult charge" Amount="0.00" Code="196"/>
                                        <RoomExtra CurrencyCode="USD" Description="Cribs" Amount="0.00" Code="26"/>
                                    </RoomExtras>
                                    <CancelPenalties>
                                        <CancelPenalty Refundable="true">
                                            <Deadline OffsetDropTime="BeforeArrival" OffsetTimeUnit="Day" OffsetUnitMultiplier="1"/>
                                        </CancelPenalty>
                                    </CancelPenalties>
                                    <Guarantee GuaranteeType="GUAR">
                                        <GuaranteesAccepted>
                                            <GuaranteeAccepted GuaranteeTypeCode="5" GuaranteeTypeDescription="Credit card">
                                                <PaymentCards>
                                                    <PaymentCard CardCode="AX">AMERICAN EXPRESS</PaymentCard>
                                                    <PaymentCard CardCode="CB">CARTE BLANCHE</PaymentCard>
                                                    <PaymentCard CardCode="DC">DINERS CLUB CARD</PaymentCard>
                                                    <PaymentCard CardCode="DS">DISCOVER CARD</PaymentCard>
                                                    <PaymentCard CardCode="JC">JCB CREDIT CARD</PaymentCard>
                                                    <PaymentCard CardCode="IK">MASTER CARD</PaymentCard>
                                                    <PaymentCard CardCode="CA">MASTERCARD</PaymentCard>
                                                    <PaymentCard CardCode="VI">VISA</PaymentCard>
                                                </PaymentCards>
                                            </GuaranteeAccepted>
                                        </GuaranteesAccepted>
                                    </Guarantee>
                                </ConvertedRateInfo>
                            </RatePlan>
                        </RatePlans>
                    </Room>
                </Rooms>
            </HotelRateInfo>
        </HotelAvailInfo>
        <HotelAvailInfo>
            <HotelInfo HotelCode="100062484" SabreRating="2.5" BrandCode="10036" Direction="S" Logo="http://vcmp-hotels.cert.sabre.com/image/upload/f_auto,q_auto:best,t_vcmp_logo/hotel/l/hx/HX.png" BrandName="Hampton Inn" UOM="MI" ChainName="Hampton Inn" ChainCode="HX" CodeContext="GLOBAL" Ordinal="2" SabreHotelCode="32910" HotelName="Hampton Inn &amp; Suites Buda, Tx" Distance="199.7">
                <LocationInfo Latitude="30.084684" Longitude="-97.827498">
                    <Address>
                        <AddressLine1>1201 Cabelas Drive</AddressLine1>
                        <CityName CityCode="AUS">BUDA</CityName>
                        <StateProv StateCode="TX"/>
                        <PostalCode>78610</PostalCode>
                        <CountryName Code="US">United States of America</CountryName>
                    </Address>
                    <Contact Phone="1-512-295-4900" Fax="1-512-295-3999"/>
                </LocationInfo>
                <Amenities>
                    <Amenity Description="Wheelchair access" Code="101"/>
                    <Amenity Description="Meal plan available" Code="162">Y</Amenity>
                    <Amenity Description="Non-smoking rooms (generic)" Code="198"/>
                    <Amenity Description="Stay Safe" Code="2002"/>
                    <Amenity Description="Family Room" Code="2014">Y</Amenity>
                    <Amenity Description="Rollaway adult" Code="2016"/>
                    <Amenity Description="Crib charge" Code="2017"/>
                    <Amenity Description="Extra person" Code="2018"/>
                    <Amenity Description="Complimentary breakfast" Code="227" ComplimentaryInd="true"/>
                    <Amenity Description="Business center" Code="228"/>
                    <Amenity Description="Conference facilities" Code="24"/>
                    <Amenity Description="High speed internet access" Code="259"/>
                    <Amenity Description="Interior corridors" Code="260"/>
                    <Amenity Description="Free parking" Code="42">Y-ON SITE</Amenity>
                    <Amenity Description="Game room" Code="44"/>
                    <Amenity Description="Health club" Code="48"/>
                    <Amenity Description="Indoor pool" Code="54"/>
                    <Amenity Description="Hot Tub" Code="55"/>
                    <Amenity Description="Pool" Code="71"/>
                </Amenities>
                <SecurityFeatures>
                    <SecurityFeature Description="Complies with Local/State/Federal fire laws" Code="9">Y</SecurityFeature>
                </SecurityFeatures>
                <PropertyQualityInfo>
                    <PropertyQuality Description="Regular" Code="5"/>
                </PropertyQualityInfo>
            </HotelInfo>
            <HotelRateInfo>
                <RateInfos>
                    <ConvertedRateInfo StartDate="2021-05-20" CurrencyCode="USD" AmountAfterTax="539.80" AdditionalFeesInclusive="true" AmountBeforeTax="477.70" IncidentalsInclusive="false" AverageNightlyRate="179.93" RateKey="vQ41lfX5MFCoxDqbVFPDnoeoa2ldGcpXy0ljC9uAqlW2AZ/Jxi6iIPqGnMV3zYuarfm+Ai1mk+mlEGEuyRzZba0+61DfeAUIJkwX2UsjKcnOPaJmCuYzQWvNzKyHJt8g/CWJMz74z2DvYTj9wslF4UyopQC8+FxVBZfCVPCK1UDlxNy8DCJXRP2ExTmeZqDvGfjEfeufZujJV0VIxPR2etHA1ehgbS0Ot2+G1z6p5d2IiPXoenWbLmh2lSylAo4YAkT20fKVySmYWwGmRNnvNHri6g8A9SFIR/nZx5JuVVTDe+hmCX6lbwtJAxRHz1XRuKL5xzWuAwwWi64MuX5e1JPYOvp3QbR4x4EnddUp/rxAkqEubBPMR+DhLFoZkmFVO0+gW1QPrECo6Yj14Hq2Lj/gb9KImM/blXcVFXhwSNCECyDPV1ptF4s94KW8q8yj" AverageNightlyRateBeforeTax="159.23" RateSource="100" EndDate="2021-05-23" TaxInclusive="true">
                        <Commission Type="Percentage" Percent="10.00">
                            <CommissionDescription>
                                <Text>COMMISSIONABLE</Text>
                            </CommissionDescription>
                        </Commission>
                    </ConvertedRateInfo>
                </RateInfos>
                <Rooms>
                    <Room RoomIndex="1">
                        <RoomDescription Name="DREAM AWAY">
                            <Text>1 KING BED NONSMOKING FREE WI-FI/32 INCH HDTV</Text>
                        </RoomDescription>
                        <RatePlans>
                            <RatePlan RatePlanType="13" ProductCode="A03BTP" RatePlanName="DREAM AWAY" RateKey="vQ41lfX5MFCoxDqbVFPDnoeoa2ldGcpXy0ljC9uAqlW2AZ/Jxi6iIPqGnMV3zYuarfm+Ai1mk+mlEGEuyRzZba0+61DfeAUIJkwX2UsjKcnOPaJmCuYzQWvNzKyHJt8g/CWJMz74z2DvYTj9wslF4UyopQC8+FxVBZfCVPCK1UDlxNy8DCJXRP2ExTmeZqDvGfjEfeufZujJV0VIxPR2etHA1ehgbS0Ot2+G1z6p5d2IiPXoenWbLmh2lSylAo4YAkT20fKVySmYWwGmRNnvNHri6g8A9SFIR/nZx5JuVVTDe+hmCX6lbwtJAxRHz1XRuKL5xzWuAwwWi64MuX5e1JPYOvp3QbR4x4EnddUp/rxAkqEubBPMR+DhLFoZkmFVO0+gW1QPrECo6Yj14Hq2Lj/gb9KImM/blXcVFXhwSNCECyDPV1ptF4s94KW8q8yj" RateSource="100" PrepaidIndicator="false" LimitedAvailability="false" RatePlanCode="RAC">
                                <ConvertedRateInfo StartDate="2021-05-20" CurrencyCode="USD" AmountAfterTax="539.80" AdditionalFeesInclusive="true" AmountBeforeTax="477.70" IncidentalsInclusive="false" AverageNightlyRate="179.93" AverageNightlyRateBeforeTax="159.23" EndDate="2021-05-23" TaxInclusive="true">
                                    <Rates>
                                        <Rate StartDate="2021-05-20" CurrencyCode="USD" AmountBeforeTax="156.40" EndDate="2021-05-21"/>
                                        <Rate StartDate="2021-05-21" CurrencyCode="USD" AmountBeforeTax="160.65" EndDate="2021-05-23"/>
                                    </Rates>
                                    <Taxes CurrencyCode="USD" Amount="62.10"/>
                                    <RoomExtras>
                                        <RoomExtra CurrencyCode="USD" Description="Extra adult charge" Amount="0.00" Code="196"/>
                                        <RoomExtra CurrencyCode="USD" Description="Cribs" Amount="0.00" Code="26"/>
                                        <RoomExtra CurrencyCode="USD" Description="Rollaway bed" Amount="20.00" Code="91"/>
                                    </RoomExtras>
                                    <CancelPenalties>
                                        <CancelPenalty Refundable="true">
                                            <Deadline OffsetDropTime="BeforeArrival" OffsetTimeUnit="Hour" OffsetUnitMultiplier="24"/>
                                        </CancelPenalty>
                                    </CancelPenalties>
                                    <Guarantee GuaranteeType="GUAR">
                                        <GuaranteesAccepted>
                                            <GuaranteeAccepted GuaranteeTypeCode="5" GuaranteeTypeDescription="Credit card">
                                                <PaymentCards>
                                                    <PaymentCard CardCode="AX">AMERICAN EXPRESS</PaymentCard>
                                                    <PaymentCard CardCode="CA">MASTERCARD</PaymentCard>
                                                    <PaymentCard CardCode="CB">CARTE BLANCHE</PaymentCard>
                                                    <PaymentCard CardCode="DC">DINERS CLUB CARD</PaymentCard>
                                                    <PaymentCard CardCode="DS">DISCOVER CARD</PaymentCard>
                                                    <PaymentCard CardCode="IK">MASTER CARD</PaymentCard>
                                                    <PaymentCard CardCode="VI">VISA</PaymentCard>
                                                </PaymentCards>
                                            </GuaranteeAccepted>
                                        </GuaranteesAccepted>
                                    </Guarantee>
                                </ConvertedRateInfo>
                            </RatePlan>
                        </RatePlans>
                    </Room>
                </Rooms>
            </HotelRateInfo>
        </HotelAvailInfo>
    </HotelAvailInfos>
</GetHotelAvailRS>