Категории магазина

Описание

GET /campaigns/{campaignId}/feeds/categories

Возвращает список категорий предложений для магазина по всем прайс-листам этого магазина, размещенным на Яндекс.Маркете. Информация о категориях для отключенных прайс-листов не предоставляется.

В ответе на запрос для каждой категории указывается название, ее идентификатор и идентификатор родительской категории. Список сортируется сначала по возрастанию идентификатора прайс-листа, а затем по возрастанию идентификатора категории. Если категорий много, результаты выдаются постранично.

Примечание. Метод доступен начиная с версии 2.0 партнерского API Яндекс.Маркета.

URL ресурса:

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/feeds/categories.[format]

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

Параметр

Тип

Значение

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

campaignId

Int64

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

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

page

Int32

Номер страницы результатов.

Если параметр не задан, выводится первая страница.

Если указан номер страницы, превышающий общее количество найденных страниц, возвращается сообщение об ошибке.

pageSize

Int32

Количество категорий, выводимых на странице с результатами поиска в ответе.

Максимальное значение: 1000.

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

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

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

<response>
  <categories>
    <category feed-id="{int64}" id="{string}" name="{string}" parent-id="{string}"/>
    ...
  </categories>
  <pager current-page="{int32}" from="{int32}" pages-count="{int32}" page-size="{int32}" to="{int32}" total="{int32}"/>
</response>

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

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

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

Тип

Значение

response

Ответ.

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

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

categories categories

Список категорий.

pager pager

Сводка по результатам поиска.

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

category

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

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

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

feed-id feedId Int64

Идентификатор прайс-листа.

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

id id String

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

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

name name String

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

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

parent-id parentId String

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

Не выводится, если категория — корневая.

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

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

current-page currentPage Int32

Порядковый номер текущей страницы результатов.

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

from from Int32

Порядковый номер первой записи на странице относительно общих результатов поиска.

Если ничего не найдено, значение параметра: 0.

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

pages-count pagesCount Int32

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

Если искомых категорий не найдено, значение параметра: 0.

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

page-size pageSize Int32

Количество категорий, выводимых на текущей странице с результатами.

Если искомых категорий не найдено, значение параметра: 0.

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

to to Int32

Порядковый номер последней записи на странице относительно общих результатов поиска.

Если ничего не найдено, значение параметра: 0.

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

total total Int32

Общее количество категорий прайс-листа.

Если искомых категорий не найдено, значение параметра: 0.

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

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

В случае ошибки сервер возвращает HTTP-код ответа и краткое описание ошибки.

Ошибки, содержащие характерные для данного метода краткие описания:

Описание

Пояснение

Способ возможного решения

Ошибка 400 Bad Request

Page number is too big: 'pageNum'. Max page number is 'maxPageNum'

Указан слишком большой номер страницы.

Проверьте корректность передаваемого номера страницы.

Page number must be positive: 'page'

Номер страницы должен быть положительным числом.

Проверьте корректность передаваемого номера страницы.

Page size is too big: 'pageSize'. Max page size is 'maxPageSize'

Указан слишком большой размер страницы.

Проверьте корректность передаваемого размера страницы.

Page size must be positive: 'pageSize'

Размер страницы должен быть положительным числом.

Проверьте корректность передаваемого размера страницы.

Ошибка 403 Forbidden

Access denied

Нет доступа к магазину.

Проверьте корректность идентификатора магазина.

Ограничения

Для методов GET /campaigns/{campaignId}/feeds/categories и GET /campaigns/{campaignId}/feeds/{feedId}/categories действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество категорий, информация о которых запрошена при помощи этих методов.

Объем запросов к ресурсу, который возможно выполнить в течение суток, рассчитывается индивидуально и зависит от следующих показателей:

  • количество категорий.

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

Примеры

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

curl -i -H 'Content-Type: application/xml' -X GET 'https://api.partner.market.yandex.ru/v2/campaigns/10003/feeds/categories.xml'

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

HTTP/1.1 200 OK
Date: Sat, 19 Aug 2017 00:42:42 GMT
Content-Type: application/json;charset=utf-8
...

<response>
  <categories>
    <category feed-id="12345" id="1" name="Телевизоры"/>
    <category feed-id="12345" id="2" name="ЖК" parent-id="1"/>
    <category feed-id="12345" id="3" name="Плазменные" parent-id="1"/>
    <category feed-id="67891" id="1" name="Телевизоры"/>
    <category feed-id="67891" id="2" name="ЖК" parent-id="1"/>
    <category feed-id="67891" id="4" name="ЭЛТ" parent-id="1"/>
  </categories>
  <pager current-page="1" from="1" pages-count="1" page-size="6" to="6" total="6"/>
</response>