Структура и содержание отчетов могут изменяться без предварительного уведомления
Например, может добавиться новая колонка или поменяться название листа.
Отчет по остаткам на складах
Метод доступен для всех моделей.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- offers-and-cards-management — Управление товарами и карточками
- all-methods — Полное управление кабинетом
Запускает генерацию отчета по остаткам на складах. Что это за отчет
Какая информация вернется:
- Для модели FBY — об остатках на складах Маркета.
- Для остальных моделей, если указать
businessId
, — об остатках на всех складах магазинов в кабинете, кроме FBY. Используйте фильтрcampaignIds
, чтобы указать определенные магазины. - Для остальных моделей, если указать
campaignId
, — об остатках на соответствующем складе магазина. Этот тип отчета скоро станет недоступен.
⚠️ Не передавайте одновременно campaignId
и businessId
.
Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET reports/info/{reportId}.
Пояснение к колонкам отчета:
Лист Остатки на складе (файл stocks_on_warehouses)
Название колонки в CSV |
Название колонки в JSON |
Название колонки в XLSX |
Тип значения |
SHOP_SKU |
shopSku |
SSKU |
string |
ARTICLE |
article |
Ваш SKU |
string |
MARKET_SKU |
marketSku |
SKU на Яндексе |
integer |
PRODUCT_NAME |
productName |
Название товара |
string |
VALID |
valid |
Годный |
integer |
RESERVED |
reserved |
Резерв |
integer |
AVAILABLE_FOR_ORDER |
availableForOrder |
Доступно для заказа |
integer |
QUARANTINE |
quarantine |
Карантин |
integer |
UTILIZATION |
utilization |
Передан на утилизацию |
integer |
DEFECT |
defect |
Брак |
integer |
EXPIRED |
expired |
Просрочен |
integer |
LENGTH |
length |
Длина, см |
integer |
WIDTH |
width |
Ширина, см |
integer |
HEIGHT |
height |
Высота, см |
integer |
WEIGHT |
weight |
Вес, кг |
number |
WAREHOUSE |
warehouse |
Склад |
string |
SELLING_STATUS |
sellingStatus |
Статус продаж |
string |
RECOMMENDATIONS |
recommendations |
Рекомендации |
string |
Пояснение к колонкам отчета:
Лист Отчет (файл mass_shared_stocks)
Название колонки в CSV |
Название колонки в JSON |
Название колонки в XLSX |
Тип значения |
ERRORS |
errors |
log-message |
string |
WARNINGS |
warnings |
info-message |
string |
SHOP_SKU |
shopSku |
id |
string |
PRODUCT_NAME |
productName |
name |
string |
COUNT |
count |
count |
integer |
Пояснение к колонкам отчета:
Лист Отчет (файл stocks_business)
Название колонки в CSV |
Название колонки в JSON |
Название колонки в XLSX |
Тип значения |
ERRORS |
errors |
log-message |
string |
SHOP_SKU |
shopSku |
id |
string |
PRODUCT_NAME |
productName |
name |
string |
PLACEMENT_TYPE |
placementType |
placement_type |
string |
WAREHOUSE_AND_SHOP |
warehouseAndShop |
warehouse_and_shop |
string |
COUNT |
count |
count |
integer |
RESERVE |
reserve |
reserve |
integer |
PRICE |
price |
price |
string |
STATUS |
status |
status |
string |
COMMENT |
comment |
comment |
string |
⚙️ Лимит: 100 запросов в час |
---|
Request
POST
https://api.partner.market.yandex.ru/reports/stocks-on-warehouses/generate
Query parameters
Name |
Description |
format |
Type: ReportFormatType Формат отчета или документа. |
ReportFormatType
Формат отчета:
FILE
— файл с электронной таблицей (XLSX).CSV
— ZIP-архив с CSV-файлами на каждый лист отчета.JSON
— ZIP-архив с JSON-файлами на каждый лист отчета.
Type |
Description |
Default: Enum: |
Body
application/json
{
"campaignId": 0,
"businessId": 0,
"warehouseIds": [
0
],
"reportDate": "string",
"categoryIds": [
0
],
"hasStocks": false,
"campaignIds": [
0
]
}
Name |
Description |
businessId |
Type: integer<int64> Идентификатор кабинета, по магазинам которого нужно сформировать отчет (кроме FBY-магазинов). Не передавайте вместе с |
campaignId |
Type: integer<int64> Отчет об остатках на конкретном складе магазина скоро станет недоступен. Идентификатор кампании. Его можно узнать с помощью запроса GET campaigns или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:
⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах. Не передавайте вместе с |
campaignIds |
Type: integer<int64>[] Фильтр по магазинам для отчета по кабинету (кроме модели FBY). Передавайте вместе с Их можно узнать с помощью запроса GET campaigns или найти в кабинете продавца на Маркете — нажмите на название своего бизнеса и перейдите на страницу:
⚠️ Не используйте вместо них идентификаторы магазинов, которые указаны в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах. Min items: Unique items |
categoryIds |
Type: integer<int64>[] Фильтр по категориям на Маркете (кроме модели FBY). Min items: Unique items |
hasStocks |
Type: boolean Фильтр по наличию остатков (кроме модели FBY). |
reportDate |
Type: string<date> Фильтр по дате (для модели FBY). В отчет попадут данные за предшествующий дате день. |
warehouseIds |
Type: integer<int64>[] Фильтр по идентификаторам складов (только модель FBY). Чтобы узнать идентификатор, воспользуйтесь запросом GET warehouses. Min items: Unique items |
Responses
200 OK
В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.
Body
application/json
{
"status": "OK",
"result": {
"reportId": "string",
"estimatedGenerationTime": 0
}
}
Name |
Description |
result |
Type: GenerateReportDTO Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа. |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
GenerateReportDTO
Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.
Name |
Description |
estimatedGenerationTime* |
Type: integer<int64> Ожидаемая продолжительность генерации в миллисекундах. |
reportId* |
Type: string Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа. |
ApiResponseStatusType
Тип ответа. Возможные значения:
OK
— ошибок нет.ERROR
— при обработке запроса произошла ошибка.
Type |
Description |
Enum: |
400 Bad Request
Запрос содержит неправильные данные. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
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: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
500 Internal Server Error
Внутренняя ошибка Маркета. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
No longer supported, please use an alternative and newer version.