Получение списка отельных сниппетов

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

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

GET https://whitelabel.travel.yandex-net.ru/hotels/selection/
  ? geo_id=<integer>
  & checkin_date=<date>
  & checkout_date=<date>
  & adults=<integer>
  & [children_ages=<list of integer>]
  & [page_limit=<integer>]
  & [page_token=<string>]
  & [images_limit=<integer>]
  & [affiliate_clid=<string>]

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

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

Параметр

Описание

geo_id*

Идентификатор региона, заданный пользователем.

checkin_date*

Дата заезда в формате YYYY-MM-DD.

checkout_date*

Дата выезда в формате YYYY-MM-DD.

adults*

Количество совершеннолетних гостей.

children_ages

Список возрастов детей, перечисленных через запятую. Например: children_ages=10,7,5.

page_limit

Размер запрашиваемого блока (страницы). Максимальное значение — 50.

page_token

Токен начала запрашиваемого блока (страницы). Для первой страницы должен быть пустым. Приходит вместе с предыдущей страницей в поле next_page_token.

images_limit

Максимальное количество изображений (фотографий) отеля, отдаваемое в каждом сниппете. Максимальное значение — 20.

affiliate_clid

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

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

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

https://whitelabel.travel.yandex-net.ru/hotels/selection/?geo_id=213&checkin_date=2022-10-01
&checkout_date=2022-10-10&adults=2&children_ages=10%2C7&page_limit=25&page_token=50&images_limit=5

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

{
  "hotel_snippets" : [
    {
      "hotel_id": "(string)",
      "name": "(string)",
      "location": {
        "country_name": "(string)",
        "settlement": {
          "type": "(string)",
          "name": "(string)"
          },
        "address": "(string)",
        "lon": (double),
        "lat": (double),
      },
      "stars": (integer),
      "rating": "(string)",
      "total_review_count": (integer),
      "total_image_count": (integer),
      "images" : [
        {
          "url_template": "(string)",
          "sizes": [
            {
              "size": "(string)",
              "height": (integer),
              "width": (integer)
            },
          ]
        }
      ],
      "top_price": {
        "value": (integer),
        "currency": "(string)"
      },
      "landing_url": "(string)",
    },
  ],
  "next_page_token": "(string)"
}

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

Параметр

Тип

Описание

hotel_snippets

array

Ранжированный список отельных сниппетов.

next_page_token

string

Токен следующей страницы. Значение передается в параметре запроса page_token для получения следующей страницы. not null — означает, что есть еще отели. Параметр может отсутствовать.

hotel_snippets object

hotel_id

string

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

name

string

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

location

object

Географическое расположение отеля.

stars

integer

Количество звезд. Принимает значение от 1 до 5 или может отсутствовать.

rating

string

Рейтинг отеля. Принимает значение от 1 до 5 в формате: дробное число, один знак после запятой, или может отсутствовать.

total_review_count

integer

Количество отзывов.

total_image_count

integer

Количество изображений (фотографий) отеля.

images

array

Список изображений (фотографий) отеля.

top_price

object

Лучшая (минимальная) цена в рублях. Параметр может отсутствовать.

landing_url

string

Ссылка на страницу отеля с подставленными основными параметрами поиска. Параметр может отсутствовать.

location object

country_name

string

Страна.

settlement

object

Населенный пункт.

address

string

Адрес отеля.

lon

double

Долгота координат отеля.

lat

double

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

images object

url_template

string

Шаблон URL изображения, в котором %s нужно заменить на код определенного размера для получения URL изображения.

sizes

array

Список доступных размеров изображения.

top_price object

value

integer

Цена предложения.

currency

string

Валюта предложения. Возможное значение — RUB.

settlement object

type

string

Тип населенного пункта. Возможные значения:

  • CITY — город;
  • VILLAGE — деревня/село.

name

string

Название населенного пункта.

sizes object

size

string

Код размера изображения, который подставляется в шаблон URL.

height

integer

Высота в пикселях.

width

integer

Ширина в пикселях.

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

{
  "hotel_snippets" : [
    {
      "hotel_id": "1019057204",
      "name": "Марриотт Москва Гранд Отель",
      "location": {
        "country_name": "Россия",
        "settlement": {
          "type": "CITY",
          "name": "Москва"
          },
        "address": "Москва, ул. Добролюбова, д. 11",
        "lon": 37.599343,
        "lat": 55.768301,
      },
      "stars": 5,
      "rating": "4.9",
      "total_review_count": 158,
      "total_image_count": 79,
      "images" : [
        {
          "url_template": "https://avatars.mds.yandex.net/get-altay/200322/2a0000015b0b6a243dc584f534df710b4480/%s",
          "sizes": [
            {
              "size": "XXXS",
              "height": 29,
              "width": 50
            },
            {
              "size": "XXL",
              "height": 640,
              "width": 1024
            },
          ]
        }
      ],
      "top_price": {
        "value": 8000,
        "currency": "RUB"
      },
      "landing_url": "https://travel.yandex.ru/hotels/moscow/moskva-marriott-novyi-arbat/?checkin_date=2022-10-01&checkout_date=2022-10-10&adults=2&children_ages=10%2C7",
    },
  ],
  "next_page_token": "50"
}
Написать в службу поддержки
Предыдущая
Получение подсказок по регионам и отелям
Следующая
Получение списка отельных сниппетов с доступными предложениями