Руководство разработчика
Ресурсы API

Список предложений на модель

Описание

GET /{version}/models/{id}/offers

Возвращает список товарных предложений, соотнесенных с указанной моделью.

Ресурс является регионозависимым и  списочным.

URL ресурса:

https://api.content.market.yandex.ru/{version}/models/{id}/offers

Входные данные

ПараметрПоложе­ниеТипОбяза­тельностьОписание
version PATH Enum Да

Версия контентного API.

id PATH Int64 Да

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

delivery_included QUERY Boolean Нет

Признак включения цены доставки в цену товарного предложения.

Возможные значения:

  • 0 | F | FALSE | N | NO — ЛОЖЬ
  • 1 | T | TRUE | Y | YES — ИСТИНА

Значение по умолчанию: ЛОЖЬ.
fields QUERY Enum list Нет

Параметры товарных предложений, которые необходимо показать в выходных данных.

Возможные значения:

  • FILTERS — Список фильтров в результатах запроса офферов
  • FILTER_ALLVENDORS — группа параметров для фильтра «Производитель».

    По умолчанию выводится информация о первых 12 производителях.

  • FILTER_DESCRIPTION — описания фильтров.
  • FILTER_FOUND — количество моделей или товарных предложений:
    • found — если применить это значение фильтра с текущими условиями фильтрации.

    • initialFound — если применить только это значение фильтра без других фильтров.

  • FILTER_SORTS — включение в выдачу доступных фильтров.
  • OFFER_ACTIVE_FILTERS — активные фильтры.
  • OFFER_BUNDLE_SETTINGS — минимальный состав заказа.
  • OFFER_CATEGORY — информация о категории предложения.
  • OFFER_DELIVERY — информация о доставке.
  • OFFER_DISCOUNT — скидка.
  • OFFER_OUTLET — информация о точке выдачи производетеля.
  • OFFER_OUTLET_COUNT — Количество точек выдачи предложения
  • OFFER_PHOTO — фото предложения.
  • OFFER_SHOP — магазин от которого поступило предложенение.
  • OFFER_VENDOR — информация о поставщике.
  • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
  • SHOP_RATING — рейтинг магазина.
  • SORTS — Доступные варианты сортировок для запроса

Псевдонимы значений:

  • ALL = Все значения
    Примечание. Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS.
  • FILTER_ALL = FILTER_ALLVENDORS, FILTER_DESCRIPTION, FILTER_FOUND, FILTER_SORTS
  • OFFER_ALL = OFFER_ACTIVE_FILTERS, OFFER_BUNDLE_SETTINGS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_DISCOUNT, OFFER_LINK, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_PHOTO, OFFER_SHOP, OFFER_VENDOR
  • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
  • STANDARD = OFFER_CATEGORY, OFFER_DELIVERY, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_PHOTO, OFFER_SHOP, SHOP_RATING
  • VENDOR_ALL = VENDOR_LINK

format QUERY Enum Нет

Формат выходных данных.

Возможные значения:

  • JSON — выходные данные будут сформированы в формате JSON.
  • XML — выходные данные будут сформированы в формате XML.

Значение по умолчанию: JSON.
groupBy QUERY Enum Нет

Вариант группировки товарных предложений

Возможные значения:

  • NONE — Группировка предложений отключена. В выдаче присутствуют все предложения
  • OFFER — Группировать предложениям
  • SHOP — Группировка предложений осуществляется по магазину. В выдаче присутствует по одному предложению магазина

shop_regions QUERY Int32 list Нет

Идентификаторы регионов магазинов

{filter_id} QUERY String or int64 Нет

Параметры задают условия фильтрации моделей и предложений на модель.

Чтобы задать фильтр необходимо добавить в запрос параметр следующего вида: {filter_id}={filter_value}.

Пример: 7980557=18446744073709529154, где

  • 7980557 — идентификатор фильтра;
  • 18446744073709529154 — значение фильтра.

Получить список фильтров, их идентификаторов и значений для определенной категории можно с помощью ресурса /{version}/categories/{id}/filters.

Значение параметра зависит от типа выбранного фильтра.

Допускается множество параметров.

