Структура и содержание отчетов могут изменяться без предварительного уведомления

Например, может добавиться новая колонка или поменяться название листа.

Отчет по оборачиваемости

Info

Console

Метод доступен для модели FBY.

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

offers-and-cards-management — Управление товарами и карточками
finance-and-accounting — Просмотр финансовой информации и отчётности
all-methods — Полное управление кабинетом

Запускает генерацию отчета по оборачиваемости за заданную дату. Что это за отчет

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET 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

Лист Льготное хранение (файл 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

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

Request

POST

https://api.partner.market.yandex.ru/reports/goods-turnover/generate

Query parameters

Name

Description

format

Type: ReportFormatType

Формат отчета или документа.

ReportFormatType

Формат отчета:

FILE — файл с электронной таблицей (XLSX).
CSV — ZIP-архив с CSV-файлами на каждый лист отчета.
JSON — ZIP-архив с JSON-файлами на каждый лист отчета.

Type

Description

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json

{
    "campaignId": 0,
    "date": "string"
}

Name

Description

campaignId*

Type: integer<int64>

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

Его можно узнать с помощью запроса GET campaigns или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:

Модули и API → блок Передача данных Маркету.
Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

date

Type: string<date>

Дата, за которую нужно рассчитать оборачиваемость. Если параметр не указан, используется текущая дата.

Responses

200 OK

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

Body

application/json

{
    "status": "OK",
    "result": {
        "reportId": "string",
        "estimatedGenerationTime": 0
    }
}

Name

Description

result

Type: GenerateReportDTO

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

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

GenerateReportDTO

Name

Description

estimatedGenerationTime*

Type: integer<int64>

Ожидаемая продолжительность генерации в миллисекундах.

reportId*

Type: string

ApiResponseStatusType

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

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

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

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

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

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

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

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

Отчет по невыкупам и возвратам

Отчет по остаткам на складах