Search Hotels Master
Query Overview
The searchHotelsMaster query allows you to search for hotels created in Inventory based on their geocoordinates. The returned fields include:
idnameemailphonesfaxaddresspostalCodelatitudelongitudeexternalCodecategoryidname
localityidnamecountryCode
hotelCodecontextCode
1. Criteria
This query allows you to enter specific coordinates in the fields latitude and longitude and a distance parameter radiusKm to define a search area for hotels.
Additionally, you can filter the search results based on the hotel name or a part of the hotel name using the field hotelName.
Mandatory Input
latitudelongituderadiusKm
Optional Input
hotelName
2. Settings
To perform a search, provide the geographical coordinates of the desired location along with the search radius in kilometers. Optionally, you may specify a hotel name to refine the search results.
Response Considerations
The query returns a collection of hotels matching the criteria along with a success status and possible advise messages.
HotelsRs (OBJECT)
hotels(InventoryHotelMaster) - A collection of retrieved hotels.id(Int) - Unique identifier.name(String) - Hotel name.email(String) - Contact email.phones(String) - Phone numbers.fax(String) - Fax number.address(String) - Physical address.postalCode(String) - Postal code.latitude(Decimal) - Geographic latitude.longitude(Decimal) - Geographic longitude.category(InventoryCategory)id(Int) - Category ID.name(String) - Category name.
locality(InventoryLocality)id(Int) - Locality ID.name(String) - Locality name.countryCode(String) - ISO country code.
hotelCode(String) - Supplier's hotel code.contextCode(String) - Context code associated.
success(Boolean) - Indicates if the operation was successful.adviseMessages(AdviseMessage) - Messages related to the operation.
Query Inputs
InventoryHotelMasterFilterInput (INPUT_OBJECT)
Hotel master filter input.
Hotel master filter input.
hotelCodes (String)
Hotel codes of the hotels to retrieve.
Hotel codes of the hotels to retrieve.
countryCode (String)
Country code for the hotels to retrieve. https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
Country code for the hotels to retrieve. https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
localityId (Int)
Locality Id for the hotels to retrieve. Use query Location to get the available location Ids.
Locality Id for the hotels to retrieve. Use query Location to get the available location Ids.
contextCode (String)
Context code for the hotels.
Context code for the hotels.
Returned Fields
HotelsRs (OBJECT)
The HotelsRs class represents the response object for hotel-related operations.
The HotelsRs class represents the response object for hotel-related operations.
adviseMessages (AdviseMessage)
A collection of advise messages related to the operation. See AdviseMessage.
A collection of advise messages related to the operation. See AdviseMessage.
code * (ID)
AM code: The following codes can be returned:
AM code: The following codes can be returned:
description * (String)
Error description
Error description
level * (Enum of AdviseMessageLevel)
Indicates the level of importance of the message.
Possible values: ERROR, WARN, INFO.
Possible values:
WARN
ERROR
INFO
Indicates the level of importance of the message. Possible values: ERROR, WARN, INFO.
Possible values:
WARNERRORINFOexternal (ExternalMessage)
Specify the external message.
Specify the external message.
code (String)
External code.
External code.
message * (String)
External message.
External message.
correlationID * (ID)
Identifier to investigate the cause of the error.
Identifier to investigate the cause of the error.
hotels (InventoryHotelMaster)
A collection of hotels. See Hotel.
A collection of hotels. See Hotel.
id * (Int)
The unique identifier of the hotel.
The unique identifier of the hotel.
name (String)
The name of the hotel.
The name of the hotel.
email (String)
The email address of the hotel.
The email address of the hotel.
phones (String)
The list of phone numbers of the hotel.
The list of phone numbers of the hotel.
fax (String)
The fax number of the hotel.
The fax number of the hotel.
address (String)
The physical address of the hotel.
The physical address of the hotel.
postalCode (String)
The postal code of the hotel's location.
The postal code of the hotel's location.
latitude (Decimal)
The latitude of the hotel's location.
The latitude of the hotel's location.
longitude (Decimal)
The longitude of the hotel's location.
The longitude of the hotel's location.
externalCode (String)
The external code of the hotel.
The external code of the hotel.
category (InventoryCategory)
The category of the hotel.
The category of the hotel.
id * (Int)
Category Id.
Category Id.
name (String)
Category Name.
Category Name.
locality (InventoryLocality)
The locality of the hotel.
The locality of the hotel.
id * (Int)
Unique identifier for the locality.
Unique identifier for the locality.
name (String)
Name of the locality.
Name of the locality.
countryCode (String)
ISO 2-character country code associated with the locality.
ISO 2-character country code associated with the locality.
unLocode (String)
UN/LOCODE associated with the locality.
UN/LOCODE associated with the locality.
hotelCode (String)
The code of the hotel.
The code of the hotel.
contextCode (String)
The context code of the hotel.
The context code of the hotel.
success * (Boolean)
Indicates whether the operation was successful.
Indicates whether the operation was successful.
Examples
Search for Hotel masters by their geolocation
With this example, we are going to search for hotels that are located in a 10km radius from TravelgateX's office located in Palma de Mallorca.
Search for Hotel masters by their geolocation and filter by Hotel name
Now, we want to filter previous results by introducing the filter hotelName and we are trying to search for hotels that are close to the sea, so we will asume that some hotels have "mar" in their name.