Ограничения:

  • Для типа фильтра BOOLEAN — допустимые значения фильтра:

    • 1 | T | TRUE | Y | YES — равно TRUE.
    • 0 | F | FALSE | N | NO — равно FALSE.

  • Для типов фильтров ENUM, COLOR, SIZE — {filter_value} определяет список идентификаторов значений фильтра, разделенных запятыми, {value1_id},{value2_id},{value3_id}, где {valueN_id} — идентификатор значения.

  • Для типа фильтра NUMBER — {filter_value} определяет числовой диапазон значений, границы которого разделяются знаком ~ тильда. Форматы значений параметра:

    • {min_value}~ - с тильдой в конце - определяет только нижнюю границу фильтра.
    • ~{max_value} - с тильдой в начале - определяет только верхнюю границу фильтра.
    • {min_value}~{max_value} - с тильдой между числами - определяет нижнюю и вехнюю границы фильтра.

  • Для типа фильтра RADIO — {filter_value} определяет один идентификатор значения фильтра.

  • Для типа фильтра TEXT — {filter_value} определяет текстовую строку поиска.

Параметры для определения региона пользователя для формирования выдачи с учетом региона

Параметр remote_ip имеет более высокий приоритет, чем geo_id.

Если в качестве входных данных задать оба параметра, выдача будет сформирована на основании remote_ip.

geo_id QUERY Int64 Да, если не задан remote_ip

Идентификатор региона пользователя для формирования выдачи с учетом региона.

remote_ip QUERY String Да, если не задан geo_id

IP-адрес пользователя, по которому определяется его регион. На основании IP-адреса формируется выдача с учетом региона.

Параметры страницы
count QUERY Int32 Нет

Размер страницы (кол-во элементов на странице)

Ограничения:

  • Минимальное значение 1, максимальное значение 30

Значение по умолчанию: 10.
page QUERY Int32 Нет

Номер страницы.

Ограничения:

  • Минимальное значение 1, максимальное значение 50

Значение по умолчанию: 1.
Параметры сортировки
how QUERY Enum Нет

Направление сортировки Значение по-умолчанию null т.к. если параметр не указан, то порядок сортировки зависит от поля по которому сортируем: так по цене сортировка по возрастанию, а по популярности по убыванию.

Возможные значения:

  • ASC — по возрастанию;
  • DESC — по убыванию.

sort QUERY Enum Нет

Тип сортировки товарных предложений

Возможные значения:

  • DATE — сортировка по дате.
  • DELIVERY_TIME — сортировка по времени доставки.
  • DISCOUNT — сортировка по размеру скидки.
    Ограничение. Для sort=DISCOUNT возможна только сортировка по убыванию (how=DESC).
  • DISTANCE — сортировка по расстоянию до ближайшей точки продаж (значение доступно только при указании местоположения пользователя).
  • OPINIONS — сортировка по количеству отзывов.
  • POPULARITY — сортировка по популярности.
  • PRICE — сортировка по цене.
  • QUALITY — сортировка по рейтингу.
  • RATING — сортировка по рейтингу.
  • RELEVANCY — сортировка по релевантности.

Значение по умолчанию: RELEVANCY.
Гео-координаты пользователя, для определения региона

Ограничение. Оба парметра должны быть определены совместно. Не допускается указывать один без другого.

latitude QUERY Double Нет

Широта

Ограничения:

  • Минимальное значение -90.0, максимальное значение 90.0

longitude QUERY Double Нет

Долгота

Ограничения:

  • Минимальное значение -180.0, максимальное значение 180.0

Выходные данные

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

