Структура и содержание отчетов могут изменяться без предварительного уведомления
Например, может добавиться новая колонка или поменяться название листа.
Отчет по оборачиваемости
Метод доступен для модели FBY.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- offers-and-cards-management — Управление товарами и карточками
- finance-and-accounting — Просмотр финансовой информации и отчётности
- all-methods — Полное управление кабинетом
Запускает генерацию отчета по оборачиваемости за заданную дату. Что это за отчет
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET v2/reports/info/{reportId}.
Пояснение к колонкам отчета:
Лист Все категории (файл turnover)
|
Название колонки в CSV |
Название колонки в JSON |
Название колонки в XLSX |
Тип значения |
|
WAREHOUSE_NAME |
warehouseName |
Склад Маркета |
string |
|
MACROREGION_NAME |
macroregionName |
Кластер |
string |
|
CATEGORY |
category |
Категория |
string |
|
SHOP_SKU |
shopSku |
Ваш SKU |
string |
|
MARKET_SKU |
marketSku |
SKU на Маркете |
integer |
|
OFFER_NAME |
offerName |
Название товара |
string |
|
LENGTH |
length |
Длина, мм |
integer |
|
WIDTH |
width |
Ширина, мм |
integer |
|
HEIGHT |
height |
Высота, мм |
integer |
|
VOLUME |
volume |
Объём, л |
number |
|
TURNOVER |
turnover |
Оборачиваемость |
string |
|
MARKET_RECOMMENDATION |
marketRecommendation |
Рекомендация Маркета |
string |
|
AVG_SOLD_VOLUME |
avgSoldVolume |
Среднесуточный объём проданных товаров, л |
number |
|
AVG_SOLD_ITEMS |
avgSoldItems |
Среднесуточное количество проданных товаров, шт. |
number |
|
AVG_SOLD_VOLUME_ON_STOCK |
avgSoldVolumeOnStock |
Среднесуточный объём товаров на складе, л |
number |
|
ITEMS_ON_STOCK |
itemsOnStock |
Остаток на последний день периода, шт. |
integer |
|
AMOUNT |
amount |
Стоимость платного хранения.* |
number |
Лист Льготное хранение (файл preferential_categories_turnover)
|
Название колонки в CSV |
Название колонки в JSON |
Название колонки в XLSX |
Тип значения |
|
WAREHOUSE_NAME |
warehouseName |
Склад Маркета |
string |
|
MACROREGION_NAME |
macroregionName |
Кластер |
string |
|
CATEGORY |
category |
Категория |
string |
|
SHOP_SKU |
shopSku |
Ваш SKU |
string |
|
MARKET_SKU |
marketSku |
SKU на Маркете |
integer |
|
OFFER_NAME |
offerName |
Название товара |
string |
|
LENGTH |
length |
Длина, мм |
integer |
|
WIDTH |
width |
Ширина, мм |
integer |
|
HEIGHT |
height |
Высота, мм |
integer |
|
VOLUME |
volume |
Объём, л |
number |
|
TURNOVER |
turnover |
Оборачиваемость |
number |
|
MARKET_RECOMMENDATION |
marketRecommendation |
Рекомендация Маркета |
string |
|
AVG_SOLD_VOLUME |
avgSoldVolume |
Среднесуточный объём проданных товаров, л |
number |
|
AVG_SOLD_ITEMS |
avgSoldItems |
Среднесуточное количество проданных товаров, шт. |
number |
|
AVG_SOLD_VOLUME_ON_STOCK |
avgSoldVolumeOnStock |
Среднесуточный объём товаров на складе, л |
number |
|
ITEMS_ON_STOCK |
itemsOnStock |
Остаток на последний день периода, шт. |
integer |
|
AMOUNT |
amount |
Стоимость платного хранения.* |
number |
| ⚙️ Лимит: 100 запросов в час |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/reports/goods-turnover/generate
Query parameters
|
Name |
Description |
|
format |
Type: ReportFormatType Формат отчета или документа. Формат отчета:
Default: Enum: |
ReportFormatType
Формат отчета:
FILE— файл с электронной таблицей (XLSX).CSV— ZIP-архив с CSV-файлами на каждый лист отчета.JSON— ZIP-архив с JSON-файлами на каждый лист отчета.
Type: string
Default: FILE
Enum: FILE, CSV, JSON
Body
application/json
{
"campaignId": 1,
"date": "2025-01-01"
}
|
Name |
Description |
|
campaignId |
Type: CampaignId Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия. Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:
⚠️ Не путайте его с:
Min value: Example: |
|
date |
Type: string<date> Дата, за которую нужно рассчитать оборачиваемость. Если параметр не указан, используется текущая дата. Формат даты: Example: |
CampaignId
Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.
Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:
- блок Идентификатор кампании;
- вкладка Лог запросов → выпадающий список в блоке Показывать логи.
⚠️ Не путайте его с:
- идентификатором магазина, который отображается в личном кабинете продавца;
- рекламными кампаниями.
Type: integer
Min value: 1
Responses
200 OK
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
Body
application/json
{
"status": "OK"
}
Type: object
ApiResponseStatusType
Тип ответа. Возможные значения:
OK— ошибок нет.ERROR— при обработке запроса произошла ошибка.
Type: string
Enum: OK, ERROR
ApiResponse
Стандартная обертка для ответов сервера.
|
Name |
Description |
|
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
Example
{
"status": "OK"
}
GenerateReportDTO
Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.
|
Name |
Description |
|
estimatedGenerationTime |
Type: integer Ожидаемая продолжительность генерации в миллисекундах. |
|
reportId |
Type: string Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа. Example: |
Example
{
"reportId": "example",
"estimatedGenerationTime": 0
}
400 Bad Request
Запрос содержит неправильные данные. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
ApiErrorDTO
Общий формат ошибки.
|
Name |
Description |
|
code |
Type: string Код ошибки. Example: |
|
message |
Type: string Описание ошибки. 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:
1Example
[ { "code": "example", "message": "example" } ]Example
{ "errors": [ { "code": "example", "message": "example" } ] }
Example
{
"status": "OK"
}
401 Unauthorized
В запросе не указаны данные для авторизации. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
420 Method Failure
Превышено ограничение на доступ к ресурсу. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
500 Internal Server Error
Внутренняя ошибка Маркета. Подробнее об ошибке
Body
application/json
{
"status": "OK"
}
Type: object
No longer supported, please use an alternative and newer version.