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

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

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

Info

Console

Метод доступен для всех моделей.

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

offers-and-cards-management — Управление товарами и карточками
all-methods — Полное управление кабинетом

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

Отчет содержит данные:

Для модели FBY — об остатках на складах Маркета.
Для остальных моделей — об остатках на соответствующем складе магазина.

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

⚙️ Лимит: 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

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json

{
    "campaignId": 0,
    "warehouseIds": [
        0
    ],
    "reportDate": "string",
    "categoryIds": [
        0
    ],
    "hasStocks": false
}

Name	Description
campaignId*	Type: integer<int64> Идентификатор магазина.
categoryIds	Type: integer<int64>[] Фильтр по категориям на Маркете (кроме модели FBY). Min items: `1`
hasStocks	Type: boolean Фильтр по наличию остатков (кроме модели FBY).
reportDate	Type: string<date> Фильтр по дате (для модели FBY). В отчет попадут данные за предшествующий дате день.
warehouseIds	Type: integer<int64>[] Фильтр по идентификаторам складов (только модель FBY). Чтобы узнать идентификатор, воспользуйтесь запросом GET warehouses. Min items: `1`

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

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

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

Отчет по отзывам о товарах