{
  "status
[no-highlight[

Статус обработки запроса.

Возможные значения:

  • OK — операция выполнена успешно.

  • ERROR — произошла ошибка.

]no-highlight]
" : "{enum}", "context
[no-highlight[

Контекст обработки запроса.

]no-highlight]
" : { "region
[no-highlight[

Информация о регионе запроса.

]no-highlight]
" : { "id
[no-highlight[

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

]no-highlight]
" : {int32}, "name
[no-highlight[

Наименование региона.

]no-highlight]
" : "{string}", "type
[no-highlight[

Тип региона.

Возможные значения:

  • CONTINENT — континент.

  • REGION — регион.

  • COUNTRY — страна.

  • COUNTRY_DISTRICT — федеральный округ.

  • SUBJECT_FEDERATION — субъект федерации.

  • CITY — город.

  • VILLAGE — село.

  • CITY_DISTRICT — район города.

  • METRO_STATION — станиция метро.

  • SUBJECT_FEDERATION_DISTRICT — район субъекта федерации.

  • AIRPORT — аэропорт.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • MONORAIL_STATION — станция монорельса.

  • RURAL_SETTLEMENT — сельское поселение.

  • OTHER — другой тип населенного пункта.

]no-highlight]
" : "{enum}", "childCount
[no-highlight[

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

]no-highlight]
" : {int32}, "country
[no-highlight[

Страна, к которой относится регион.

Регион

]no-highlight]
" : { Содержимое объекта } }, "currency
[no-highlight[

Валюта запроса.

]no-highlight]
" : { "id
[no-highlight[

Код валюты.

]no-highlight]
" : "{string}", "name
[no-highlight[

Название валюты.

]no-highlight]
" : "{string}" }, "alternateCurrency
[no-highlight[

Альтернативная валюта запроса.

]no-highlight]
" : { "id
[no-highlight[

Код валюты.

]no-highlight]
" : "{string}", "name
[no-highlight[

Название валюты.

]no-highlight]
" : "{string}" }, "page
[no-highlight[

Информация о параметрах страницы запроса.

]no-highlight]
" : { "number
[no-highlight[

Номер страницы.

]no-highlight]
" : {int32}, "count
[no-highlight[

Размер страницы.

]no-highlight]
" : {int32}, "total
[no-highlight[

Количество страниц в результате.

]no-highlight]
" : {int32}, "last
[no-highlight[

Признак последней страницы.

]no-highlight]
" : {boolean} }, "processingOptions
[no-highlight[

Опции обработки запроса

]no-highlight]
" : { "adult
[no-highlight[

Признак наличия в выдаче информации, имеющей возрастные ограничения 18+

]no-highlight]
" : {boolean} }, "warnings
[no-highlight[

Список предупреждений, возникших при обработке запроса.

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

]no-highlight]
" : [ { "type
[no-highlight[

Тип предупрежедния.

]no-highlight]
" : "{string}", "code
[no-highlight[

Код предупреждения.

]no-highlight]
" : "{string}", "message
[no-highlight[

Сообщение с описанием предупреждения.

]no-highlight]
" : "{string}" }, ... ], "id
[no-highlight[

Уникальный идентификатор запроса.

]no-highlight]
" : "{string}", "time
[no-highlight[

Дата и время выполнения запроса в формате ISO 8601.

]no-highlight]
" : {date}, "link
[no-highlight[

Ссылка на текущий запрос.

]no-highlight]
" : "{string}", "marketUrl
[no-highlight[

Ссылка на Яндекс.Маркет

]no-highlight]
" : "{string}" }, "offers
[no-highlight[

Список товарных предложений модели

Товарное предложение

]no-highlight]
" : [ { Содержимое объекта }, ... ], "filters
[no-highlight[

Список фильтров, доступных для фильтрации товарных предложений модели

Типы:

  • Фильтр.
  • Фильтр со значениями.
  • Числовой фильтр

]no-highlight]
" : [ { "id
[no-highlight[

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

]no-highlight]
" : "{string}", "name
[no-highlight[

Наименование фильтра.

]no-highlight]
" : "{string}", "type
[no-highlight[

Тип фильтра.

Возможные значения:

  • BOOLEAN — логический тип.
  • NUMBER — числовой тип, задает диапазон допустимых значений.
  • ENUM — тип перечисление, задает список допустимых значений, множественный выбор.
  • COLOR — фильтр по цвету, аналогичен ENUM, значения фильтра дополнительно содержат HEX-код соответствующего цвета.
  • SIZE — фильтр по размеру, аналогичен ENUM, значения фильтра дополнительно содержат код единиц измерения.
  • RADIO — аналогичен ENUM, но допускает выбор только одного значения.
  • TEXT — тип фильтра для фильтрации по поисковой фразе.

]no-highlight]
" : "{string}", "description
[no-highlight[

Описание фильтра.

]no-highlight]
" : "{string}" }, { "id
[no-highlight[

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

]no-highlight]
" : "{string}", "name
[no-highlight[

Наименование фильтра.

]no-highlight]
" : "{string}", "type
[no-highlight[

Тип фильтра.

Возможные значения:

  • BOOLEAN — логический тип.
  • NUMBER — числовой тип, задает диапазон допустимых значений.
  • ENUM — тип перечисление, задает список допустимых значений, множественный выбор.
  • COLOR — фильтр по цвету, аналогичен ENUM, значения фильтра дополнительно содержат HEX-код соответствующего цвета.
  • SIZE — фильтр по размеру, аналогичен ENUM, значения фильтра дополнительно содержат код единиц измерения.
  • RADIO — аналогичен ENUM, но допускает выбор только одного значения.
  • TEXT — тип фильтра для фильтрации по поисковой фразе.

]no-highlight]
" : "{string}", "unit
[no-highlight[

Единицы измерения значений фильтра.

]no-highlight]
" : "{string}", "defaultUnit
[no-highlight[

Код единиц измерения значений фильтра, используемых по умолчанию.

]no-highlight]
" : "{string}", "description
[no-highlight[

Описание фильтра.

]no-highlight]
" : "{string}", "values
[no-highlight[

Список значений фильтра

Типы:

  • Значение фильтра
  • Значение COLOR фильтра
  • Значение SIZE фильтра

]no-highlight]
" : [ { "id
[no-highlight[

Идентификатор значения фильтра, используется для установки значения фильтра

]no-highlight]
" : "{string}", "name
[no-highlight[

Текстовое описание значение фильтра

]no-highlight]
" : "{string}", "initialFound
[no-highlight[

Кол-во моделей/офферов в выдаче, попадающих под значение фильтра, при отсутствии других фильтров

]no-highlight]
" : {int64}, "found
[no-highlight[

Кол-во моделей/офферов в выдаче, попадающих под значение фильтра, при текущих условиях фильтрации

]no-highlight]
" : {int64}, "checked
[no-highlight[

Признак того, что значение выбрано в соответствии с текущими условиями фильтрации

]no-highlight]
" : {boolean} }, { "id
[no-highlight[

Идентификатор значения фильтра, используется для установки значения фильтра

]no-highlight]
" : "{string}", "name
[no-highlight[

Текстовое описание значение фильтра

]no-highlight]
" : "{string}", "initialFound
[no-highlight[

Кол-во моделей/офферов в выдаче, попадающих под значение фильтра, при отсутствии других фильтров

]no-highlight]
" : {int64}, "found
[no-highlight[

Кол-во моделей/офферов в выдаче, попадающих под значение фильтра, при текущих условиях фильтрации

]no-highlight]
" : {int64}, "checked
[no-highlight[

Признак того, что значение выбрано в соответствии с текущими условиями фильтрации

]no-highlight]
" : {boolean}, "color
[no-highlight[

Значение цвета

Внимание! Только для фильтра типа COLOR

]no-highlight]
" : "{string}" }, { "id
[no-highlight[

Идентификатор значения фильтра, используется для установки значения фильтра

]no-highlight]
" : "{string}", "name
[no-highlight[

Текстовое описание значение фильтра

]no-highlight]
" : "{string}", "initialFound
[no-highlight[

Кол-во моделей/офферов в выдаче, попадающих под значение фильтра, при отсутствии других фильтров

]no-highlight]
" : {int64}, "found
[no-highlight[

Кол-во моделей/офферов в выдаче, попадающих под значение фильтра, при текущих условиях фильтрации

]no-highlight]
" : {int64}, "checked
[no-highlight[

Признак того, что значение выбрано в соответствии с текущими условиями фильтрации

]no-highlight]
" : {boolean}, "unitId
[no-highlight[

Код единицы измерения размера значения фильтра

Внимание! Только для фильтра типа SIZE

]no-highlight]
" : "{string}" }, ... ] }, { "id
[no-highlight[

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

]no-highlight]
" : "{string}", "name
[no-highlight[

Наименование фильтра.

]no-highlight]
" : "{string}", "type
[no-highlight[

Тип фильтра.

Возможные значения:

  • BOOLEAN — логический тип.
  • NUMBER — числовой тип, задает диапазон допустимых значений.
  • ENUM — тип перечисление, задает список допустимых значений, множественный выбор.
  • COLOR — фильтр по цвету, аналогичен ENUM, значения фильтра дополнительно содержат HEX-код соответствующего цвета.
  • SIZE — фильтр по размеру, аналогичен ENUM, значения фильтра дополнительно содержат код единиц измерения.
  • RADIO — аналогичен ENUM, но допускает выбор только одного значения.
  • TEXT — тип фильтра для фильтрации по поисковой фразе.

]no-highlight]
" : "{string}", "unit
[no-highlight[

Единицы измерения значений фильтра.

]no-highlight]
" : "{string}", "description
[no-highlight[

Описание фильтра.

]no-highlight]
" : "{string}", "max
[no-highlight[

Максимальное значение числового фильтра

]no-highlight]
" : "{string}", "min
[no-highlight[

Минимальное значение числового фильтра

]no-highlight]
" : "{string}", "value
[no-highlight[

Выбранное значение числового фильтра

]no-highlight]
" : "{string}", "precision
[no-highlight[

Кол-во знаков поле запятой у значений фильтра

]no-highlight]
" : {int32} }, ... ], "sorts
[no-highlight[

Список доступных сортировок товарных предложений модели

]no-highlight]
" : [ { "text
[no-highlight[

Наименование типа сортировки.

]no-highlight]
" : "{string}", "field
[no-highlight[

Тип сортировки.

Возможные значения:

  • RELEVANCY — сортировка по релевантности.

  • PRICE — сортировка по цене.

  • RATING — сортировка по рейтингу.

  • DISTANCE — сортировка по расстоянию до ближайшей точки продаж (значение доступно только при указании местоположения пользователя).

  • POPULARITY — сортировка по популярности.

  • DISCOUNT — сортировка по размеру скидки.

    Ограничение. Для sort=DISCOUNT возможна только сортировка по убыванию (how=DESC).

  • QUALITY — сортировка по рейтингу.

  • OPINIONS — сортировка по количеству отзывов.

  • DATE — сортировка по дате.

  • DELIVERY_TIME — сортировка по времени доставки.

]no-highlight]
" : "{enum}", "options
[no-highlight[

Доступные варианты для данного типа сортировки.

]no-highlight]
" : [ { "id
[no-highlight[

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

]no-highlight]
" : "{string}", "how
[no-highlight[

Направление сортировки.

Возможные значения:

  • ASC — по возрастанию;

  • DESC — по убыванию.

]no-highlight]
" : "{enum}", "text
[no-highlight[

Наименование данного варианта сортировки

]no-highlight]
" : "{string}" }, ... ] }, ... ] }
<result status
[no-highlight[

Статус обработки запроса.

Возможные значения:

  • OK — операция выполнена успешно.

  • ERROR — произошла ошибка.

]no-highlight]
="{enum}"> <context
[no-highlight[

Контекст обработки запроса.

]no-highlight]
id
[no-highlight[

Уникальный идентификатор запроса.

]no-highlight]
="{string}" time
[no-highlight[

Дата и время выполнения запроса в формате ISO 8601.

]no-highlight]
="{date}" link
[no-highlight[

Ссылка на текущий запрос.

]no-highlight]
="{string}" marketUrl
[no-highlight[

Ссылка на Яндекс.Маркет

]no-highlight]
="{string}"> <region
[no-highlight[

Информация о регионе запроса.

]no-highlight]
id
[no-highlight[

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

]no-highlight]
="{int32}" name
[no-highlight[

Наименование региона.

]no-highlight]
="{string}" type
[no-highlight[

Тип региона.

Возможные значения:

  • CONTINENT — континент.

  • REGION — регион.

  • COUNTRY — страна.

  • COUNTRY_DISTRICT — федеральный округ.

  • SUBJECT_FEDERATION — субъект федерации.

  • CITY — город.

  • VILLAGE — село.

  • CITY_DISTRICT — район города.

  • METRO_STATION — станиция метро.

  • SUBJECT_FEDERATION_DISTRICT — район субъекта федерации.

  • AIRPORT — аэропорт.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • MONORAIL_STATION — станция монорельса.

  • RURAL_SETTLEMENT — сельское поселение.

  • OTHER — другой тип населенного пункта.

]no-highlight]
="{enum}" childCount
[no-highlight[

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

]no-highlight]
="{int32}"> <country
[no-highlight[

Страна, к которой относится регион.

Регион

]no-highlight]
>Содержимое объекта</country> </region> <currency
[no-highlight[

Валюта запроса.

]no-highlight]
id
[no-highlight[

Код валюты.

]no-highlight]
="{string}" name
[no-highlight[

Название валюты.

]no-highlight]
="{string}"/> <alternateCurrency
[no-highlight[

Альтернативная валюта запроса.

]no-highlight]
id
[no-highlight[

Код валюты.

]no-highlight]
="{string}" name
[no-highlight[

Название валюты.

]no-highlight]
="{string}"/> <page
[no-highlight[

Информация о параметрах страницы запроса.

]no-highlight]
number
[no-highlight[

Номер страницы.

]no-highlight]
="{int32}" count
[no-highlight[

Размер страницы.

]no-highlight]
="{int32}" total
[no-highlight[

Количество страниц в результате.

]no-highlight]
="{int32}" last
[no-highlight[

Признак последней страницы.

]no-highlight]
="{boolean}"/> <processingOptions
[no-highlight[

Опции обработки запроса

]no-highlight]
adult
[no-highlight[

Признак наличия в выдаче информации, имеющей возрастные ограничения 18+

]no-highlight]
="{boolean}"/> <warnings
[no-highlight[

Список предупреждений, возникших при обработке запроса.

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

]no-highlight]
> <warning type
[no-highlight[

Тип предупрежедния.

]no-highlight]
="{string}" code
[no-highlight[

Код предупреждения.

]no-highlight]
="{string}" message
[no-highlight[

Сообщение с описанием предупреждения.

]no-highlight]
="{string}"/> ... </warnings> </context> <offers
[no-highlight[

Список товарных предложений модели

Товарное предложение

]no-highlight]
> <offer>Содержимое объекта</offer> ... </offers> <filters
[no-highlight[

Список фильтров, доступных для фильтрации товарных предложений модели

Типы:

  • Фильтр.
  • Фильтр со значениями.
  • Числовой фильтр

]no-highlight]
> <filter id
[no-highlight[

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

]no-highlight]
="{string}" name
[no-highlight[

Наименование фильтра.

]no-highlight]
="{string}" type
[no-highlight[

Тип фильтра.

Возможные значения:

  • BOOLEAN — логический тип.
  • NUMBER — числовой тип, задает диапазон допустимых значений.
  • ENUM — тип перечисление, задает список допустимых значений, множественный выбор.
  • COLOR — фильтр по цвету, аналогичен ENUM, значения фильтра дополнительно содержат HEX-код соответствующего цвета.
  • SIZE — фильтр по размеру, аналогичен ENUM, значения фильтра дополнительно содержат код единиц измерения.
  • RADIO — аналогичен ENUM, но допускает выбор только одного значения.
  • TEXT — тип фильтра для фильтрации по поисковой фразе.

]no-highlight]
="{string}" description
[no-highlight[

Описание фильтра.

]no-highlight]
="{string}"/> <filter id
[no-highlight[

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

]no-highlight]
="{string}" name
[no-highlight[

Наименование фильтра.

]no-highlight]
="{string}" type
[no-highlight[

Тип фильтра.

Возможные значения:

  • BOOLEAN — логический тип.
  • NUMBER — числовой тип, задает диапазон допустимых значений.
  • ENUM — тип перечисление, задает список допустимых значений, множественный выбор.
  • COLOR — фильтр по цвету, аналогичен ENUM, значения фильтра дополнительно содержат HEX-код соответствующего цвета.
  • SIZE — фильтр по размеру, аналогичен ENUM, значения фильтра дополнительно содержат код единиц измерения.
  • RADIO — аналогичен ENUM, но допускает выбор только одного значения.
  • TEXT — тип фильтра для фильтрации по поисковой фразе.

]no-highlight]
="{string}" unit
[no-highlight[

Единицы измерения значений фильтра.

]no-highlight]
="{string}" defaultUnit
[no-highlight[

Код единиц измерения значений фильтра, используемых по умолчанию.

]no-highlight]
="{string}" description
[no-highlight[

Описание фильтра.

]no-highlight]
="{string}"> <values
[no-highlight[

Список значений фильтра

Типы:

  • Значение фильтра
  • Значение COLOR фильтра
  • Значение SIZE фильтра

]no-highlight]
> <value id
[no-highlight[

Идентификатор значения фильтра, используется для установки значения фильтра

]no-highlight]
="{string}" name
[no-highlight[

Текстовое описание значение фильтра

]no-highlight]
="{string}" initialFound
[no-highlight[

Кол-во моделей/офферов в выдаче, попадающих под значение фильтра, при отсутствии других фильтров

]no-highlight]
="{int64}" found
[no-highlight[

Кол-во моделей/офферов в выдаче, попадающих под значение фильтра, при текущих условиях фильтрации

]no-highlight]
="{int64}" checked
[no-highlight[

Признак того, что значение выбрано в соответствии с текущими условиями фильтрации

]no-highlight]
="{boolean}"/> <value id
[no-highlight[

Идентификатор значения фильтра, используется для установки значения фильтра

]no-highlight]
="{string}" name
[no-highlight[

Текстовое описание значение фильтра

]no-highlight]
="{string}" initialFound
[no-highlight[

Кол-во моделей/офферов в выдаче, попадающих под значение фильтра, при отсутствии других фильтров

]no-highlight]
="{int64}" found
[no-highlight[

Кол-во моделей/офферов в выдаче, попадающих под значение фильтра, при текущих условиях фильтрации

]no-highlight]
="{int64}" checked
[no-highlight[

Признак того, что значение выбрано в соответствии с текущими условиями фильтрации

]no-highlight]
="{boolean}" color
[no-highlight[

Значение цвета

Внимание! Только для фильтра типа COLOR

]no-highlight]
="{string}"/> <value id
[no-highlight[

Идентификатор значения фильтра, используется для установки значения фильтра

]no-highlight]
="{string}" name
[no-highlight[

Текстовое описание значение фильтра

]no-highlight]
="{string}" initialFound
[no-highlight[

Кол-во моделей/офферов в выдаче, попадающих под значение фильтра, при отсутствии других фильтров

]no-highlight]
="{int64}" found
[no-highlight[

Кол-во моделей/офферов в выдаче, попадающих под значение фильтра, при текущих условиях фильтрации

]no-highlight]
="{int64}" checked
[no-highlight[

Признак того, что значение выбрано в соответствии с текущими условиями фильтрации

]no-highlight]
="{boolean}" unitId
[no-highlight[

Код единицы измерения размера значения фильтра

Внимание! Только для фильтра типа SIZE

]no-highlight]
="{string}"/> ... </values> </filter> <filter id
[no-highlight[

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

]no-highlight]
="{string}" name
[no-highlight[

Наименование фильтра.

]no-highlight]
="{string}" type
[no-highlight[

Тип фильтра.

Возможные значения:

  • BOOLEAN — логический тип.
  • NUMBER — числовой тип, задает диапазон допустимых значений.
  • ENUM — тип перечисление, задает список допустимых значений, множественный выбор.
  • COLOR — фильтр по цвету, аналогичен ENUM, значения фильтра дополнительно содержат HEX-код соответствующего цвета.
  • SIZE — фильтр по размеру, аналогичен ENUM, значения фильтра дополнительно содержат код единиц измерения.
  • RADIO — аналогичен ENUM, но допускает выбор только одного значения.
  • TEXT — тип фильтра для фильтрации по поисковой фразе.

]no-highlight]
="{string}" unit
[no-highlight[

Единицы измерения значений фильтра.

]no-highlight]
="{string}" description
[no-highlight[

Описание фильтра.

]no-highlight]
="{string}" max
[no-highlight[

Максимальное значение числового фильтра

]no-highlight]
="{string}" min
[no-highlight[

Минимальное значение числового фильтра

]no-highlight]
="{string}" value
[no-highlight[

Выбранное значение числового фильтра

]no-highlight]
="{string}" precision
[no-highlight[

Кол-во знаков поле запятой у значений фильтра

]no-highlight]
="{int32}"/> ... </filters> <sorts
[no-highlight[

Список доступных сортировок товарных предложений модели

]no-highlight]
> <sort text
[no-highlight[

Наименование типа сортировки.

]no-highlight]
="{string}" field
[no-highlight[

Тип сортировки.

Возможные значения:

  • RELEVANCY — сортировка по релевантности.

  • PRICE — сортировка по цене.

  • RATING — сортировка по рейтингу.

  • DISTANCE — сортировка по расстоянию до ближайшей точки продаж (значение доступно только при указании местоположения пользователя).

  • POPULARITY — сортировка по популярности.

  • DISCOUNT — сортировка по размеру скидки.

    Ограничение. Для sort=DISCOUNT возможна только сортировка по убыванию (how=DESC).

  • QUALITY — сортировка по рейтингу.

  • OPINIONS — сортировка по количеству отзывов.

  • DATE — сортировка по дате.

  • DELIVERY_TIME — сортировка по времени доставки.

]no-highlight]
="{enum}"> <options
[no-highlight[

Доступные варианты для данного типа сортировки.

]no-highlight]
> <option id
[no-highlight[

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

]no-highlight]
="{string}" how
[no-highlight[

Направление сортировки.

Возможные значения:

  • ASC — по возрастанию;

  • DESC — по убыванию.

]no-highlight]
="{enum}" text
[no-highlight[

Наименование данного варианта сортировки

]no-highlight]
="{string}"/> ... </options> </sort> ... </sorts> </result>

Описание параметров:

Параметр для формата JSONПараметр для формата XMLТипОписание
status status

Enum

Статус обработки запроса.

Возможные значения:

  • OK — операция выполнена успешно.

  • ERROR — произошла ошибка.

context context

Object

Контекст обработки запроса.

offers offers

Object list

Список товарных предложений модели

Товарное предложение

filters filters

Object list

Список фильтров, доступных для фильтрации товарных предложений модели

Типы:

  • Фильтр.
  • Фильтр со значениями.
  • Числовой фильтр

sorts sorts

Object list

Список доступных сортировок товарных предложений модели

Параметры, вложенные в context.
id id

String

Уникальный идентификатор запроса.

time time

Date

Дата и время выполнения запроса в формате ISO 8601.

link link

String

Ссылка на текущий запрос.

marketUrl marketUrl

String

Ссылка на Яндекс.Маркет

region region

Object

Информация о регионе запроса.

currency currency

Object

Валюта запроса.

alternateCurrency alternateCurrency

Object

Альтернативная валюта запроса.

page page

Object

Информация о параметрах страницы запроса.

processingOptions processingOptions

Object

Опции обработки запроса

warnings warnings

Object list

Список предупреждений, возникших при обработке запроса.

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

Параметры, вложенные в context/region.
id id

Int32

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

name name

String

Наименование региона.

type type

Enum

Тип региона.

Возможные значения:

  • CONTINENT — континент.

  • REGION — регион.

  • COUNTRY — страна.

  • COUNTRY_DISTRICT — федеральный округ.

  • SUBJECT_FEDERATION — субъект федерации.

  • CITY — город.

  • VILLAGE — село.

  • CITY_DISTRICT — район города.

  • METRO_STATION — станиция метро.

  • SUBJECT_FEDERATION_DISTRICT — район субъекта федерации.

  • AIRPORT — аэропорт.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • MONORAIL_STATION — станция монорельса.

  • RURAL_SETTLEMENT — сельское поселение.

  • OTHER — другой тип населенного пункта.

childCount childCount

Int32

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

country country

Object

Страна, к которой относится регион.

Регион

Параметры, вложенные в context/currency, context/alternateCurrency.
id id

String

Код валюты.

name name

String

Название валюты.

Параметры, вложенные в context/page.
number number

Int32

Номер страницы.

count count

Int32

Размер страницы.

total total

Int32

Количество страниц в результате.

last last

Boolean

Признак последней страницы.

Параметры, вложенные в context/processingOptions.
adult adult

Boolean

Признак наличия в выдаче информации, имеющей возрастные ограничения 18+

Параметры, вложенные в context/warnings.
type type

String

Тип предупрежедния.

code code

String

Код предупреждения.

message message

String

Сообщение с описанием предупреждения.

Параметры, вложенные в filters. Типы: Фильтр., Фильтр со значениями., Числовой фильтр
id id

String

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

name name

String

Наименование фильтра.

type type

String

Тип фильтра.

Возможные значения:

  • BOOLEAN — логический тип.
  • NUMBER — числовой тип, задает диапазон допустимых значений.
  • ENUM — тип перечисление, задает список допустимых значений, множественный выбор.
  • COLOR — фильтр по цвету, аналогичен ENUM, значения фильтра дополнительно содержат HEX-код соответствующего цвета.
  • SIZE — фильтр по размеру, аналогичен ENUM, значения фильтра дополнительно содержат код единиц измерения.
  • RADIO — аналогичен ENUM, но допускает выбор только одного значения.
  • TEXT — тип фильтра для фильтрации по поисковой фразе.

description description

String

Описание фильтра.

unit unit

String

Единицы измерения значений фильтра.

defaultUnit defaultUnit

String

Код единиц измерения значений фильтра, используемых по умолчанию.

values values

Object list

Список значений фильтра

Типы:

  • Значение фильтра
  • Значение COLOR фильтра
  • Значение SIZE фильтра

max max

String

Максимальное значение числового фильтра

min min

String

Минимальное значение числового фильтра

value value

String

Выбранное значение числового фильтра

precision precision

Int32

Кол-во знаков поле запятой у значений фильтра

Параметры, вложенные в filters/values. Типы: Значение фильтра, Значение COLOR фильтра, Значение SIZE фильтра
id id

String

Идентификатор значения фильтра, используется для установки значения фильтра

name name

String

Текстовое описание значение фильтра

initialFound initialFound

Int64

Кол-во моделей/офферов в выдаче, попадающих под значение фильтра, при отсутствии других фильтров

found found

Int64

Кол-во моделей/офферов в выдаче, попадающих под значение фильтра, при текущих условиях фильтрации

checked checked

Boolean

Признак того, что значение выбрано в соответствии с текущими условиями фильтрации

color color

String

Значение цвета

Внимание! Только для фильтра типа COLOR

unitId unitId

String

Код единицы измерения размера значения фильтра

Внимание! Только для фильтра типа SIZE

Параметры, вложенные в sorts.
text text

String

Наименование типа сортировки.

field field

Enum

Тип сортировки.

Возможные значения:

  • RELEVANCY — сортировка по релевантности.

  • PRICE — сортировка по цене.

  • RATING — сортировка по рейтингу.

  • DISTANCE — сортировка по расстоянию до ближайшей точки продаж (значение доступно только при указании местоположения пользователя).

  • POPULARITY — сортировка по популярности.

  • DISCOUNT — сортировка по размеру скидки.

    Ограничение. Для sort=DISCOUNT возможна только сортировка по убыванию (how=DESC).

  • QUALITY — сортировка по рейтингу.

  • OPINIONS — сортировка по количеству отзывов.

  • DATE — сортировка по дате.

  • DELIVERY_TIME — сортировка по времени доставки.

options options

Object list

Доступные варианты для данного типа сортировки.

Параметры, вложенные в sorts/options.
id id

String

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

how how

Enum

Направление сортировки.

Возможные значения:

  • ASC — по возрастанию;

  • DESC — по убыванию.

text text

String

Наименование данного варианта сортировки

Возможные ошибки

В случае возникновения ошибочной ситуации сервер возвращает HTTP-статус ответа и сообщение об ошибке. Описание ошибок приведено в разделе Сообщения об ошибках.

/{version}/models/{id}/offers Список предложений на модель Модели товаров