The structure and content of the reports are subject to change without prior notice.

For example, a new column may be added or the name of the sheet may change.

Warehouse balance report

Info

Console

The method is available for models: FBY, FBS, Express and DBS.

If you are using an API Key token, one of the accesses in the list is required to call the method

offers-and-cards-management — Manage products and cards
all-methods — Full account management

Starts the generation of a report on inventory balances. What kind of report is this

What information will be returned:

For the model FBY if you specify campaignId, — about the leftovers in the Market warehouses.
For other models, if you specify campaignId, — about the leftovers in the store's corresponding warehouse.
For other models, if you specify businessId, — about the leftovers in all store warehouses in the cabinet, except FBY. Use a filter campaignIds to specify specific stores.

⚠️ Do not transmit at the same time campaignId and businessId.

You can find out the generation status and get a link to the finished report using a request. GET v2/reports/info/{reportId}.

Market Warehouse

Store Warehouse

All store warehouses in the office, except FBY

Explanation of the report columns:

Sheet Остатки на складе (file stocks_on_warehouses)

CSV column name	JSON column name	XLSX column name	Value type
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
TURNOVER	turnover	Оборачиваемость за \d{2}.\d{2}.\d{2}-\d{2}.\d{2}.\d	string

Explanation of the report columns:

Sheet Список товаров (file mass_shared_stocks)

CSV column name	JSON column name	XLSX column name	Value type
ERRORS	errors	Критичные ошибки	string
WARNINGS	warnings	Некритичные ошибки	string
SHOP_SKU	shopSku	Ваш SKU *	string
PRODUCT_NAME	productName	Название товара	string
COUNT	count	Доступное количество товара *	integer

Explanation of the report columns:

Sheet Остатки на складах (file stocks_business)

CSV column name	JSON column name	XLSX column name	Value type
ERRORS	errors	Критичные ошибки	string
SHOP_SKU	shopSku	Ваш SKU *	string
PRODUCT_NAME	productName	Название товара	string
PLACEMENT_TYPE	placementType	Модель работы	string
WAREHOUSE_AND_SHOP	warehouseAndShop	Склад *	string
COUNT	count	Доступно для заказа *	integer
RESERVE	reserve	Резерв	integer
PRICE	price	Цена	string
STATUS	status	Статус	string
COMMENT	comment	Примечание	string

⚙️ Limit: 100 requests per hour

Request

POST

https://api.partner.market.yandex.ru/v2/reports/stocks-on-warehouses/generate

Query parameters

Name

Description

format

Type: ReportFormatType

The format of the report or document.

ReportFormatType

Report format:

FILE — the spreadsheet file (XLSX).
CSV — A ZIP archive with CSV files for each report sheet.
JSON — A ZIP archive with JSON files for each report sheet.

Type

Description

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json

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

Name	Description
businessId	Type: integer<int64> For models only DBS, FBS and Express The ID of the cabinet for which the report should be generated (except for FBY-stores). Do not transmit together with `campaignId`.
campaignId	Type: integer<int64> For models DBS, FBS and Express This parameter will be unavailable soon. To receive information about the store's stock balances, send `businessId` and the ID of the required store in `campaignIds`. The campaign ID. You can find it using a query GET v2/campaigns or find it in the seller's office on the Market — click on your account icon → Settings and in the menu on the left, select APIs and modules: block Campaign ID; tab Query log → drop-down list in the block Show logs. ⚠️ Do not send the store ID instead, which is indicated in the seller's account on the Market next to the store name and in some reports. Do not transmit together with `businessId`.
campaignIds	Type: integer<int64>[] Filter by stores for the cabinet report (except for the model FBY). Transmit along with `businessId`. The campaign list of those stores for which you need to get information. You can find them using a query. GET v2/campaigns or find it in the seller's office on the Market — click on your account icon → Settings and in the menu on the left, select APIs and modules: block Campaign ID; tab Query log → drop-down list in the block Show logs. ⚠️ Do not use store IDs instead, which are listed in the seller's account on the Market next to the store name and in some reports. Min items: `1` Unique items
categoryIds	Type: integer<int32>[] Filter by category on the Market (except for the model FBY). Min value (exclusive): `0` Min items: `1` Unique items
hasStocks	Type: boolean Filter by presence of leftovers (except for the model FBY).
reportDate	Type: string<date> Filter by date (for the model FBY). The report will include data for the previous one Good afternoon.
warehouseIds	Type: integer<int64>[] Filter by warehouse IDs (model only FBY). To find out the ID, use the request GET v2/warehouses. Min items: `1` Unique items

Responses

200 OK

In response, you receive an identifier that allows you to find out the generation status and download the finished report.

Body

application/json

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

Name

Description

status*

Type: ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

result

Type: GenerateReportDTO

The ID that will be needed to track the generation status and receive the finished report or document.

ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

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

GenerateReportDTO

The ID that will be needed to track the generation status and receive the finished report or document.

Name

Description

estimatedGenerationTime*

Type: integer<int64>

Expected generation time in milliseconds.

reportId*

Type: string

The ID that will be needed to track the generation status and receive the finished report or document.

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ApiErrorDTO

The general error format.

Name

Description

code*

Type: string

The error code.

message

Type: string

Description of the error.

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error in Yandex. Market. More information about the error

Body

application/json

{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

Turnover Report (FBY)

Product Reviews Report