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

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

Starts the generation of the "Prices" report.

What information will be returned:

  • if you send businessId — at the same cabinet prices;
  • if 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 v2/reports/info/{reportId}.

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/v2/reports/goods-prices/generate

Query parameters

Name

Description

format

Type: string

The format of the report or document.
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.

Default: FILE

Enum: FILE, CSV, JSON

Body

application/json
{
    "businessId": 0,
    "categoryIds": [
        0
    ],
    "campaignId": 0
}

Name

Description

businessId

Type: integer<int64>

Cabinet ID. To find out, use the request GET v2/campaigns.

ℹ️ What is a cabinet and a store on the Market?

Min value: 1

campaignId

Type: integer<int64>

The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.

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 confuse it with:

  • the store's identifier, which is displayed in the merchant's personal account.
  • advertising campaigns.

Min value: 1

categoryIds

Type: integer[]

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

status*

Type: string

The type of response. Possible values:

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

Enum: OK, ERROR

result
Type: object

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.

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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

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

Enum: OK, 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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

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 of the Market. More information about the error

Body

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

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

Enum: OK, ERROR

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

In the method POST v2/businesses/{businessId}/settings the parameter is returned onlyDefaultPrice with the value false.

Previous
Warehouse balance report
Next
Product Reviews Report