Skip to main content

Hotel Search

1.0.0
Hotel
Search
SOAP API
Travel Agency

The Hotel Search (HotelSearchRQ) is used to retrieve a list of hotel properties, along 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
1.0.0
Authentication
Session or Sessionless Tokens
Service Action Code
HotelSearchRQ

What is it?

The Hotel Search API provides multiple location resolution methods (including polygon search) to search and retrieve matching property content that does not contain availability.

Why use it?

Retrieve an orchestrated list of properties with images and static content (such as amenities offered and location information) without the need to provide a specific stay period for availability. Hotel Search utilizes multiple advanced search filter options based on property/image content and enables customization of the search response. It can return up to 300 hotels, sorted using one of two criteria: Distance and Sabre Rating.

How does it work?

  1. Hotels falling within a given search location are retrieved using the Geo Search API.
  2. Apply a filter, such as Sabre Rating, in the call to narrow your search.
  3. Static information and a default image are then fetched for the filtered list of hotels.

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

How do I use it?

You can search for hotels in a general location using any of the following location formats: ​​​​

  • Latitude and longitude
  • Address of the location
  • Airport/city codes
  • Nearest point(s) of interest
  • Polygon IDs

Decide on filtering criteria: 

  1. Decide on the filtering criteria you'd like to use, if you wish to apply any filters to the response at all. Refer to the request documentation below for a full list of filtering criteria.
  2. With all required parameters complete, make a call to HotelSearchRQ.

Request Structure

Element

Attribute

Description

SearchCriteria

 

 

 

Required

The request root element.

 

 

MaxResults

Indicates the maximum number of properties to be returned in the response.

Note: Can request 1 to 300 properties. Defaults to 300.

 

 

SortBy

Indicates the criteria to sort properties by.

Can be DistanceFromSabreRating. Defaults to DistanceFrom.

 

 

SortOrder

Indicates whether results should be sorted in ascending or descending order. This attribute takes a default value based on SortBy.

  • DistanceFrom = ASC
  • SabreRating = DESC

Defaults to ASC -Ascending order.

 

 

TierLabels

If true, the TierLabel value is visible for preference properties in the response.

 

GeoSearch

 

This element contains parameters to search properties by geographic information.

 

GeoRef

 

Required

Contains attributes to search properties by geographic information. 

 

 

Radius

Radius to be included in the search from the search point.

Example: 20

 

 

UOM

Identifies the unit of measure in either KM for kilometers, or MI for miles.

Example: KM

 

GeoCode

 

Contains attributes to search by latitude and longitude. Use only ONE of GeoCode / RefPoint / AddressRef to search.

 

 

Latitude

Latitude to search by.

Example: 22.27774

 

 

Longitude

Longitude to search by.

Example: 114.16541

 

RefPoint

 

Contains attributes to search by reference point, such as airport code.

Use only ONE of GeoCode / RefPoint / AddressRef to search.

 

 

Value

Value of the reference point.

Example: DFW

 

 

ValueContext

Identifies the type of information entered into Value. Can be CODE or NAME.

Example: CODE

 

 

RefPointType

OTA (Online Travel Agency) code for the point of reference. Can be 6, 7, 11, 16, 37.

Example: 6

  • 6 = IATA Airport Code e.g. DFW, LHR, NYC
  • 7 = Rail Station e.g. Euston
  • 11 = Global Property ID e.g. 100072188
  • 16 = Point of Interest e.g. Statue of Liberty, Buckingham Palace
  • 37 = Area / Neighborhood (polygon search)

 

StateProv

State or province of the reference point.

Example: TX

 

 

CountryCode

Country code of the reference point.

Example: US

 

AddressRef

 

Contains attributes to search by address. Use only

ONE of GeoCode / RefPoint / AddressRef to search.

 

 

Street

Street name of the address.

Example: Hidden Ridge

 

 

City

City name of the address.

Example: Irving

 

 

County

County name of the address.

Example: Dallas County

 

 

PostalCode

Postal code of the address.

Example: 75038

 

 

StateProv

State or province of the address.

Example: TX

 

 

CountryCode

Country code of the address.

Example: US

 

GeoAttributes

 

Contains hotel list filters based on neighborhoods returned by GeoRef. The filter is applied only when a search is done using RefPoint with RefPointType = 37 (polygon search).

 

 

