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

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

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

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

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

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

Request

GET

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

Query parameters

Name

Description

page

Type: integer

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

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

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

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

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

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

Default: 1

Max value: 10000

pageSize

Type: integer

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

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

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

Responses

200 OK

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

Body

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

Name

Description

campaigns

Type: CampaignDTO[]

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

Example
[
  {
    "domain": "example",
    "id": 1,
    "clientId": 0,
    "business": {
      "id": 1,
      "name": "example"
    },
    "placementType": "FBS",
    "apiAvailability": "AVAILABLE"
  }
]

pager

Type: FlippingPagerDTO

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

Example
{
  "total": 0,
  "from": 0,
  "to": 0,
  "currentPage": 0,
  "pagesCount": 0,
  "pageSize": 0
}

CampaignId

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

  • идентификатором магазина, который отображается в личном кабинете продавца;
  • рекламными кампаниями.

Type: integer

Min value: 1

BusinessId

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

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

Type: integer

Min value: 1

BusinessDTO

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

Name

Description

id

Type: BusinessId

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

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

Min value: 1

Example: 1

name

Type: string

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

Example: example
Example
{
  "id": 1,
  "name": "example"
}

PlacementType

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

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

Type: string

Enum: FBS, FBY, DBS, LAAS

ApiAvailabilityStatusType

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

  • AVAILABLE — методы API доступны для выполнения запросов.
  • DISABLED_BY_INACTIVITY — методы API недоступны, так как магазин не размещал товары на витрине больше 90 дней.
  • DISABLED_BY_NO_ACTIVE_CONTRACT — методы API недоступны из-за отсутствия активного договора с Маркетом.
  • MANUALLY_DISABLED — методы API недоступны, так как интеграция выключена вручную.
  • DISABLED_BY_NO_PLACEMENT_TYPE — методы API недоступны, так как магазин не подключен к программе размещения.

Подробная инструкция по восстановлению доступа

Type: string

Enum: AVAILABLE, DISABLED_BY_INACTIVITY, DISABLED_BY_NO_ACTIVE_CONTRACT, MANUALLY_DISABLED, DISABLED_BY_NO_PLACEMENT_TYPE

CampaignDTO

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

Name

Description

apiAvailability

Type: ApiAvailabilityStatusType

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

  • AVAILABLE — методы API доступны для выполнения запросов.
  • DISABLED_BY_INACTIVITY — методы API недоступны, так как магазин не размещал товары на витрине больше 90 дней.
  • DISABLED_BY_NO_ACTIVE_CONTRACT — методы API недоступны из-за отсутствия активного договора с Маркетом.
  • MANUALLY_DISABLED — методы API недоступны, так как интеграция выключена вручную.
  • DISABLED_BY_NO_PLACEMENT_TYPE — методы API недоступны, так как магазин не подключен к программе размещения.

Подробная инструкция по восстановлению доступа

Enum: AVAILABLE, DISABLED_BY_INACTIVITY, DISABLED_BY_NO_ACTIVE_CONTRACT, MANUALLY_DISABLED, DISABLED_BY_NO_PLACEMENT_TYPE

business

Type: BusinessDTO

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

Example
{
  "id": 1,
  "name": "example"
}

clientId

Type: integer

Идентификатор плательщика в Яндекс Балансе.

domain

Type: string

Название магазина.

Example: example

id

Type: CampaignId

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

  • идентификатором магазина, который отображается в личном кабинете продавца;
  • рекламными кампаниями.

Min value: 1

Example: 1

placementType

Type: PlacementType

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

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

Enum: FBS, FBY, DBS, LAAS
Example
{
  "domain": "example",
  "id": 1,
  "clientId": 0,
  "business": {
    "id": 1,
    "name": "example"
  },
  "placementType": "FBS",
  "apiAvailability": "AVAILABLE"
}

FlippingPagerDTO

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

Name

Description

currentPage

Type: integer

Текущая страница.

from

Type: integer

Начальный номер найденного элемента на странице.

pagesCount

Type: integer

Общее количество страниц.

pageSize

Type: integer

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

to

Type: integer

Конечный номер найденного элемента на странице.

total

Type: integer

Сколько всего найдено элементов.
Example
{
  "total": 0,
  "from": 0,
  "to": 0,
  "currentPage": 0,
  "pagesCount": 0,
  "pageSize": 0
}

400 Bad Request

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR
Example
{
  "status": "OK"
}

ApiErrorDTO

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

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

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

Example: example
Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

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

401 Unauthorized

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

403 Forbidden

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

404 Not Found

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

420 Method Failure

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

500 Internal Server Error

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

No longer supported, please use an alternative and newer version.

Предыдущая
Все обновления
Следующая
Информация о магазине