Получение подсказок по регионам и отелям

Метод позволяет получать подсказки в виде списка регионов и отелей по введенному поисковому запросу. Поисковый запрос может быть введен не полностью, с исправлением возможных опечаток и учитывать статистику использования подсказок.

Формат запроса

GET https://whitelabel.travel.yandex-net.ru/hotels/suggest/
  ? query=<string>
  & [region_limit=<integer>]
  & [hotel_limit=<integer>]
  & [affiliate_clid=<string>]

Authorization: OAuth <OAuth token>
Content-Type: application/JSON

Параметры запроса

Параметр

Описание

query*

Запрос пользователя, строка, по которой будет выполнен поиск. Ограничение — 200 символов.

region_limit

Ограничение на количество подсказок по регионам в ответе. Максимальное значение — 25.

hotel_limit

Ограничение на количество подсказок по отелям в ответе. Максимальное значение — 25.

affiliate_clid

Идентификатор, выданный партнеру сервисом Яндекс Дистрибуция, к которому относится запрос. При отсутствии параметра будет использован clid, установленный партнеру при регистрации в системе.

* Обязательный параметр

Пример запроса

https://whitelabel.travel.yandex-net.ru/hotels/suggest/?query=екатерин&region_limit=5&hotel_limit=10
&affiliate_clid=123456789

Формат ответа

{
  "regions" : [
    {
      "geo_id": (integer),
      "type": "(string)",
      "name": "(string)",
      "description": "(string)"
    }
  ],
  "hotels": [
    {
      "hotel_id": (integer),
      "name": "(string)",
      "description": "(string)"
    }
  ]
}

Параметры ответа

Параметр

Тип

Описание

regions

array

Список подсказок по региону. Может отсутствовать, если в запросе region_limit=0.

hotels

array

Список подсказок по отелям. Может отсутствовать, если в запросе hotel_limit=0.

regions array

geo_id

integer

Идентификатор региона.

type

string

Тип региона. Возможные значения:

  • COUNTRY — страна;
  • REGION — субъект федерации, область и т. п.;
  • CITY — город;
  • VILLAGE — деревня, село;
  • DISTRICT — район города.

name

string

Название объекта.

description

string

Описание объекта.

hotels array

hotel_id

integer

Идентификатор отеля.

name

string

Название отеля.

description

string

Описание отеля. Например, географическое расположение, адрес и т. п.

Пример ответа

{
  "regions" : [
    {
      "geo_id": 54,
      "type": "CITY",
      "name": "Екатеринбург",
      "description": "Свердловская область"
    },
    {
      "geo_id": 137511,
      "type": "VILLAGE",
      "name": "Екатериновка",
      "description": "село, Самарская область"
    },
  ],
  "hotels": [
    {
      "hotel_id": "1262520952",
      "name": "Hyatt Regency Ekaterinburg",
      "description": "Гостиница · Свердловская область, Екатеринбург, улица Бориса Ельцина, 8",
    },
    {
      "hotel_id": "130357884584",
      "name": "Екатерина",
      "description": "Гостиница · Кострома, улица Нижняя Дебря, 17",
    },
  ]
}
Написать в службу поддержки