POST/v1/hotels/offers
Get hotel room offers
Returns rooms, rates, board types and cancellation policies for a selected hotel and stay.
Returns rooms, rates, board types and cancellation policies for a selected hotel and stay.
Endpoint
| Method | Path | Auth |
|---|---|---|
POST | /v1/hotels/offers | 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 |
gdsprovider | number | Yes | - | |
hotelCode | string | Yes | - | |
checkIn | string | Format: YYYY-MM-DD | Yes | - |
checkOut | string | Format: YYYY-MM-DD | Yes | - |
countryCode | string | Format: 2 digits | Yes | - |
guestNationality | string | Format: 2 digits | Yes | - |
minRatePrice | number | No | - | |
maxRatePrice | number | No | - | |
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 |
Success Response
Returns hotel rooms, rates, cancellation policies and provider offer identifiers.
Response Body Schema
| Property | Type | Details | Required | Notes |
|---|---|---|---|---|
offers | array | Yes | - | |
offers[]roomNames | array | Yes | - | |
offers[]roomNames[] | string[] | Yes | - | |
offers[]minPrice | number | Yes | - | |
offers[]rates | array | Yes | - | |
offers[]rates[]gdsprovider | number | Yes | - | |
offers[]rates[]hotelCode | string | Yes | - | |
offers[]rates[]rateKey | string | Yes | - | |
offers[]rates[]adults | number | Yes | - | |
offers[]rates[]children | number | Yes | - | |
offers[]rates[]name | string | Yes | - | |
offers[]rates[]nameKey | string | Yes | - | |
offers[]rates[]board | string | Yes | - | |
offers[]rates[]boardKey | string | Yes | - | |
offers[]rates[]totalPrice | number | Yes | - | |
offers[]rates[]netPrice | number | Yes | - | |
offers[]rates[]originalPrice | number | Yes | - | |
offers[]rates[]currency | enum | EURUSDCNY | Yes | - |
offers[]rates[]originalCurrency | enum | EURUSDCNY | Yes | - |
offers[]rates[]supplements | array | Yes | - | |
offers[]rates[]supplements[]description | string | Yes | - | |
offers[]rates[]supplements[]price | number | Yes | - | |
offers[]rates[]supplements[]currency | string | Yes | - | |
offers[]rates[]cancellationPolicies | array | Yes | - | |
offers[]rates[]cancellationPolicies[]amount | number | Yes | - | |
offers[]rates[]cancellationPolicies[]fromDate | string | Format: ISO 8601 | Yes | - |
offers[]rates[]isRefundable | boolean | Yes | - | |
offers[]rates[]numberOfRooms | number | Yes | - | |
offers[]rates[]adultsPerRoom | array | Yes | - | |
offers[]rates[]adultsPerRoom[] | number[] | Yes | - | |