POST /accommodations/details

This endpoint returns detailed information on all accommodation properties matching a given search criteria. By default, only basic information is returned.

It is mandatory to pass one of the input parameters: accommodations, airport, city, country or region.

To receive extended information use the extras parameter.

Servers

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
accommodation_types[] Array No
region Integer No

A signed integer number that uniquely identifies a geographical region. Regions usually define official administrative areas within a country, but may also include multiple countries and in some cases un-official but popular designations for geographical areas. An example of a region that crosses multiple countries is the Alps in Europe. The full list can be obtained by calling common/locations/regions.

accommodation_facilities[] Array No
airport String No

A three-letter code that uniquely identifies an airport as defined by the International Air Transport Association (IATA). The full list can be obtained by calling common/locations/airports.

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:

  • "pay_at_the_property"
  • "pay_online"
brands[] Array No
city Integer No

A signed integer number that uniquely identifies a city. The full list can be obtained by calling common/locations/cities.

languages[] Array No
page String No

Pagination token used to retrieve the next page of results. Obtained from next_page.

extras[] Array No

Input parameter to request for additional information about the accommodation property. It should be passed as a JSON array with one or more items.

accommodations[] Array No
rows Integer No

The maximum number of results to return.

Default value: 100

country String No

A two-letter code that uniquely identifies a country. This code is defined by the ISO 3166-1 alpha-2 standard (ISO2) as described here: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. The full list can be obtained by calling common/locations/countries.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.