Получение подсказок по регионам и отелям
Метод позволяет получать подсказки в виде списка регионов и отелей по введенному поисковому запросу. Поисковый запрос может быть введен не полностью, с исправлением возможных опечаток и учитывать статистику использования подсказок.
Формат запроса
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
Параметры запроса
Параметр |
Описание |
|
Запрос пользователя, строка, по которой будет выполнен поиск. Ограничение — 200 символов. |
|
Ограничение на количество подсказок по регионам в ответе. Максимальное значение — 25. |
|
Ограничение на количество подсказок по отелям в ответе. Максимальное значение — 25. |
|
Идентификатор, выданный партнеру сервисом Яндекс Дистрибуция, к которому относится запрос. При отсутствии параметра будет использован clid, установленный партнеру при регистрации в системе. |
* Обязательный параметр
Пример запроса
https://whitelabel.travel.yandex-net.ru/hotels/suggest/?query=екатерин®ion_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)"
}
]
}
Параметры ответа
Параметр |
Тип |
Описание |
|
array |
Список подсказок по региону. Может отсутствовать, если в запросе |
|
array |
Список подсказок по отелям. Может отсутствовать, если в запросе |
regions array |
||
|
integer |
Идентификатор региона. |
|
string |
Тип региона. Возможные значения:
|
|
string |
Название объекта. |
|
string |
Описание объекта. |
hotels array |
||
|
integer |
Идентификатор отеля. |
|
string |
Название отеля. |
|
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",
},
]
}
Запрос пользователя — строка, по которой будет выполнен поиск. Ограничение — 200 символов.
Ограничение на количество подсказок по регионам в ответе. Максимальное значение — 25.
Ограничение на количество подсказок по отелям в ответе. Максимальное значение — 25.
Идентификатор, выданный партнеру сервисом Яндекс Дистрибуция, к которому относится запрос. При отсутствии параметра будет использован clid, установленный партнеру при регистрации в системе.