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

Описание

GET /{version}/categories/{id}/filters

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

URL ресурса:

https://api.content.market.yandex.ru/{version}/categories/{id}/filters

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

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

Версия API.

id PATH Int32 Да

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

fields QUERY Enum list Нет

Группы параметров, которые необходимо отобразить в выходных данных.

Возможные значения:
  • ALLVENDORS — группа параметров для фильтра «Производитель».

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

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

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

  • SORTS — включение в выдачу доступных фильтров.
  • STATISTICS — Обогащение информацией статистикой по фильтрам
Псевдонимы значений:
  • ALL = Все значения
    Примечание. Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS.
filter_set QUERY Enum Нет
Определяет набор фильтров в выходных данных.
Примечание. Значение BASIC равнозначно POPULAR.
Возможные значения:
  • ALL — все фильтры.
  • BASIC — базовый набор фильтров.
  • POPULAR — только популярные фильтры.
Значение по умолчанию: POPULAR.
format QUERY Enum Нет

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

Возможные значения:
  • JSON — выходные данные будут сформированы в формате JSON.
  • XML — выходные данные будут сформированы в формате XML.
Значение по умолчанию: JSON .
rs QUERY String Нет

Поле содержащее закодированную информацию о текстовом запросе после редиректа, на которую будет ориентироватся поиск.

sort QUERY Enum Нет

Задает тип сортировки значений в фильтрах.

Возможные значения:
  • NAME — сортировка по имени.
  • NONE — сортировка отсутствует.
Значение по умолчанию: NONE.
{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} определяет текстовую строку поиска.

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

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

{
  "status" : "{enum}",
  "context" : {
    "region" : {
      "id" : {int32},
      "name" : "{string}",
      "type" : "{enum}",
      "childCount" : {int32},
      "country" : {
        Содержимое объекта
      }
    },
    "currency" : {
      "id" : "{string}",
      "name" : "{string}"
    },
    "alternateCurrency" : {
      "id" : "{string}",
      "name" : "{string}"
    },
    "page" : {
      "number" : {int32},
      "count" : {int32},
      "total" : {int32},
      "last" : {boolean}
    },
    "warnings" : [
      {
        "type" : "{string}",
        "code" : "{string}",
        "message" : "{string}"
      },
      ...
    ],
    "id" : "{string}",
    "time" : "{date}",
    "link" : "{string}",
    "marketUrl" : "{string}"
  },
  "sorts" : [
    {
      "text" : "{string}",
      "field" : "{enum}",
      "options" : [
        {
          "id" : "{string}",
          "how" : "{enum}",
          "text" : "{string}"
        },
        ...
      ]
    },
    ...
  ],
  "filters" : [
    {
      "id" : "{string}",
      "name" : "{string}",
      "type" : "{string}",
      "description" : "{string}"
    },
    {
      "id" : "{string}",
      "name" : "{string}",
      "type" : "{string}",
      "unit" : "{string}",
      "defaultUnit" : "{string}",
      "description" : "{string}",
      "values" : [
        {
          "id" : "{string}",
          "name" : "{string}",
          "initialFound" : {int64},
          "found" : {int64},
          "checked" : {boolean}
        },
        {
          "id" : "{string}",
          "name" : "{string}",
          "initialFound" : {int64},
          "found" : {int64},
          "checked" : {boolean},
          "color" : "{string}"
        },
        {
          "id" : "{string}",
          "name" : "{string}",
          "initialFound" : {int64},
          "found" : {int64},
          "checked" : {boolean},
          "unitId" : "{string}"
        },
        {
          "id" : "{string}",
          "name" : "{string}",
          "initialFound" : {int64},
          "found" : {int64},
          "checked" : {boolean},
          "color" : "{string}",
          "photo" : "{string}"
        },
        ...
      ]
    },
    {
      "id" : "{string}",
      "name" : "{string}",
      "type" : "{string}",
      "unit" : "{string}",
      "description" : "{string}",
      "max" : "{string}",
      "min" : "{string}",
      "value" : "{string}",
      "precision" : {int32}
    },
    ...
  ]
}

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

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

Enum

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

Возможные значения:
  • OK — операция выполнена успешно.

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

context context

Object

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

sorts sorts

Object list

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

filters filters

Object list

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

Типы:
  • Фильтр.
  • Фильтр со значениями.
  • Числовой фильтр
result-context-v2 Параметры, вложенные в 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

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

warnings warnings

Object list

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

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

region-v2 Параметры, вложенные в 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

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

Регион

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

String

Код валюты.

name name

String

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

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

Int32

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

count count

Int32

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

total total

Int32

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

last last

Boolean

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

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

String

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

code code

String

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

message message

String

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

available-report-sort Параметры, вложенные в sorts
text text

String

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

field field

Enum

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

Возможные значения:
  • RELEVANCY — сортировка по релевантности.

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

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

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

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

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

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

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

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

  • NOFFERS — сортировка по количеству предложений

options options

Object list

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

available-report-sort-option Параметры, вложенные в sorts/options
id id

String

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

how how

Enum

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

Возможные значения:
  • ASC — по возрастанию;

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

text text

String

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

filter,numeric-filter,enum-filter Параметры, вложенные в 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 фильтра
  • Значение Filters.FilterType#PHOTO_PICKER фильтра
max max

String

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

min min

String

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

value value

String

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

precision precision

Int32

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

photo-picker-enum-value,filter-value,size-enum-value,color-enum-value Параметры, вложенные в filters/values Типы: Значение фильтра, Значение COLOR фильтра, Значение SIZE фильтра, Значение Filters.FilterType#PHOTO_PICKER фильтра
id id

String

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

name name

String

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

initialFound initialFound

Int64

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

found found

Int64

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

checked checked

Boolean

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

color color

String

Значение цвета
Внимание. Только для фильтров типов COLOR и Filters.FilterType#PHOTO_PICKER
unitId unitId

String

Код единицы измерения размера значения фильтра
Внимание. Только для фильтра типа SIZE
photo photo

String

Ссылку на картинку для выбора цвета
Внимание. Только для фильтра типа Filters.FilterType#PHOTO_PICKER

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

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