Name

Filters the property by name. Can only be LOCALAREA - all other values will be ignored.

 

 

Value

Filters the response to only include

hotels inside a specified area when Name = LOCALAREA.

Example: KRAKOW AREA

 

HotelPref

 

Specifies search filters. HotelPref should have at least one search/filter in the request, and can be one of:

  • HotelName
  • BrandCodes
  • ChainCodes
  • AmenityCode
  • PropertyTypeCodes
  • SabreRating
  • SecurityFeatureCode

            

 

HotelName

Optional

Specifies hotel name (minimum 3 characters) to be searched or used in the search filter.

Example: Inn

 

BrandCodes

 

Specifies the Brand Code of the hotel to be searched or used in the search filter.

Example: 10022

 

ChainCodes

 

Specifies the Chain Code of the hotel to be searched or used in the search filter.

Example: MC

 

AmenityCodes

 

Indicates if properties returned in the response should have all amenities or at least one of the amenities requested.

Example: 24

 

 

Inclusive

If true, the returned properties must have all the requested amenity codes.

If false, the returned properties must have at least one of the requested codes. Defaults to false.

 

SecurityFeatureCodes

 

Specifies security features, mapped to the OTA code SEC, to be searched or used in filtering results.

Example: The OTA (SEC) code 9 is used to request the security feature: "Complies with Local/State/Federal fire laws"

Example: 15/20

 

 

Inclusive

Indicates if properties returned in the response should contain all the Security features requested, or at least one (1) of the Security features requested.

If false, properties returned in the response must have at least one of the requested security features. This is the default value.

If true, properties returned in the response must have all the requested security features.

 

PropertyTypeCodes

 

Specifies the Property Class Type to be searched or used in the search, mapped to the OTA code PTC.

Example: 1

 

SabreRating

 

Contains filters for all properties to ensure that their ratings fall between a specified Min/Max rating.

 

 

Min

Properties returned in the response will have a rating greater than this value. Defaults to 0 if Max is specified but Min is not.

Example: 1.5

 

 

Max

Properties returned in the response will have a rating lower than this value. Defaults to 5 if Min is specified but Max is not.

Example: 4.5

 

ImageRef

 

Contains hotel image details.

 

Type

Identifies the image type to be returned in the response. Can be:

  • THUMBNAIL (Default) - Responds with the image in thumbnail dimensions (100x150)
  • ORIGINAL - Responds with the image's original dimensions
  • SMALL - Responds with the image in small dimensions (200x200)
  • MEDIUM - Responds with the image in medium dimensions (400x400)
  • LARGE - Responds with the image in large dimensions (800x800)

 

 

CategoryCode

Category of the image being requested, mapped to the OTA PIC table. Can be:

  • Exterior View - 1
  • Lobby view - 2
  • Pool view - 3
  • Restaurant - 4
  • Health Club - 5
  • Guest Room - 6
  • Suite - 7
  • Meeting Room - 8
  • Ballroom - 9
  • Golf Course - 10
  • Beach - 11
  • Spa - 12
  • Bar / Lounge - 13
  • Recreational - 14
  • Logo - 15
  • Basics - 16
  • Map - 17
  • Promotional - 18
  • Hotel News - 19
  • Miscellaneous - 20
  • Guest Room Amenity - 21
  • Property Amenity - 22
  • Business Center - 23

 

 

LanguageCode

The two-letter ISO 639-1 language code.

 

