POST /accommodations/availability
Use this endpoint to return detailed product availability, price and charges of the accommodation matching a given search criteria.
By default, only product availability and price is returned. To receive extended information use the extras parameter.
Note: It is mandatory to pass the input parameters: accommodation, booker, checkin, checkout and guest.
Servers
- https://demandapi.booking.com/3.1
- https://demandapi-sandbox.booking.com/3.1
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
X-Affiliate-Id |
Integer | Yes |
Include here your Affiliate identifier number |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
booker |
Object | Yes |
The booker's information. |
booker.platform |
String | Yes |
The booker platform for showing the platform based deals and prices. Possible values:
|
booker.travel_purpose |
String | No |
The travel purpose of the booker. Possible values:
|
booker.user_groups[] |
Array | No |
The user groups that the booker is a member of. |
booker.country |
String | Yes |
The booker country for showing the best price for that user and obeying laws regarding the display of taxes and fees. |
booker.state |
String | No |
The booker state for showing the best price for that user and obeying laws regarding the display of taxes and fees. Currently applicable only for country US. |
checkout |
String | Yes |
The checkout date. Must be later than {checkin}. Must be between 1 and 90 days after {checkin}. Must be within 500 days in the future and in the format yyyy-mm-dd. |
extras[] |
Array | No |
Input parameter to request for additional information about this product. |
products[] |
Array | No | |
guests |
Object | Yes |
The guest details for the request. |
guests.number_of_rooms |
Integer | Yes |
The number of rooms needed. |
guests.allocation[] |
Array | No |
The exact allocation of guests to rooms. |
guests.allocation[].number_of_adults |
Integer | Yes |
The number of adults for this room. |
guests.allocation[].children[] |
Array | No |
The children ages for this room. |
guests.number_of_adults |
Integer | Yes |
The number of adults for the search. |
guests.children[] |
Array | No |
Array with the children ages. |
payment |
Object | No |
Payment input information to filter results. |
payment.timing |
String | No |
This parameter specifies that the results should only return accommodation and blocks that contain the specified payment timings. Possible values:
|
checkin |
String | Yes |
The checkin date. Must be within 500 days in the future and in the format yyyy-mm-dd. |
accommodation |
Integer | Yes |
A signed integer number that uniquely identifies an accommodation property. The full list can be obtained by calling accommodations/details. |
currency |
String | No |
A three-letter code that uniquely identifies a monetary currency as defined by the ISO 4217 standard. The full list can be obtained by calling common/payments/currencies. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.