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.

The Prices Report

Info

Console

The method is available for all models.

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

pricing — Manage prices
promotion — Product promotion
finance-and-accounting — View financial data and reports
all-methods — Full account management

Starts the generation of the "Prices" report.

What information will be returned:

if you pass businessId — at the same cabinet prices;
if The store prices are included and specify campaignId — according to the prices in the corresponding store.

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

Prices in all cabinet stores

Store prices

Explanation of the report columns:

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

CSV column name	JSON column name	XLSX column name	Value type
ERRORS	errors	Критичные ошибки	string
WARNINGS	warnings	Некритичные ошибки	string
OFFER_ID	offerId	Ваш SKU	string
OFFER_NAME	offerName	Название товара	string
BASIC_PRICE	basicPrice	Цена	integer
BASIC_DISCOUNT_BASE	basicDiscountBase	Зачёркнутая цена	integer
CURRENCY	currency	Валюта	string
MINIMUM_FOR_BESTSELLER	minimumForBestseller	Минимум для акции	integer
COST_PRICE	costPrice	Себестоимость	integer
ADDITIONAL_EXPENSES	additionalExpenses	Дополнительные расходы	integer
ON_DISPLAY	onDisplay	На витрине	string
PRICE_GREEN_THRESHOLD	priceGreenThreshold	Порог для выгодной цены	integer
PRICE_RED_THRESHOLD	priceRedThreshold	Порог для умеренно привлекательной цены	integer
MINIMUM_PRICE_ON_MARKETPLACES	minimumPriceOnMarketplaces	Минимальная на рынке	integer
MARKETPLACE_WITH_BEST_PRICE_WITHOUT_MARKET	marketplaceWithBestPriceWithoutMarket	Площадка с лучшей ценой (без учёта Маркета)	string
PRICE_VALUE_OUTSIDE_MARKET	priceValueOutsideMarket	Цена на этой площадке	integer
SHOP_WITH_BEST_PRICE_ON_MARKET	shopWithBestPriceOnMarket	Магазин с лучшей ценой на Маркете	string
PRICE_VALUE_ON_MARKET	priceValueOnMarket	Цена в этом магазине	integer

Explanation of the report columns:

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

CSV column name	JSON column name	XLSX column name	Value type
ERRORS	errors	Критичные ошибки	string
WARNINGS	warnings	Некритичные ошибки	string
OFFER_ID	offerId	Ваш SKU	string
OFFER_NAME	offerName	Название товара	string
SHOP_PRICE	shopPrice	Цена в магазине	integer
SHOP_DISCOUNT_BASE	shopDiscountBase	Зачёркнутая цена в магазине	integer
CURRENCY	currency	Валюта	string
VAT	vat	НДС	string
HIDE_FROM_DISPLAY	hideFromDisplay	Скрыть с витрины	string
BASIC_PRICE	basicPrice	Цена	integer
BASIC_DISCOUNT_BASE	basicDiscountBase	Зачёркнутая цена	integer
ON_DISPLAY	onDisplay	На витрине	string
PRICE_GREEN_THRESHOLD	priceGreenThreshold	Порог для выгодной цены	integer
PRICE_RED_THRESHOLD	priceRedThreshold	Порог для умеренно привлекательной цены	integer
MINIMUM_PRICE_ON_MARKETPLACES	minimumPriceOnMarketplaces	Минимальная на рынке	integer
MARKETPLACE_WITH_BEST_PRICE_WITHOUT_MARKET	marketplaceWithBestPriceWithoutMarket	Площадка с лучшей ценой (без учёта Маркета)	string
PRICE_VALUE_OUTSIDE_MARKET	priceValueOutsideMarket	Цена на этой площадке	integer
SHOP_WITH_BEST_PRICE_ON_MARKET	shopWithBestPriceOnMarket	Магазин с лучшей ценой на Маркете	string
PRICE_VALUE_ON_MARKET	priceValueOnMarket	Цена в этом магазине	integer

, Limit: 100 requests per hour

Request

POST

https://api.partner.market.yandex.ru/reports/goods-prices/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

{
    "businessId": 0,
    "categoryIds": [
        0
    ],
    "campaignId": 0
}

Name	Description
businessId	Type: integer<int64> Cabinet ID. Required in most cases. Omitted if specified `campaignId`.
campaignId	Type: integer<int64> The campaign ID. Send it only if there are shops with unique prices in the cabinet and you want to receive a report for them. In this case, send `businessId` no need. 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.
categoryIds	Type: integer<int32>[] Filter by category on the Market. Min value (exclusive): `0` 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

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?

Product Report

Getting a given report or document