GetBestProperty

GetBestProperty

The GetBestProperty API enables clients to search for the best available hotel properties within a specified destination (city or region), based on check-in/check-out dates and occupancy.

---

Use Case

Ideal for travel portals, hotel booking engines, or any partner wanting to offer real-time hotel search results by destination code.

---

Endpoint

GET [SD-Domain]/api/SmartDistribution/bestproperties?checkin=2025-06-09&checkout=2025-06-11&occupancy=A1&destinationCode=MLA

---

Authentication & Authorization

Type	Description
apikey	API Key provided by RateGain
apisecret	API Secret provided by RateGain

---

Required Headers

Header	Value / Example
accept	application/json, text/plain, /
apikey	RGKEY3HVW63CF9HQU
apisecret	SECRETLCSPQDZCMYBYJ9CU
content-type	application/json

---

Request Body (JSON Structure)

{

"destinationCode": "CUN",

"checkin": "2025-08-07",

"checkout": "2025-08-08",

"adults": "2",

"children": [],

"numberOfrooms": 1

}

---

Request Fields Description

Field	Type	Required	Description
destinationCode	string	Yes	Code of the destination (from GetDestinations API)
checkin	string	Yes	Check-in date in YYYY-MM-DD format
checkout	string	Yes	Check-out date in YYYY-MM-DD format
adults	string	Yes	Number of adults per room
children	array	Yes	List of child ages (can be an empty array [])
numberOfrooms	integer	Yes	Number of rooms to search for

---

Success Response Sample

{

"body": [

{

"propertyId": "ChIJW2JYUwMsTI8RKPvP_FiR2LE",

"propertyName": "Antillano",

"description": "This hotel is located on Cancun",

"images": [],

"currency": "EUR",

"hotelCode": "59159",

"targetDate": "0001-01-01T00:00:00",

"roomCode": null,

"price": 41.76,

"numberOfRoom": 1,

"code": "59159",

"countryCode": "MX",

"countryName": "Mexico",

"stateCode": "CA",

"stateName": "CANCUN",

"destinationnCode": "CUN",

"destinationName": "Cancun (and vicinity)",

"zoneCode": "20",

"zoneName": "Zona centro",

"longitude": -86.83,

"latitude": -86.83,

"categoryCode": "3EST",

"categoryName": "3 STARS",

"categoryGroupCode": "GRUPO3",

"categoryGroupDesc": "Includes 3-star hotels and rural hotels.",

"chainCode": null,

"chainName": null,

"accomodationType": "H",

"accMultiDesc": "Hotel",

"accTypeDesc": "Hotel",

"address": "Avenida Tulum y claveles N. 1, Av Tulum 4239",

"street": "Avenida Tulum y claveles N. 1, Av Tulum 4239",

"city": "CANCUN",

"postalCode": "77500",

"s2C": "2*",

"ranking": 43,

"hotelSegments": [],

"hotelBoard": [

{

"code": "AI",

"name": "ALL INCLUSIVE"

}

]

}

],

"status": true,

"description": null,

"statusCode": 200

}

---

Top-Level Response Fields

Field	Type	Description
body	array	List of best property results
status	boolean	API call success status
description	string	Error/response details if applicable (usually null)
statusCode	integer	HTTP status code (200 on success)

---

Hotel Object Fields (Inside body[])

Field	Type	Description
propertyId	string	Internal or Google Places ID of the hotel
propertyName	string	Hotel or property name
description	string	Full hotel description
images	array	List of image URLs or nulls
currency	string	Currency code for pricing (e.g., EUR)
hotelCode	string	Supplier-specific hotel code
targetDate	string	Date used for pricing reference (may be placeholder)
roomCode	string	Room identifier if available (can be null)
price	number	Total price for the specified stay
numberOfRoom	integer	Number of rooms priced
code	string	Duplicate of hotelCode
countryCode	string	ISO country code
countryName	string	Country name
stateCode	string	State or region code
stateName	string	State or region name
destinationnCode	string	Destination code (e.g., CUN)
destinationName	string	Destination label
zoneCode	string	Area/zone code within the destination
zoneName	string	Name of the area (e.g., Zona centro)
longitude	number	Longitude of the hotel
latitude	number	Latitude of the hotel
categoryCode	string	Hotel category/classification code (e.g., 3EST)
categoryName	string	Category description (e.g., 3 STARS)
categoryGroupCode	string	Broader classification code (e.g., GRUPO3)
categoryGroupDesc	string	Category group description
chainCode	string	Hotel chain code (if part of a chain; can be null)
chainName	string	Chain name (if any)
accomodationType	string	Accommodation type code (e.g., H for hotel)
accMultiDesc	string	General accommodation descriptor (e.g., Hotel)
accTypeDesc	string	Expanded accommodation type name
address	string	Full address
street	string	Street address
city	string	City name
postalCode	string	ZIP/postal code
s2C	string	Star rating string (e.g., "2*")
ranking	integer	Internal or review-based ranking
hotelSegments	array	Reserved for additional segmentation
hotelBoard	array	List of available board types (meal plans)

---

Hotel Board Array Fields

Each item in the hotelBoard array includes:

Field	Type	Description
supplier	string	Supplier providing the board plan
code	string	Board code (e.g., AI, RO, BB)
name	string	Full name of the board (e.g., "ALL INCLUSIVE")

---

Common Board Codes

Code	Name
AI	All Inclusive
BB	Bed and Breakfast
CB	Continental Breakfast
FB	Full Board
HB	Half Board
RO	Room Only

---

Notes

• targetDate might appear as "0001-01-01T00:00:00" (placeholder); actual pricing dates are derived from the request.

• images may contain null if no URL is available.

• hotelBoard can be used to filter hotels based on board preferences (e.g., breakfast included).