Retrieve hotel IDs by filter

ETG API V3

Content API

https://api.worldota.net/api/content/v1/hotel_ids_by_filter/

The call gets the identifiers for all required hotels. Use fields to search only for the desired hotels.

ℹ️

Use this call instead of call Retrieve hotel dump.
Use this call after Retrieve filter values call.

Request example

curl --user '<KEY_ID>:<API_KEY>' 'https://api.worldota.net/api/content/v1/hotel_ids_by_filter/' \
--header 'Content-Type: application/json' \
--data '{
    "country": [52]
}'

Request body

Expand this| Collapse this

country [Int] optional

The country.

ℹ️

Use the value field from the call Retrieve filter values.

kind [String] optional

The hotel type.

ℹ️

The list of possible kind field values is obtained from the call Retrieve filter values.

star_rating [Int] optional

The hotel rating on a scale from 1 to 5. Has the 0 value for no available rating.

ℹ️

The list of possible star_rating field values is obtained from the call Retrieve filter values.

serp_filters [Srting] optional

The list of hotel amenities.

ℹ️

Use the value field from the call Retrieve filter values.

updated_since String optional

Hotels where the information has been updated.

ℹ️

The format of this field is: “2006-01-02 15:04:05”.

supplier_type String optional

Which suppliers to search for.

ℹ️

The possible values:
- all — all available suppliers.
- direct — Chains, Extranet, DMC, Switch, Consolidator, Wholesaler.
- direct_fast — Chains, Extranet.
- direct_fast_extended — Chains, Extranet, DMC, Switch.
The default value is all.

preferable Boolean optional

All sellable hotels with availability within last 6 months.

top Boolean optional

500k best hotels by their paid bookings.

Response

Expand this| Collapse this

hids [Int]

A list of unique hotel IDs in the new numeric format.

ℹ️

Each ID is an integer no longer than 10 digits.
We are gradually migrating all clients to use this format.

ids [String]

A list of unique hotel IDs in the legacy string format.

Response example

{
  "data": {
    "hids": [
      6325458,
      6445894,
      6493239,
      6526863,
      13350497
    ],
    "ids": [
      "hotel_1",
      "hotel_2",
      "hotel_3",
      "hotel_4",
      "hotel_5"
    ]
  },
  "debug": {
    "request": {
      "serp_filter": [
        "air_conditioning",
        "has_airport_transfer",
        "beach",
        "has_internet",
        "has_kids",
        "kitchen"
      ],
      "kind": [
        "Mini-hotel"
      ],
      "country": [
        153
      ],
      "updated_since": "2006-01-02 15:04:05"
    },
    "key_id": 1234,
    "validation_error": null
  },
  "status": "ok",
  "error": null
}

Errors

The error field has the value specified in the headers below.

`invalid_params`

One or more input parameters are incorrect. For more details, see the response field debug validation_error.

`no_hotel_ids`

An internal search error. Has 500 status code.