Request
- Path parameters
- Query parameters
Responses
200 OK
400 Bad Request
401 Unauthorized
- Body
403 Forbidden
- Body
404 Not Found
- Body
420 Method Failure
- Body
500 Internal Server Error
- Body

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

Info

Console

Deprecated

Этот метод устарел. Не используйте его.

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

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

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

⚙️ Лимит: не более 50 000 запросов в сутки

Примечание

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

Request

GET

https://api.partner.market.yandex.ru/campaigns/{campaignId}/feeds/categories

Path parameters

Name

Type

Description

campaignId*

integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Query parameters

Name

Type

Description

page

integer<int32>

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

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

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

pageSize

integer<int32>

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

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

{
    "categories": [
        {
            "feedId": 0,
            "id": "string",
            "name": "string",
            "parentId": "string"
        }
    ],
    "pager": {
        "total": 0,
        "from": 0,
        "to": 0,
        "currentPage": 0,
        "pagesCount": 0,
        "pageSize": 0
    }
}

Name	Type	Description
categories	FeedCategoryDTO[]	Список категорий. Список категорий.
pager	FlippingPagerDTO	Модель для пагинации.

FeedCategoryDTO

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

Name	Type	Description
feedId	integer<int64>	Идентификатор прайс-листа.
id	string	Идентификатор категории.
name	string	Название категории.
parentId	string	Идентификатор родительской категории. Не выводится, если категория — корневая.

FlippingPagerDTO

Модель для пагинации.

Name	Type	Description
total	integer<int32>	Сколько всего найдено элементов.
from	integer<int32>	Начальный номер найденного элемента на странице.
to	integer<int32>	Конечный номер найденного элемента на странице.
currentPage	integer<int32>	Текущая страница.
pagesCount	integer<int32>	Общее количество страниц.
pageSize	integer<int32>	Размер страницы.

400 Bad Request

Запрос содержит неправильные данные.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

ApiResponseStatusType

Тип ответа.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

ApiErrorDTO

Общий формат ошибки.

Name	Type	Description
code*	string	Код ошибки.
message	string	Описание ошибки.

401 Unauthorized

В запросе не указаны данные для авторизации.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

403 Forbidden

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

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

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

RequestRequest

Path parametersPath parameters

Query parametersQuery parameters

ResponsesResponses

200 OK200 OK

BodyBody

FeedCategoryDTOFeedCategoryDTO

FlippingPagerDTOFlippingPagerDTO

400 Bad Request400 Bad Request

BodyBody

ApiResponseStatusTypeApiResponseStatusType

ApiErrorDTOApiErrorDTO

401 Unauthorized401 Unauthorized

BodyBody

403 Forbidden403 Forbidden

BodyBody

404 Not Found404 Not Found

BodyBody

420 Method Failure420 Method Failure

BodyBody

500 Internal Server Error500 Internal Server Error

BodyBody

Была ли статья полезна?

Request

Path parameters

Query parameters

Responses

200 OK

Body

FeedCategoryDTO

FlippingPagerDTO

400 Bad Request

Body

ApiResponseStatusType

ApiErrorDTO

401 Unauthorized

Body

403 Forbidden

Body

404 Not Found

Body

420 Method Failure

Body

500 Internal Server Error

Body