Список магазинов пользователя

Info

Console

Метод доступен для моделей: FBY, FBS, Экспресс и DBS.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

inventory-and-order-processing — Обработка заказов и учёт товаров
inventory-and-order-processing:read-only — Просмотр информации о заказах
pricing — Управление ценами
pricing:read-only — Просмотр цен
offers-and-cards-management — Управление товарами и карточками
offers-and-cards-management:read-only — Просмотр товаров и карточек
promotion — Продвижение товаров
promotion:read-only — Просмотр информации о продвижении товаров
finance-and-accounting — Просмотр финансовой информации и отчётности
communication — Общение с покупателями
settings-management — Настройка магазинов
supplies-management:read-only — Получение информации по FBY-заявкам
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

Для Api-Key-токена: возвращает список магазинов в кабинете, для которого выдан токен. Нельзя получить список только подагентских магазинов.

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

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

Request

GET

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

Query parameters

Name

Description

page

Type: integer<int32>

Если в методе есть page_token

Используйте его вместо параметра page.

Подробнее о типах пагинации и их использовании

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

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

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

Default: 1

Max value: 10000

pageSize

Type: integer<int32>

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

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

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

Responses

200 OK

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

Body

application/json

{
    "campaigns": [
        {
            "domain": "string",
            "id": 0,
            "clientId": 0,
            "business": {
                "id": 0,
                "name": "string"
            },
            "placementType": "FBS",
            "apiAvailability": "AVAILABLE"
        }
    ],
    "pager": {
        "total": 0,
        "from": 0,
        "to": 0,
        "currentPage": 0,
        "pagesCount": 0,
        "pageSize": 0
    }
}

Name

Description

campaigns*

Type: CampaignDTO[]

Список с информацией по каждому магазину.
Информация о магазине.

pager

Type: FlippingPagerDTO

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

CampaignDTO

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

Name	Description
apiAvailability	Type: ApiAvailabilityStatusType Возможность использовать API: `AVAILABLE` — методы API доступны для выполнения запросов. `DISABLED_BY_INACTIVITY` — методы API недоступны из-за неактивности магазина или кабинета. Enum: `AVAILABLE`, `DISABLED_BY_INACTIVITY`
business	Type: BusinessDTO Информация о кабинете.
clientId ⦸	Type: integer<int64> Идентификатор плательщика в Яндекс Балансе.
domain	Type: string Название магазина.
id	Type: integer<int64> Идентификатор кампании. Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете — нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули: блок Идентификатор кампании; вкладка Лог запросов → выпадающий список в блоке Показывать логи. ⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.
placementType	Type: PlacementType Модель, по которой работает магазин: `FBS` — FBS или Экспресс. `FBY` — FBY. `DBS` — DBS. Enum: `FBS`, `FBY`, `DBS`, `LAAS`

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> Сколько всего найдено элементов.

ApiAvailabilityStatusType

Возможность использовать API:

AVAILABLE — методы API доступны для выполнения запросов.
DISABLED_BY_INACTIVITY — методы API недоступны из-за неактивности магазина или кабинета.

Type	Description
ApiAvailabilityStatusType	Enum: `AVAILABLE`, `DISABLED_BY_INACTIVITY`

BusinessDTO

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

Name

Description

Type: integer<int64>

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

name

Type: string

Название бизнеса.

PlacementType

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

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

Type	Description
PlacementType	Enum: `FBS`, `FBY`, `DBS`, `LAAS`

400 Bad Request

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

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

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

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

ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

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

401 Unauthorized

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

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

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

OK — ошибок нет.
ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

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

Все обновления

Информация о магазине