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

Список фильтров категории

Краткое содержание

Описание

category/{category_id}/filters

Возвращает список фильтров для указанной в запросе гуризованной, недогуризованной или визуальной категории. Для негуризованных категорий с признаком visual=false данный ресурс не используется. Ресурс является регионозависимым.

URL ресурса:

https://api.content.market.yandex.ru/v1/category/{category_id}/filters.[format]

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

Параметр

Тип

Значение

Обязательные

category_id

String

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

geo_id

Integer

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

Данный параметр является взаимоисключающим с параметром remote_ip.

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

Совет. Если вы не можете определить значение параметра geo_id, передавайте параметр remote_ip.

remote_ip

String

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

Данный параметр является взаимоисключающим с параметром geo_id.

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

Необязательные

by_popularity

Boolean

Фильтрация по популярности.

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

  • 0 / F / FALSE / N / NO — сортировка по алфавиту;

  • 1 / T / TRUE / Y / YES — сортировка по популярности в порядке убывания.

Значение по умолчанию: 0 / F / FALSE / N / NO.

description

Boolean

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

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

  • 0 / F / FALSE / N / NO — описание фильтра не выдается;

  • 1 / T / TRUE / Y / YES — выдается описание фильтра.

Значение по умолчанию: 0 / F / FALSE / N / NO.

filter_set

Enum

Тип фильтров категории.

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

  • ALL — все фильтры;

  • BASIC — простые фильтры (используются на странице категории);

  • POPULAR — популярные фильтры (используются на странице выдачи результатов).

Значение по умолчанию: POPULAR.

vendor_max_values

Integer

Количество производителей в фильтре «Производитель» в выходных данных.

Значение по умолчанию: 10.

Если в выходных данных параметр exactly=FALSE, производителей больше 10. Чтобы в выдаче присутствовали все производители, укажите в запросе vendor_max_values=0.

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

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

<filters
[no-highlight[

Значение

Список фильтров категории.

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

Значение

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

Параметр выводится только для формата XML.

]no-highlight]
description
[no-highlight[

Значение

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

]no-highlight]
="{описание_фильтра}" exactly
[no-highlight[

Значение

Признак наличия всех возможных значений фильтра в выходных данных.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR или NUMERIC.

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

  • FALSE — не все возможные значения фильтра присутствуют в выходных данных;

  • TRUE — все возможные значения фильтра присутствуют в выходных данных.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{признак_наличия_всех_значений}" id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{идентификатор_фильтра}" name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{наименование_фильтра}" shortname
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{краткое_наименование_фильтра}" type
[no-highlight[

Значение

Тип фильтра.

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

  • BOOL — фильтр для обозначения наличия или отсутствия определенного свойства у товара;

  • ENUM / ENUMERATOR — фильтр с набором допустимых значений;

  • NUMERIC — числовой фильтр;

  • TEXT — текстовый фильтр.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="enum" subtype
[no-highlight[

Значение

Подтип фильтра.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR.

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

  • COLOR — фильтр по цвету;

  • MULTI;

  • SINGLE;

  • SIZE — фильтр по размеру.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="single" unit
[no-highlight[

Значение

Единица измерения. Используется для числовых фильтров и фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{единица_измерения}"> <option
[no-highlight[

Значение

Описание допустимого значения/допустимых значений фильтра.

Выводится только для фильтров с набором допустимых значений.

Для формата XML каждое допустимое значение описывается отдельным параметром option.

]no-highlight]
count
[no-highlight[

Значение

Количество предложений магазина в данной категории.

Параметр выводится, если значением параметра name, вложенного в filter, является «Магазины» .

Для формата XML является атрибутом параметра option.

]no-highlight]
="{количество_предложений_магазина}" id
[no-highlight[

Значение

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

Выводится только для фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра option.

]no-highlight]
="{идентификатор_значения}" name
[no-highlight[

Значение

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

Выводится только для фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра option.

]no-highlight]
="{наименование_значения}" popularity
[no-highlight[

Значение

Показатель популярности производителя в данной категории.

Параметр выводится, если значением параметра name, вложенного в filter, является «Производитель» .

Для формата XML является атрибутом параметра option.

]no-highlight]
="{показатель_популярности}"/> ... </filter> <filter
[no-highlight[

Значение

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

Параметр выводится только для формата XML.

]no-highlight]
description
[no-highlight[

Значение

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

]no-highlight]
="{описание_фильтра}" id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{идентификатор_фильтра}" max-value
[no-highlight[

Значение

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

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{максимальное значение}" min-value
[no-highlight[

Значение

Минимальное значение фильтра.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{минимальное_значение}" name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{наименование_фильтра}" shortname
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{краткое_наименование_фильтра}" type
[no-highlight[

Значение

Тип фильтра.

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

  • BOOL — фильтр для обозначения наличия или отсутствия определенного свойства у товара;

  • ENUM / ENUMERATOR — фильтр с набором допустимых значений;

  • NUMERIC — числовой фильтр;

  • TEXT — текстовый фильтр.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="numeric" unit
[no-highlight[

Значение

Единица измерения. Используется для числовых фильтров и фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{единица_измерения}"/> <filter
[no-highlight[

Значение

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

Параметр выводится только для формата XML.

]no-highlight]
exactly
[no-highlight[

Значение

Признак наличия всех возможных значений фильтра в выходных данных.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR или NUMERIC.

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

  • FALSE — не все возможные значения фильтра присутствуют в выходных данных;

  • TRUE — все возможные значения фильтра присутствуют в выходных данных.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{признак_наличия_всех_значений}" id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{идентификатор_фильтра}" name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{наименование_фильтра}" shortname
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{краткое_наименование_фильтра}" type
[no-highlight[

Значение

Тип фильтра.

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

  • BOOL — фильтр для обозначения наличия или отсутствия определенного свойства у товара;

  • ENUM / ENUMERATOR — фильтр с набором допустимых значений;

  • NUMERIC — числовой фильтр;

  • TEXT — текстовый фильтр.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="enum" subtype
[no-highlight[

Значение

Подтип фильтра.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR.

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

  • COLOR — фильтр по цвету;

  • MULTI;

  • SINGLE;

  • SIZE — фильтр по размеру.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="color" unit
[no-highlight[

Значение

Единица измерения. Используется для числовых фильтров и фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{единица_измерения}"> <option
[no-highlight[

Значение

Описание допустимого значения/допустимых значений фильтра.

Выводится только для фильтров с набором допустимых значений.

Для формата XML каждое допустимое значение описывается отдельным параметром option.

]no-highlight]
code
[no-highlight[

Значение

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

Параметр выводится, если значением параметра subtype является COLOR.

Для формата XML является атрибутом параметра option.

]no-highlight]
="{код_значения_фильтра}" id
[no-highlight[

Значение

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

Выводится только для фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра option.

]no-highlight]
="{идентификатор_значения}" name
[no-highlight[

Значение

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

Выводится только для фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра option.

]no-highlight]
="{наименование_значения}" tag
[no-highlight[

Значение

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

Параметр выводится, если значением параметра subtype является COLOR.

Для формата XML является атрибутом параметра option.

]no-highlight]
="{краткое_название_значения_фильтра}"/> ... </filter> <filter
[no-highlight[

Значение

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

Параметр выводится только для формата XML.

]no-highlight]
exactly
[no-highlight[

Значение

Признак наличия всех возможных значений фильтра в выходных данных.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR или NUMERIC.

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

  • FALSE — не все возможные значения фильтра присутствуют в выходных данных;

  • TRUE — все возможные значения фильтра присутствуют в выходных данных.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{признак_наличия_всех_значений}" id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{идентификатор_фильтра}" name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{наименование_фильтра}" shortname
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{краткое_наименование_фильтра}" type
[no-highlight[

Значение

Тип фильтра.

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

  • BOOL — фильтр для обозначения наличия или отсутствия определенного свойства у товара;

  • ENUM / ENUMERATOR — фильтр с набором допустимых значений;

  • NUMERIC — числовой фильтр;

  • TEXT — текстовый фильтр.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="enum" subtype
[no-highlight[

Значение

Подтип фильтра.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR.

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

  • COLOR — фильтр по цвету;

  • MULTI;

  • SINGLE;

  • SIZE — фильтр по размеру.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="size" unit
[no-highlight[

Значение

Единица измерения. Используется для числовых фильтров и фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{единица_измерения}"> <option
[no-highlight[

Значение

Описание допустимого значения/допустимых значений фильтра.

Выводится только для фильтров с набором допустимых значений.

Для формата XML каждое допустимое значение описывается отдельным параметром option.

]no-highlight]
id
[no-highlight[

Значение

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

Выводится только для фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра option.

]no-highlight]
="{идентификатор_значения}" name
[no-highlight[

Значение

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

Выводится только для фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра option.

]no-highlight]
="{наименование_значения}" unit
[no-highlight[

Значение

Единица измерения. Используется для числовых фильтров и фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{единица_измерения}" unit-name
[no-highlight[

Значение

Название единицы измерения.

Параметр выводится, если значением параметра subtype является SIZE.

Для формата XML является атрибутом параметра option.

]no-highlight]
="{название_единицы_измерения}"/> ... </filter> <filter
[no-highlight[

Значение

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

Параметр выводится только для формата XML.

]no-highlight]
has-bool-no
[no-highlight[

Значение

Отображение элемента интерфейса.

Параметр выводится, если значением параметра type является BOOL.

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

  • FALSE — отображается флажок (checkbox);

  • TRUE — отображается переключатель (radiobutton) с вариантами «да», «нет», «неважно».

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{элемент_интерфейса}" id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{идентификатор_фильтра}" name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{наименование_фильтра}" shortname
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{краткое_наименование_фильтра}" type
[no-highlight[

Значение

Тип фильтра.

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

  • BOOL — фильтр для обозначения наличия или отсутствия определенного свойства у товара;

  • ENUM / ENUMERATOR — фильтр с набором допустимых значений;

  • NUMERIC — числовой фильтр;

  • TEXT — текстовый фильтр.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="bool"/> <filter
[no-highlight[

Значение

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

Параметр выводится только для формата XML.

]no-highlight]
id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{идентификатор_фильтра}" name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{наименование_фильтра}" shortname
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
="{краткое_наименование_фильтра}" type
[no-highlight[

Значение

Тип фильтра.

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

  • BOOL — фильтр для обозначения наличия или отсутствия определенного свойства у товара;

  • ENUM / ENUMERATOR — фильтр с набором допустимых значений;

  • NUMERIC — числовой фильтр;

  • TEXT — текстовый фильтр.

Для формата XML является атрибутом параметра filter.

]no-highlight]
="text"/> ... </filters>
Внимание! Для формата JSON выводятся служебные параметры, которые не описаны в таблице.
{
  "filters
[no-highlight[

Значение

Список фильтров категории.

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

Значение

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

]no-highlight]
": "{описание_фильтра}", "exactly
[no-highlight[

Значение

Признак наличия всех возможных значений фильтра в выходных данных.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR или NUMERIC.

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

  • FALSE — не все возможные значения фильтра присутствуют в выходных данных;

  • TRUE — все возможные значения фильтра присутствуют в выходных данных.

Для формата XML является атрибутом параметра filter.

]no-highlight]
": {признак_наличия_всех_значений}, "id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{идентификатор_фильтра}", "name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{наименование_фильтра}", "shortname
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{краткое_наименование_фильтра}", "type
[no-highlight[

Значение

Тип фильтра.

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

  • BOOL — фильтр для обозначения наличия или отсутствия определенного свойства у товара;

  • ENUM / ENUMERATOR — фильтр с набором допустимых значений;

  • NUMERIC — числовой фильтр;

  • TEXT — текстовый фильтр.

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "ENUMERATOR", "subType
[no-highlight[

Значение

Подтип фильтра.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR.

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

  • COLOR — фильтр по цвету;

  • MULTI;

  • SINGLE;

  • SIZE — фильтр по размеру.

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "SINGLE_CHOICE", "unit
[no-highlight[

Значение

Единица измерения. Используется для числовых фильтров и фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{единица_измерения}", "options
[no-highlight[

Значение

Описание допустимого значения/допустимых значений фильтра.

Выводится только для фильтров с набором допустимых значений.

Для формата XML каждое допустимое значение описывается отдельным параметром option.

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

Значение

Количество предложений магазина в данной категории.

Параметр выводится, если значением параметра name, вложенного в filter, является «Магазины» .

Для формата XML является атрибутом параметра option.

]no-highlight]
": "{количество_предложений_магазина}", "valueId
[no-highlight[

Значение

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

Выводится только для фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра option.

]no-highlight]
": "{идентификатор_значения}", "valueText
[no-highlight[

Значение

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

Выводится только для фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра option.

]no-highlight]
": "{наименование_значения}", "popularity
[no-highlight[

Значение

Показатель популярности производителя в данной категории.

Параметр выводится, если значением параметра name, вложенного в filter, является «Производитель» .

Для формата XML является атрибутом параметра option.

]no-highlight]
": "{показатель_популярности}" }, ... ] }, { "description
[no-highlight[

Значение

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

]no-highlight]
": "{описание_фильтра}", "id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{идентификатор_фильтра}", "maxValue
[no-highlight[

Значение

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

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR.

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{максимальное_значение}", "minValue
[no-highlight[

Значение

Минимальное значение фильтра.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR.

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{минимальное_значение}", "name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{наименование_фильтра}", "shortname
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{краткое_наименование_фильтра}", "type
[no-highlight[

Значение

Тип фильтра.

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

  • BOOL — фильтр для обозначения наличия или отсутствия определенного свойства у товара;

  • ENUM / ENUMERATOR — фильтр с набором допустимых значений;

  • NUMERIC — числовой фильтр;

  • TEXT — текстовый фильтр.

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "NUMERIC", "unit
[no-highlight[

Значение

Единица измерения. Используется для числовых фильтров и фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра filter.

]no-highlight]
":"{единица_измерения}" }, { "exactly
[no-highlight[

Значение

Признак наличия всех возможных значений фильтра в выходных данных.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR или NUMERIC.

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

  • FALSE — не все возможные значения фильтра присутствуют в выходных данных;

  • TRUE — все возможные значения фильтра присутствуют в выходных данных.

Для формата XML является атрибутом параметра filter.

]no-highlight]
": {признак_наличия_всех_значений}, "id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{идентификатор_фильтра}", "name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{наименование_фильтра}", "shortname
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{краткое_наименование_фильтра}", "type
[no-highlight[

Значение

Тип фильтра.

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

  • BOOL — фильтр для обозначения наличия или отсутствия определенного свойства у товара;

  • ENUM / ENUMERATOR — фильтр с набором допустимых значений;

  • NUMERIC — числовой фильтр;

  • TEXT — текстовый фильтр.

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "ENUMERATOR", "subType
[no-highlight[

Значение

Подтип фильтра.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR.

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

  • COLOR — фильтр по цвету;

  • MULTI;

  • SINGLE;

  • SIZE — фильтр по размеру.

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "COLOR", "unit
[no-highlight[

Значение

Единица измерения. Используется для числовых фильтров и фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{единица_измерения}", "options
[no-highlight[

Значение

Описание допустимого значения/допустимых значений фильтра.

Выводится только для фильтров с набором допустимых значений.

Для формата XML каждое допустимое значение описывается отдельным параметром option.

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

Значение

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

Параметр выводится, если значением параметра subtype является COLOR.

Для формата XML является атрибутом параметра option.

]no-highlight]
": "{код_значения_фильтра}", "valueId
[no-highlight[

Значение

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

Выводится только для фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра option.

]no-highlight]
": "{идентификатор_значения}", "valueText
[no-highlight[

Значение

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

Выводится только для фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра option.

]no-highlight]
": "{наименование_значения}", "tag
[no-highlight[

Значение

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

Параметр выводится, если значением параметра subtype является COLOR.

Для формата XML является атрибутом параметра option.

]no-highlight]
": "{краткое_название_значения_фильтра}" }, ... ] }, { "exactly
[no-highlight[

Значение

Признак наличия всех возможных значений фильтра в выходных данных.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR или NUMERIC.

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

  • FALSE — не все возможные значения фильтра присутствуют в выходных данных;

  • TRUE — все возможные значения фильтра присутствуют в выходных данных.

Для формата XML является атрибутом параметра filter.

]no-highlight]
": {признак_наличия_всех_значений}, "id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{идентификатор_фильтра}", "name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{наименование_фильтра}", "shortname
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{краткое_наименование_фильтра}", "type
[no-highlight[

Значение

Тип фильтра.

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

  • BOOL — фильтр для обозначения наличия или отсутствия определенного свойства у товара;

  • ENUM / ENUMERATOR — фильтр с набором допустимых значений;

  • NUMERIC — числовой фильтр;

  • TEXT — текстовый фильтр.

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "ENUMERATOR", "subType
[no-highlight[

Значение

Подтип фильтра.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR.

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

  • COLOR — фильтр по цвету;

  • MULTI;

  • SINGLE;

  • SIZE — фильтр по размеру.

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "SIZE", "unit
[no-highlight[

Значение

Единица измерения. Используется для числовых фильтров и фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра filter.

]no-highlight]
":"{единица_измерения}", "options
[no-highlight[

Значение

Описание допустимого значения/допустимых значений фильтра.

Выводится только для фильтров с набором допустимых значений.

Для формата XML каждое допустимое значение описывается отдельным параметром option.

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

Значение

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

Выводится только для фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра option.

]no-highlight]
": "{идентификатор_значения}", "valueText
[no-highlight[

Значение

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

Выводится только для фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра option.

]no-highlight]
": "{наименование_значения}", "unit
[no-highlight[

Значение

Единица измерения. Используется для числовых фильтров и фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{единица_измерения}", "unitName
[no-highlight[

Значение

Название единицы измерения.

Параметр выводится, если значением параметра subtype является SIZE.

Для формата XML является атрибутом параметра option.

]no-highlight]
": "{название_единицы_измерения}" }, ... ] }, { "hasBoolNo
[no-highlight[

Значение

Отображение элемента интерфейса.

Параметр выводится, если значением параметра type является BOOL.

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

  • FALSE — отображается флажок (checkbox);

  • TRUE — отображается переключатель (radiobutton) с вариантами «да», «нет», «неважно».

Для формата XML является атрибутом параметра filter.

]no-highlight]
": {элемент_интерфейса}, "id
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{идентификатор_фильтра}", "name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{наименование_фильтра}", "shortname
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{краткое_наименование_фильтра}", "type
[no-highlight[

Значение

Тип фильтра.

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

  • BOOL — фильтр для обозначения наличия или отсутствия определенного свойства у товара;

  • ENUM / ENUMERATOR — фильтр с набором допустимых значений;

  • NUMERIC — числовой фильтр;

  • TEXT — текстовый фильтр.

Для формата XML является атрибутом параметра filter.

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

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{идентификатор_фильтра}", "name
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{наименование_фильтра}", "shortname
[no-highlight[

Значение

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

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "{краткое_наименование_фильтра}", "type
[no-highlight[

Значение

Тип фильтра.

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

  • BOOL — фильтр для обозначения наличия или отсутствия определенного свойства у товара;

  • ENUM / ENUMERATOR — фильтр с набором допустимых значений;

  • NUMERIC — числовой фильтр;

  • TEXT — текстовый фильтр.

Для формата XML является атрибутом параметра filter.

]no-highlight]
": "TEXT" }, ... ] }

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

Параметр для формата XML

Параметр для формата JSON

Тип

Значение

filters filters

Список фильтров категории.

Параметры, вложенные в filters

filter

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

Параметр выводится только для формата XML.

Параметры, вложенные в filter / filters

description description String

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

exactly exactly Boolean

Признак наличия всех возможных значений фильтра в выходных данных.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR или NUMERIC.

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

  • FALSE — не все возможные значения фильтра присутствуют в выходных данных;

  • TRUE — все возможные значения фильтра присутствуют в выходных данных.

Для формата XML является атрибутом параметра filter.

id id String

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

Для формата XML является атрибутом параметра filter.

name name String

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

Для формата XML является атрибутом параметра filter.

shortname shortname String

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

Для формата XML является атрибутом параметра filter.

type type Enum

Тип фильтра.

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

  • BOOL — фильтр для обозначения наличия или отсутствия определенного свойства у товара;

  • ENUM / ENUMERATOR — фильтр с набором допустимых значений;

  • NUMERIC — числовой фильтр;

  • TEXT — текстовый фильтр.

Для формата XML является атрибутом параметра filter.

subtype subType Enum

Подтип фильтра.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR.

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

  • COLOR — фильтр по цвету;

  • MULTI;

  • SINGLE;

  • SIZE — фильтр по размеру.

Для формата XML является атрибутом параметра filter.

unit unit String

Единица измерения. Используется для числовых фильтров и фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра filter.

option options

Описание допустимого значения/допустимых значений фильтра.

Выводится только для фильтров с набором допустимых значений.

Для формата XML каждое допустимое значение описывается отдельным параметром option.

max-value maxValue String

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

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR.

Для формата XML является атрибутом параметра filter.

min-value minValue String

Минимальное значение фильтра.

Параметр выводится, если значением параметра type является ENUM / ENUMERATOR.

Для формата XML является атрибутом параметра filter.

has-bool-no hasBoolNo Boolean

Отображение элемента интерфейса.

Параметр выводится, если значением параметра type является BOOL.

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

  • FALSE — отображается флажок (checkbox);

  • TRUE — отображается переключатель (radiobutton) с вариантами «да», «нет», «неважно».

Для формата XML является атрибутом параметра filter.

Параметры, вложенные в option / options

count count String

Количество предложений магазина в данной категории.

Параметр выводится, если значением параметра name, вложенного в filter, является «Магазины» .

Для формата XML является атрибутом параметра option.

id valueId String

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

Выводится только для фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра option.

name valueText String

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

Выводится только для фильтров с набором допустимых значений.

Для формата XML является атрибутом параметра option.

popularity popularity String

Показатель популярности производителя в данной категории.

Параметр выводится, если значением параметра name, вложенного в filter, является «Производитель» .

Для формата XML является атрибутом параметра option.

code code String

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

Параметр выводится, если значением параметра subtype является COLOR.

Для формата XML является атрибутом параметра option.

tag tag String

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

Параметр выводится, если значением параметра subtype является COLOR.

Для формата XML является атрибутом параметра option.

unit unit String

Единица измерения.

Параметр выводится, если значением параметра subtype является SIZE.

Для формата XML является атрибутом параметра option.

unit-name unitName String

Название единицы измерения.

Параметр выводится, если значением параметра subtype является SIZE.

Для формата XML является атрибутом параметра option.

Описания ошибок

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

Примеры

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

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.content.market.yandex.ru/v1/category/90598/filters.xml?geo_id=213&description=1&filter_set=basic'

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

HTTP/1.1 200 OK
Date: Fri, 10 Jun 2016 12:08:12 GMT
Content-Type: application/xml;charset=utf-8
...


<filters>
  <filter description="Наличие функции регулировки степени помола зерен..." id="2142588757" name="Регулировка степени помола" shortname="GradeControl" type="bool"/>
  <filter description="Тип механизма для помола кофейных зерен в кофемолке..." id="2142588762" name="Система помола" shortname="MethodOfGrinding" type="enum" unit="">
    <option id="-763172645" name="жернова"/>
    <option id="-1291140568" name="ротационный нож"/>
  </filter>
  <filter id="2140131887" max-value="10000000" min-value="0" name="Максимальная цена" shortname="max_price" type="numeric" unit="руб."/>
  <filter id="2140131888"  max-value="10000000" min-value="0" name="Минимальная цена" shortname="min_price" type="numeric" unit="руб."/>
</filters>

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

curl -i -H 'Content-Type: application/json' -X GET 'https://api.content.market.yandex.ru/v1/category/90598/filters.json?geo_id=213&description=1&filter_set=basic'

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

Внимание! Для формата JSON выводятся служебные параметры, которые не описаны в таблице.
HTTP/1.1 200 OK
Date: Fri, 10 Jun 2016 12:08:12 GMT
Content-Type: application/json;charset=utf-8
...

{
  "filters":
  [
    {
      "filterProperty":
      {
        "description": "Наличие функции регулировки степени помола зерен..."
      }
      "id": "2142588757",
      "name": "Регулировка степени помола",
      "shortname": "GradeControl",
      "type": "BOOL"
    },
    {
      "filterProperty":
      {
        "description": "Тип механизма для помола кофейных зерен в кофемолке..."
      },
      "id": "2142588762",
      "name": "Система помола",
      "shortname": "MethodOfGrinding",
      "type": "ENUMERATOR",
      "unit": "",
      "options":
      [
        {
          "valueId": "-763172645",
          "valueText": "жернова"
        },
        {
          "valueId": "-1291140568",
          "valueText": "ротационный нож"
        }
      ]
    },
    {
      "id": "2140131887",
      "maxValue": "10000000",
      "minValue": "0",
      "name": "Максимальная цена",
      "shortname": "max_price",
      "type": "NUMERIC",
      "unit": "руб."
    },
    {
      "id": "2140131888",
      "maxValue": "10000000",
      "minValue": "0",
      "name": "Минимальная цена",
      "shortname": "min_price",
      "type": "NUMERIC",
      "unit": "руб."
    }
  ]
}
category/{category_id}/filters Список фильтров категории