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
| Method | Path | Auth |
|---|---|---|
POST | /v1/hotels/search | Required API key |
| Header | Description |
|---|---|
Authorization | Bearer <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-Type | Use application/json for requests with a body. |
Request Body Schema
| Property | Type | Details | Required | Notes |
|---|---|---|---|---|
language | enum | eneszh | No | Default en |
checkIn | string | Format: YYYY-MM-DD | Yes | - |
checkOut | string | Format: YYYY-MM-DD | Yes | - |
location | object | Yes | - | |
locationsearchBy | enum | coords | Yes | - |
locationlatitude | number | Yes | - | |
locationlongitude | number | Yes | - | |
searchRadius | number | No | Minimum value: 1 | |
countryCode | string | Format: 2 digits | Yes | - |
nationality | string | Format: 2 digits | Yes | - |
maxHotels | number | No | Maximum value: 2000 | |
minRate | number | No | - | |
maxRate | number | No | - | |
minCategory | enum | 12345 | No | - |
maxCategory | enum | 12345 | No | - |
refundable | enum | allrefundablenon-refundable | Yes | - |
rooms | array | Yes | - | |
rooms[]adults | number | Yes | Minimum value: 1, Maximum value: 4 | |
rooms[]children | number | No | Minimum value: 0, Maximum value: 4 | |
rooms[]childrenAges | array | Yes | - | |
rooms[]childrenAges[] | number[] | Yes | - | |
currency | enum | EURUSDCNY | No | Default EUR |
retrieveBookingLink | boolean | No | Default false |
Success Response
Returns hotel results, availability, min rates and optional booking links.
Response Body Schema
| Property | Type | Details | Required | Notes |
|---|---|---|---|---|
hotels | array | Yes | - | |
hotels[]gdsprovider | number | Yes | - | |
hotels[]offerLink | string | No | - | |
hotels[]hotelId | string | Yes | - | |
hotels[]code | string | Yes | - | |
hotels[]name | string | Yes | - | |
hotels[]description | object | Yes | - | |
hotels[]descriptionlang | enum | eneszh | Yes | - |
hotels[]descriptiondescription | string | Yes | - | |
hotels[]starRating | number | Yes | - | |
hotels[]reviewCount | number | No | - | |
hotels[]accommodationType | string | Yes | - | |
hotels[]chain | string | Nullable | - | |
hotels[]address | object | Yes | - | |
hotels[]addressstreet | string | No | - | |
hotels[]addresscountryCode | string | No | - | |
hotels[]addresscountry | string | No | - | |
hotels[]addressdestination | string | No | - | |
hotels[]addresszone | string | No | - | |
hotels[]location | object | Yes | - | |
hotels[]locationtype | string | Yes | - | |
hotels[]locationcoordinates | array | Yes | - | |
hotels[]locationcoordinates[] | number[] | Format: [longitude, latitude] | Yes | - |
hotels[]latitude | number | Yes | - | |
hotels[]longitude | number | Yes | - | |
hotels[]roomsNames | array | Yes | - | |
hotels[]roomsNames[] | string[] | Yes | - | |
hotels[]boardTypes | array | Yes | - | |
hotels[]boardTypes[] | string[] | Yes | - | |
hotels[]hasRefundableRooms | boolean | Yes | - | |
hotels[]images | array | Yes | - | |
hotels[]images[] | string[] | Yes | - | |
hotels[]amenities | array | Yes | - | |
hotels[]amenities[] | string[] | Yes | - | |
hotels[]minPrice | number | Yes | - | |
hotels[]roomCount | number | No | - | |