Обзор методов
Методы на уровне кабинета
Часть методов из списка — например, управляющие каталогом товаров — работают на уровне кабинета вне зависимости от того, какие модели подключены и используются. Что такое кабинет
В параметрах пути передается идентификатор кабинета — businessId. Пример: POST v2/businesses/{businessId}/settings
Как получить идентификатор кабинета
Методы на уровне магазина
Есть методы, которые работают с отдельными магазинами внутри кабинета. Что такое магазин на Маркете
Для их вызова необходим идентификатор кампании campaignId. Пример: GET v2/campaigns/{campaignId}/orders/{orderId}
Как получить идентификатор кампании
Часть таких методов перечислена в общем списке, некоторые работают только для определенных моделей размещения:
Методы для получения отчетов
Ресурс reports позволяет запрашивать и получать отчеты о вашей работе на Маркете. Пример: POST v2/reports/shows-sales/generate
В зависимости от типа отчета может потребоваться как businessId, так и campaignId. Как получить
Например, чтобы запустить генерацию отчета по оборачиваемости — POST v2/reports/goods-turnover/generate, необходим идентификатор кампании — campaignId.
Справочные методы
В запросах, которые предоставляют общую информацию, не относящуюся к конкретному бизнесу, не требуются идентификаторы businessId илиcampaignId.
| Общие ресурсы | Информация, которую они возвращают |
|---|---|
auth |
данные о Api-Key-токене |
categories |
категории Маркета |
models |
модели товаров |
regions |
как регион представлен в геобазе Маркета |
tariffs |
тарифы Маркета |
warehouses |
склады Маркета |
Как получить идентификаторы кабинета и кампании
Чтобы получить идентификаторы businessId и campaignId, выполните запрос GET v2/campaigns. Он возвращает все идентификаторы, к которым открывает доступ заданный токен авторизации.
Идентификатор кампании можно также найти в кабинете продавца на Маркете — нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:
- блок Идентификатор кампании;
- вкладка Лог запросов → выпадающий список в блоке Показывать логи.