Skip to main content

Get Hotel List

3.0.0
Hotel
Search
SOAP API
Travel Agency

The Get Hotel List (GetHotelListRQ) API provides the user with a list of hotel properties, together with details of the property, according to the search criteria entered. 

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
3.0.0
Authentication
Session or Sessionless Tokens
Service Action Code
GetHotelListRQ

What is it?

The Get Hotel List API is used to fetch up to a maximum limit of 5,000 hotels based on search parameters like Hotel Property Code, Hotel Name, Brand Code, Chain Codes, Amenity Codes, Property Type Codes, and Sabre Ratings.

Why use it?

Use this API in tandem with the Content Services for Lodging (CSL) suite of APIs to enhance your booking tools:

  • In addition to retrieving a list of hotels, the Get Hotel List API also displays basic hotel information.
  • Look for properties using specific search criteria or property IDs.
  • Further customize the response by specifying the kinds of descriptions you'd like to see in the response, such as amenities, location info, property type info, and more.

How does it work?

To use this API, pass property IDs along with optional multiple search parameters and filters:

Search parameters:

  • Property Id is a mandatory input parameter, in case there are no search/filter criteria. The API user can request information for up to 5,000 properties in a single request

Additional search parameters and filters include:

  • Property Name - 3-20 characters which must be included in the property name
  • Property Status - Only active properties are included in the response
  • Brand information - Only properties belonging to certain brands and chains are included in the response
  • Chain - Can be used for both chains and master chains. Properties belonging to chains/Master chains requested are included in the response
  • Amenities - Only properties including the requested amenities are included in the response
  • Security Feature - Only properties including the requested security feature are included in the response
  • Sabre Rating - Rating filters to ensure all properties returned fall between the specified min/max rating values

The response will contain:

  • Property Id
  • Property name
  • Brand and Chain Information
  • Property status
  • Latitude and Longitude
  • Property contact information
  • Country code where the property is located
  • Amenities
  • Security feature
  • Sabre rating

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
<?xml version="1.0" encoding="UTF-8"?>
<!--Sample XML file generated by XMLSpy v2019 (x64) (http://www.altova.com)-->
<n1:GetHotelListRQ xmlns:n1="http://services.sabre.com/hotel/list/v3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="a" xsi:schemaLocation="http://services.sabre.com/hotel/list/v3 GetHotelListRQ_v3.xsd">
    <!--> POS Added for AAA scenario <-->
    <n1:POS>
        <n1:Source PseudoCityCode="0000"/>
    </n1:POS>
    <n1:HotelRefs>
        <n1:HotelRef HotelCode="!1234" CodeContext="SABRE"/>
    </n1:HotelRefs>
    <!--> Hotel Name with special characters<-->
    <n1:HotelPref HotelName="Example Hotel">
        <n1:BrandCodes>
            <n1:BrandCode>10000</n1:BrandCode>
        </n1:BrandCodes>
        <n1:ChainCodes>
            <n1:ChainCode>7E</n1:ChainCode>
        </n1:ChainCodes>
        <!--->Amenity code made OTA type<-->
        <n1:AmenityCodes Inclusive="true">
            <n1:AmenityCode>24</n1:AmenityCode>
        </n1:AmenityCodes>
        <!--->Security Feature code made OTA type<-->
        <n1:SecurityFeatureCodes Inclusive="false">
            <n1:SecurityFeatureCode>23</n1:SecurityFeatureCode>
        </n1:SecurityFeatureCodes>
        <!--->Property Type code made OTA type<-->
        <n1:PropertyTypeCodes Inclusive="true">
            <n1:PropertyTypeCode>15</n1:PropertyTypeCode>
        </n1:PropertyTypeCodes>
        <n1:SabreRating Min="1" Max="1"/>
    </n1:HotelPref>
    <n1:HotelInfoRef>
        <n1:LocationInfo>true</n1:LocationInfo>
        <n1:Amenities>true</n1:Amenities>
        <n1:PropertyTypeInfo>true</n1:PropertyTypeInfo>
        <!--->Filter for Security Feature <-->
        <n1:SecurityFeatures>true</n1:SecurityFeatures>
    </n1:HotelInfoRef>
</n1:GetHotelListRQ>
Sample Response
<?xml version="1.0" encoding="UTF-8"?>
<!--Sample XML file generated by XMLSpy v2019 (x64) (http://www.altova.com)-->
<n1:GetHotelListRS xmlns:n1="http://services.sabre.com/hotel/list/v3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:stlp="http://services.sabre.com/STL_Payload/v02_02" version="a" xsi:schemaLocation="http://services.sabre.com/hotel/list/v3 GetHotelListRS_v3.xsd">
    <stlp:ApplicationResults status="Unknown">
        <stlp:Success type="BusinessLogic" timeStamp="2001-12-17T09:30:47Z">
            <stlp:SystemSpecificResults timeStamp="2001-12-17T09:30:47Z" reference="ID1">
               
            </stlp:SystemSpecificResults>
        </stlp:Success>
        <stlp:Error type="Transport" timeStamp="2001-12-17T09:30:47Z">
            <stlp:SystemSpecificResults timeStamp="2001-12-17T09:30:47Z" reference="ID1">
               
            </stlp:SystemSpecificResults>
        </stlp:Error>
       
    </stlp:ApplicationResults>
    <n1:HotelInfos MaxSearchResults="0">
        <n1:HotelInfo HotelCode="a" CodeContext="GLOBAL" HotelName="a" ChainCode="a" ChainName="a" BrandCode="a" BrandName="a" SabreRating="a" CurrencyCode="AAA" SabreHotelCode="12345">
            <n1:TierLabels>
                <n1:TierLabel Type="a" Value="a" ProgramId=" "/>
            </n1:TierLabels>
            <n1:LocationInfo Latitude="a" Longitude="a">
                <n1:Address>
                    <n1:AddressLine1>a</n1:AddressLine1>
                    <n1:AddressLine2>a</n1:AddressLine2>
                    <n1:AddressLine3>a</n1:AddressLine3>
                    <n1:CityName CityCode="">a</n1:CityName>
                    <n1:StateProv StateCode="a">String</n1:StateProv>
                    <n1:PostalCode>a</n1:PostalCode>
                    <n1:CountryName Code="">String</n1:CountryName>
                </n1:Address>
                <n1:Neighborhoods>
                    <n1:Neighborhood Id="a">String</n1:Neighborhood>
                </n1:Neighborhoods>
                <n1:Contact Phone="a" Fax="a"/>
            </n1:LocationInfo>
            <n1:Amenities>
            <!---Amenity code made OTA type-->
            <!---Amenity text added-->
                <n1:Amenity Code="1" Description="a" ComplimentaryInd="true">Text</n1:Amenity>
            </n1:Amenities>
            <n1:SecurityFeatures>
            <!--->Security feature code made OTA type<-->
                <n1:SecurityFeature Code="a" Description="a">String</n1:SecurityFeature>
            </n1:SecurityFeatures>
            <n1:PropertyTypeInfo>
            <!--->Property Type Code made OTA type<-->
                <n1:PropertyType Code="a" Description="a"/>
            </n1:PropertyTypeInfo>
        </n1:HotelInfo>
    </n1:HotelInfos>
</n1:GetHotelListRS>