POST/v1/hotels/search

Rechercher des hôtels disponibles

Searches available hotels by location, dates, occupancy and commercial filters, then applies company-level pricing rules.

Searches available hotels by location, dates, occupancy and commercial filters, then applies company-level pricing rules.

Endpoint

MethodPathAuth
POST/v1/hotels/searchRequired API key
Required headers:
HeaderDescription
AuthorizationBearer <secret_key>. The secret is shown only once when the credential is created.
X-Travelandz-Id<public_key>:<profile_code>. The profile_code is the dp_-prefixed Developer Profile code shown in your dashboard. This binds the request to a profile and credential.
Content-TypeUse application/json for requests with a body.

Request Body Schema

PropertyTypeDetailsRequiredNotes
languageenum
eneszh
NoDefault en
checkInstring
Format: YYYY-MM-DD
Yes-
checkOutstring
Format: YYYY-MM-DD
Yes-
locationobjectYes-
locationsearchBy
enum
coords
Yes-
locationlatitude
numberYes-
locationlongitude
numberYes-
searchRadiusnumberNoMinimum value: 1
countryCodestring
Format: 2 digits
Yes-
nationalitystring
Format: 2 digits
Yes-
maxHotelsnumberNoMaximum value: 2000
minRatenumberNo-
maxRatenumberNo-
minCategoryenum
12345
No-
maxCategoryenum
12345
No-
refundableenum
allrefundablenon-refundable
Yes-
roomsarrayYes-
rooms[]adults
numberYesMinimum value: 1, Maximum value: 4
rooms[]children
numberNoMinimum value: 0, Maximum value: 4
rooms[]childrenAges
arrayYes-
rooms[]childrenAges[]
number[]Yes-
currencyenum
EURUSDCNY
NoDefault EUR
retrieveBookingLinkbooleanNoDefault false

Success Response

Returns hotel results, availability, min rates and optional booking links.

Response Body Schema

PropertyTypeDetailsRequiredNotes
hotelsarrayYes-
hotels[]gdsprovider
numberYes-
hotels[]offerLink
stringNo-
hotels[]hotelId
stringYes-
hotels[]code
stringYes-
hotels[]name
stringYes-
hotels[]description
objectYes-
hotels[]descriptionlang
enum
eneszh
Yes-
hotels[]descriptiondescription
stringYes-
hotels[]starRating
numberYes-
hotels[]reviewCount
numberNo-
hotels[]accommodationType
stringYes-
hotels[]chain
stringNullable-
hotels[]address
objectYes-
hotels[]addressstreet
stringNo-
hotels[]addresscountryCode
stringNo-
hotels[]addresscountry
stringNo-
hotels[]addressdestination
stringNo-
hotels[]addresszone
stringNo-
hotels[]location
objectYes-
hotels[]locationtype
stringYes-
hotels[]locationcoordinates
arrayYes-
hotels[]locationcoordinates[]
number[]
Format: [longitude, latitude]
Yes-
hotels[]latitude
numberYes-
hotels[]longitude
numberYes-
hotels[]roomsNames
arrayYes-
hotels[]roomsNames[]
string[]Yes-
hotels[]boardTypes
arrayYes-
hotels[]boardTypes[]
string[]Yes-
hotels[]hasRefundableRooms
booleanYes-
hotels[]images
arrayYes-
hotels[]images[]
string[]Yes-
hotels[]amenities
arrayYes-
hotels[]amenities[]
string[]Yes-
hotels[]minPrice
numberYes-
hotels[]roomCount
numberNo-