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

Информация о категории

Описание

category/{category_id}

Возвращает информацию о категории. Ресурс является регионозависимым.

URL ресурса:

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

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

Параметр

Тип

Значение

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

category_id

String

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

geo_id

Integer

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

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

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

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

remote_ip

String

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

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

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

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

fields

Enum

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

Примечание. Для некоторых ресурсов не все значения влияют на выходные данные.

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

  • ALL — все параметры;

  • CATEGORY — идентификатор и название категории, к которой относится модель;

  • DISCOUNTS — информация о скидках на модель;

    Ограничение. Значение DISCOUNTS работает только совместно со значением PRICE: fields=DISCOUNTS,PRICE.
  • FACTS — список достоинств и недостатков модели;

  • FILTERS — основные фильтры;

  • LINK — URL-адрес карточки модели, страницы производителя или категории на Яндекс.Маркете. Выводится в выходном параметре link. Значение link зависит от того, в какой параметр он вложен (model, vendor или category);

  • MEDIA — количество обзоров и отзывов на модель;

  • NAVIGATION_NODE — информация о навигационном узле дерева категорий Маркета, к которому относится модель;

  • OFFERS — количество товарных предложений, соотнесенных с моделью, в указанном регионе;

  • PHOTO — изображение модели, используемое как основное изображение на карточке модели
    [no-highlight[

    Для каждой модели создается карточка модели — страница с набором параметров и характеристик товара, сгруппированных в логические блоки.

    ]no-highlight]
    ;
  • PRICE — описание цен на модель;

  • RATING — количество оценок и рейтинг модели (величина, которая показывает сводную пользовательскую оценку потребительских свойств товара);

  • VENDOR — информация о производителе: идентификатор, изображение логотипа, адрес сайта и название.

В значении параметра можно комбинировать параметры, разделяя их запятой. Например, fields=CATEGORY,FACTS,MEDIA.

Значение по умолчанию: CATEGORY,PHOTO.

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

Структура выходных данных:

<category
[no-highlight[

Значение

Описание категории.

]no-highlight]
children-count
[no-highlight[

Значение

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

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

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

Значение

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

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

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

Значение

URL страницы категории на Яндекс.Маркете.

Ограничение. Параметр присутствует в выходных данных, если для входного параметра fields указано значение ALL или LINK.

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

]no-highlight]
="{URL_категории}" models-num
[no-highlight[

Значение

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

Параметр выводится для всех гуризованных категорий и всех категорий, у которых есть гуризованные подкатегории. В этом случае значение параметра — сумма количества моделей всех гуризованных подкатегорий.

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

]no-highlight]
="{количество_моделей}" name
[no-highlight[

Значение

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

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

]no-highlight]
="{название_категории}" offers-num
[no-highlight[

Значение

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

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

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

Значение

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

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

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

Значение

Тип категории.

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

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

]no-highlight]
="{тип_категории}" uniq_name
[no-highlight[

Значение

Расширенное наименование категории.

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

]no-highlight]
="{расширенное_название_категории}" visual
[no-highlight[

Значение

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

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

  • FALSE — категория не является визуальной;

  • TRUE — визуальная категория.

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

]no-highlight]
="{признак_визуальной_категории}"/>
{
  "category
[no-highlight[

Значение

Описание категории.

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

Значение

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

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

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

Значение

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

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

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

Значение

URL страницы категории на Яндекс.Маркете.

Ограничение. Параметр присутствует в выходных данных, если для входного параметра fields указано значение ALL или LINK.

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

]no-highlight]
": "{URL_категории}", "modelsNum
[no-highlight[

Значение

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

Параметр выводится для всех гуризованных категорий и всех категорий, у которых есть гуризованные подкатегории. В этом случае значение параметра — сумма количества моделей всех гуризованных подкатегорий.

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

]no-highlight]
": {количество_моделей}, "name
[no-highlight[

Значение

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

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

]no-highlight]
": "{название_категории}", "offersNum
[no-highlight[

Значение

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

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

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

Значение

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

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

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

Значение

Тип категории.

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

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

]no-highlight]
": "{тип_категории}", "uniqName
[no-highlight[

Значение

Расширенное наименование категории.

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

]no-highlight]
": "{расширенное_название_категории}", "visual
[no-highlight[

Значение

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

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

  • FALSE — категория не является визуальной;

  • TRUE — визуальная категория.

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

]no-highlight]
": {признак_визуальной_категории} } }

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

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

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

Тип

Значение

category category

Описание категории.

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

children-count childrenCount Integer

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

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

id id Integer

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

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

link link String

URL страницы категории на Яндекс.Маркете.

Ограничение. Параметр присутствует в выходных данных, если для входного параметра fields указано значение ALL или LINK.

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

models-num modelsNum Integer

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

Параметр выводится для всех гуризованных категорий и всех категорий, у которых есть гуризованные подкатегории. В этом случае значение параметра — сумма количества моделей всех гуризованных подкатегорий.

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

name name String

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

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

offers-num offersNum Integer

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

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

parent-id parentId Integer

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

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

type type Enum

Тип категории.

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

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

uniq_name uniqName String

Расширенное наименование категории.

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

visual visual Boolean

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

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

  • FALSE — категория не является визуальной;

  • TRUE — визуальная категория.

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

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

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

Примеры

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

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.content.market.yandex.ru/v1/category/90402.xml?geo_id=213&fields=ALL'

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

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

<category children-count="9" id="90402" link="https://market.yandex.ru/catalog/90402/..." models-num="129551" name="Авто" offers-num="2564884" parent-id="90401" type="nonguru" uniq_name="Товары для авто- и мототехники" visual="false"/>

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

curl -i -H 'Content-Type: application/json' -X GET 'https://api.content.market.yandex.ru/v1/category/90402.json?geo_id=213&fields=ALL'

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

HTTP/1.1 200 OK
Date: Fri, 20 May 2016 12:08:12 GMT
Content-Type: application/json;charset=utf-8
...

{
  "category":
  {
    "childrenCount": 9,
    "id": 90402,
    "link": "https://market.yandex.ru/catalog/90402/...",
    "modelsNum": 129551,
    "name": "Авто",
    "offersNum": 2564884,
    "uniqName": "Товары для авто- и мототехники",
    "parentId": 90401,
    "type": "nonguru",
    "visual": false
  }
}
category/{category_id} информация о категории Категории