Список магазинов пользователя
Для Api-Key-токена: возвращает список магазинов в кабинете, для которого выдан токен. Нельзя получить список только подагентских магазинов.
Для OAuth-токена: возвращает список магазинов, к которым имеет доступ пользователь — владелец авторизационного токена, использованного в запросе. Для агентских пользователей список состоит из подагентских магазинов.
⚙️ Лимит: 1000 запросов в час |
---|
Request
GET
https://api.partner.market.yandex.ru/campaigns
Query parameters
Name |
Description |
page |
Type: integer<int32> Номер страницы результатов. Используется вместе с параметром
Default: Max value: |
pageSize |
Type: integer<int32> Размер страницы. Используется вместе с параметром
|
Responses
200 OK
Магазины пользователя.
Body
application/json
{
"campaigns": [
{
"domain": "string",
"id": 0,
"clientId": 0,
"business": {
"id": 0,
"name": "string"
},
"placementType": "FBS"
}
],
"pager": {
"total": 0,
"from": 0,
"to": 0,
"currentPage": 0,
"pagesCount": 0,
"pageSize": 0
}
}
Name |
Description |
campaigns* |
Type: CampaignDTO[] Список с информацией по каждому магазину. |
pager |
Type: FlippingPagerDTO Модель для пагинации. |
CampaignDTO
Информация о магазине.
Name |
Description |
business |
Type: BusinessDTO Информация о кабинете. |
clientId |
Type: integer<int64> Идентификатор плательщика в Яндекс Балансе. |
domain |
Type: string URL магазина. |
id |
Type: integer<int64> Идентификатор кампании. |
placementType |
Type: PlacementType Модель, по которой работает магазин:
Enum: |
FlippingPagerDTO
Модель для пагинации.
Name |
Description |
currentPage |
Type: integer<int32> Текущая страница. |
from |
Type: integer<int32> Начальный номер найденного элемента на странице. |
pageSize |
Type: integer<int32> Размер страницы. |
pagesCount |
Type: integer<int32> Общее количество страниц. |
to |
Type: integer<int32> Конечный номер найденного элемента на странице. |
total |
Type: integer<int32> Сколько всего найдено элементов. |
BusinessDTO
Информация о кабинете.
Name |
Description |
id |
Type: integer<int64> Идентификатор кабинета. |
name |
Type: string Название бизнеса. |
PlacementType
Модель, по которой работает магазин:
FBS
— FBS или Экспресс.FBY
— FBY.DBS
— DBS.
Type |
Description |
Enum: |
400 Bad Request
Запрос содержит неправильные данные.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
ApiErrorDTO
Общий формат ошибки.
Name |
Description |
code* |
Type: string Код ошибки. |
message |
Type: string Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
404 Not Found
Запрашиваемый ресурс не найден.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. |
status |
Type: ApiResponseStatusType Тип ответа. Enum: |