Sample Request
<HotelSearchRQ>
    <POS>
        <Source PseudoCityCode="TM91"/>
    </POS>
    <SearchCriteria MaxResults="300", SortBy="DistanceFrom" SortOrder="ASC" TierLabels="true" >
        <GeoSearch>
            <GeoRef Radius="20" UOM="KM">
                <GeoCode Latitude="22.27774" Longitude="114.16541"/>
                <RefPoint Value="DFW" ValueContext="CODE" RefPointType="6" StateProv="TX" CountryCode="US"/>
                <AddressRef Street="Hidden Ridge" City="Irving" County="Dallas County" PostalCode="75038" StateProv="TX" CountryCode="US"/>
            </GeoRef>
            <GeoAttributes>
                <Attributes Name="LOCALAREA" Value="KRAKOW AREA"/>
            </GeoAttributes>
        </GeoSearch>       
        <HotelPref HotelName="Inn">
            <BrandCodes>
                <BrandCode>10022</BrandCode>
                <BrandCode>10023</BrandCode>
            </BrandCodes>
            <ChainCodes>
                <ChainCode>MC</ChainCode>
                <ChainCode>HY</ChainCode>
            </ChainCodes>          
            <AmenityCodes Inclusive="true">            
                <AmenityCode>15</AmenityCode>
                <AmenityCode>20</AmenityCode>
            </AmenityCodes>
            <SecurityFeatureCodes Inclusive="true">            
                <SecurityFeatureCode>15</SecurityFeatureCode>
                <SecurityFeatureCode>20</SecurityFeatureCode>
            </SecurityFeatureCodes>
            <PropertyTypeCodes Inclusive="false">              
                <PropertyTypeCode>1</PropertyTypeCode>
                <PropertyTypeCode>12</PropertyTypeCode>
            </PropertyTypeCodes>           
            <SabreRating Min="1" Max="5"/>
        </HotelPref>
        <ImageRef Type="THUMBNAIL" CategoryCode="2" LanguageCode="AA"/>
    </SearchCriteria>
</HotelSearchRQ>
Sample Response
<HotelSearchRS>
    <HotelSearchInfos MaxSearchResults="1000" SearchLatitude="32.785781" SearchLongitude="-96.8012791" >
        <HotelSearchInfo>
            <HotelInfo HotelCode="100072188" CodeContext="GLOBAL" SabreHotelCode="8315" HotelName="Camino Real Saltillo" ChainCode="CM" ChainName="Hotel Camino Real" BrandCode="10022" BrandName="MARRIOTTCOURTYARD" Distance="3.13" Direction="NE" UOM="KM" SabreRating="3.0" CurrencyCode="USD" Logo="http://vcmp-hotels.sabre.com/image/upload/f_auto,q_auto:best,t_vcmp_logo/hotel/l/hi/HI.png" Ordinal="1">
                <TierLabels>
                    <TierLabel Type="Agency" Value="GOLD" ProgramId="23"/>
                    <TierLabel Type="Supplier" Value="PREMIUM" ProgramId="2"/>
                </TierLabels>
                <LocationInfo Latitude="25.91635" Longitude="-80.32567">
                    <Address>
                        <AddressLine1>15700 NW 77th Court</AddressLine1>
                        <AddressLine2>Irving</AddressLine2>
                        <AddressLine3>Irving texas</AddressLine3>
                        <CityName CityCode="FLL">Miami Lakes</CityName>
                        <StateProv StateCode="FL"> Florida </StateProv>
                        <PostalCode>25015</PostalCode>
                        <CountryName Code="US">United States</CountryName>
                    </Address>        
                    <Neighborhoods>
                        <Neighborhood Id="200004616">San José de los Cerritos</Neighborhood>
                    </Neighborhoods>
                    <Contact Phone="52 844 438 0000" Fax="844 438 0009" />
                </LocationInfo>
                <Amenities>
                    <Amenity Code="215" Description="Exhibition/convention floor" ComplimentaryInd="false">Ask at reception for fees</Amenity>
                    <Amenity Code="41" Description="Free airport shuttle"/>
                </Amenities>
                <SecurityFeatures>
                    <SecurityFeature Code="9" Description="Complies with Local/State/Federal fire laws">Fire safety law compliant</SecurityFeature>
                </SecurityFeatures>                
                <PropertyTypeInfo>
                    <PropertyType Code="3" Description="Apartment" />
                </PropertyTypeInfo>
            </HotelInfo>
            <HotelImageInfo>
                <ImageItem Id="7194333" Ordinal="2" Format="JPG" LastModifedDate="2019-09-29">
                    <Image Url="https://www.sabre.com/img/13.jpg" Type="THUMBNAIL" Height="100" Width="150" />
                    <Category CategoryCode="3">
                        <Description>
                            <Text Language="en">Pool view</Text>
                        </Description>
                    </Category>                    
                    <AdditionalInfo>
                        <Info Type="CAPTION">
                            <Description>
                                <Text Language="en">RI Torreon Pool</Text>
                            </Description>
                        </Info>
                    </AdditionalInfo>
                </ImageItem>
            </HotelImageInfo>
        </HotelSearchInfo>
    </HotelSearchInfos>
</HotelSearchRS>
Weight
0