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.

Turnover Report

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

Starts the generation of the turnover report for the specified date. 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 turnover)

CSV column name

JSON column name

XLSX column name

Value type

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

Sheet Льготное хранение (file preferential_categories_turnover)

CSV column name

JSON column name

XLSX column name

Value type

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

, Limit: 100 requests per hour

Request

POST

https://api.partner.market.yandex.ru/reports/goods-turnover/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,
    "date": "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 ID instead, which is indicated in the seller's account on the Market next to the store name and in some reports.

date

Type: string<date>

The date for which the turnover needs to be calculated. If the parameter is omitted, the current date is used.

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

Enum: OK, ERROR

No longer supported, please use an alternative and newer version.