Магазины пользователя

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

⚙️ Лимит: 1000 запросов в час

Request

GET

https://api.partner.market.yandex.ru/campaigns

Query parameters

Name

Description

page

Type: integer<int32>

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

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

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

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

Default: 1

pageSize

Type: integer<int32>

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

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

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

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

Модель, по которой работает магазин:

  • FBS — FBS или Экспресс.
  • FBY — FBY.
  • DBS — DBS.

Enum: FBS, FBY, DBS

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

PlacementType

Enum: FBS, FBY, DBS

400 Bad Request

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

ApiErrorDTO

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

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

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

ApiResponseStatusType

Тип ответа.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

401 Unauthorized

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

403 Forbidden

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

404 Not Found

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

420 Method Failure

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

500 Internal Server Error

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR