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