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.

Market 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 "Market Prices" report.

The report returns information for only 50,000 products. If you have more than that, use filters.

The data in this report is constantly updated

Therefore, the information is in it and in the seller's account on the Market on the page Prices it may vary.

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 business_prices_v2_report)

CSV column name	JSON column name	XLSX column name	Value type
SHOP_SKU	shopSku	SKU	string
OFFER	offer	Товар на Маркете	string
CATEGORY	category	Категория	string
MERCH_PRICE_WITH_PROMOS	merchPriceWithPromos	Ваша цена (Со скидками за ваш счёт, ₽)	integer
MERCH_PRICE_WITH_PROMOS	merchPriceWithPromos	Со скидками за ваш счёт, ₽	integer
MERCH_PRICE	merchPrice	Ваша цена, ₽	integer
PRICE_GREEN_THRESHOLD	priceGreenThreshold	Порог для привлекательной цены, ₽	integer
HOW_MUCH_TO_REDUCE	howMuchToReduce	На сколько снизить (до привлекательной цены, ₽)	integer
PRICE_RED_THRESHOLD	priceRedThreshold	Порог для умеренно привлекательной цены, ₽	integer
ON_DISPLAY	onDisplay	На витрине, ₽	integer
SHOWS_FOR_30_DAYS	showsFor30Days	Показы товара за 30 дней	integer
SALES_COUNT_FOR_30_DAYS	salesCountFor30Days	Продажи за 30 дней, шт.	integer
SALES_FOR_30_DAYS	salesFor30Days	Продажи за 30 дней, ₽	integer
MINIMUM_PRICE_ON_MARKETPLACES	minimumPriceOnMarketplaces	Минимальная на рынке, ₽	integer
MARKETPLACE_WITH_BEST_PRICE_WITHOUT_MARKET	marketplaceWithBestPriceWithoutMarket	Площадка с лучшей ценой (без учёта Маркета)	string
PRICE_VALUE_OUTSIDE_MARKET	priceValueOutsideMarket	Цена на этой площадке, ₽	integer
PRICE_VALUE_ON_MARKET	priceValueOnMarket	Цена в этом магазине, ₽	integer
SHOP_WITH_BEST_PRICE_ON_MARKET	shopWithBestPriceOnMarket	Магазин с лучшей ценой на Маркете	string
COMPARISON_OF_YOUR_PRICES_ON_MARKETPLACES	comparisonOfYourPricesOnMarketplaces	Сравнение ваших цен на площадках	string
PRICE	price	Цена, ₽	integer

, Limit: 100 requests per hour

Request

POST

https://api.partner.market.yandex.ru/reports/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,
    "campaignId": 0,
    "categoryIds": [
        0
    ],
    "creationDateFrom": "string",
    "creationDateTo": "string"
}

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's ID instead, which is indicated in the seller's account on the Market next to the store's name and in some reports.
categoryIds	Type: integer<int64>[] Filter by category on the Market. Min items: `1` Unique items
creationDateFrom	Type: string<date> Filter by the time the offer appeared — the beginning of the period. Date format: `DD-MM-YYYY`.
creationDateTo	Type: string<date> The filter based on the time when the offer appeared is the end of the period. Date format: `DD-MM-YYYY`.

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

Was the article helpful?

Product Report

Getting a given report or document