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 be changed.

Report on the movement of goods

Info

Console

The method is available for the FBY model.

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

inventory-and-order-processing — Order processing and inventory
offers-and-cards-management — Manage products and cards
all-methods — Full account management

Starts the generation of a report on the movement of goods. What kind of report is this

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

Explanation of the report columns:

Sheet Отчет по движению товаров (file movement_by_sku)

CSV column name	JSON column name	XLSX column name	Value type
SHOP_SKU	shopSku	SKU	string
SKU_NAME	skuName	Название товара	string
SHIPMENTS_INCOME	shipmentsIncome	Поставки	integer
RETURNS_INCOME	returnsIncome	Возвраты	integer
INVENTORY_SURPLUS	inventorySurplus	Излишки при инвентаризации	integer
ORDERS_OUTCOME	ordersOutcome	Заказы	integer
WAREHOUSE_WITHDRAWAL	warehouseWithdrawal	Вывоз со склада	integer
RECYCLING	recycling	Утилизация	integer
INVENTORY_SHORTAGE	inventoryShortage	Недостача при инвентаризации	integer
WAREHOUSE_NAME	warehouseName	Склад	string

Sheet Отчет по движению товара (file movement_by_type)

CSV column name	JSON column name	XLSX column name	Value type
MOVEMENT_TYPE	movementType	Cобытие	string
MOVEMENT_NUMBER	movementNumber	Номер документа	integer
ORDER_ID	orderId	Номер заказа	integer
DATE	date	Дата	string
INCOME	income	Поступило	integer
OUTCOME	outcome	Выбыло	integer
WAREHOUSE_NAME	warehouseName	Склад	string

, Limit: 100 requests per hour

Request

POST

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

Query parameters

Name

Description

format

Type: ReportFormatType

The format of the report or document.

ReportFormatType

Report format:

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

Type

Description

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json

{
    "campaignId": 0,
    "dateFrom": "2022-09-22",
    "dateTo": "2022-09-23",
    "shopSku": "string"
}

Name	Description
campaignId*	Type: integer<int64> The campaign ID. You can find it using a query GET campaigns or find it in the seller's office on the Market — click on the name of your business and go to the page: Modules and APIs → block Sending data to Yandex.Market. Query log → drop-down list in the block Show logs. , Do not send the store's ID instead, which is indicated in the seller's account on the Market next to the store's name and in some reports. Min value: `1`
dateFrom*	Type: string<date> The beginning of the period, inclusive. Date format: `YYYY-MM-DD`. Example: `2022-09-22`
dateTo*	Type: string<date> End of the period, inclusive. Date format: `YYYY-MM-DD`. Example: `2022-09-23`
shopSku	Type: string Your SKU is the product identifier in your system. SKU Usage Rules: Each product must have its own SKU. An already set SKU cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before. The SKU of the product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers. What is a SKU and how to assign it Min length: `1` Max length: `255` Pattern: `^(?=.\S.)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$`

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

result

Type: GenerateReportDTO

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

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

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.

ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

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

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 mistakes.
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 mistakes.
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 mistakes.
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 mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error of 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 mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

Sales Geography Report

Order Report