Структура и содержание отчетов могут изменяться без предварительного уведомления

Например, может добавиться новая колонка или поменяться название листа.

Отчет «Цены»

Метод доступен для всех моделей.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Запускает генерацию отчета «Цены».

Какая информация вернется:

  • если передать businessId — по единым ценам кабинета;
  • если включены магазинные цены и указать campaignId — по ценам в соответствующем магазине.

Узнать статус генерации и получить ссылку на готовый отчет можно с помощью запроса GET v2/reports/info/{reportId}.

Пояснение к колонкам отчета:

Лист Список товаров (файл business_prices)

Название колонки в CSV

Название колонки в JSON

Название колонки в XLSX

Тип значения

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

Пояснение к колонкам отчета:

Лист Список товаров (файл shop_prices)

Название колонки в CSV

Название колонки в JSON

Название колонки в XLSX

Тип значения

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
⚙️ Лимит: 100 запросов в час

Request

POST

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

Query parameters

Name

Description

format

Type: ReportFormatType

Формат отчета или документа.

ReportFormatType

Формат отчета:

  • FILE — файл с электронной таблицей (XLSX).
  • CSV — ZIP-архив с CSV-файлами на каждый лист отчета.
  • JSON — ZIP-архив с JSON-файлами на каждый лист отчета.

Type

Description

ReportFormatType

Default: FILE

Enum: FILE, CSV, JSON

Body

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

Name

Description

businessId

Type: integer<int64>

Идентификатор кабинета.

В большинстве случаев обязателен. Не указывается, если задан campaignId.

campaignId

Type: integer<int64>

Идентификатор кампании.

Передавайте, только если в кабинете есть магазины с уникальными ценами и вы хотите получить отчет для них. В этом случае передавать businessId не нужно.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете — нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

categoryIds

Type: integer[]

Фильтр по категориям на Маркете.

Min value (exclusive): 0

Min items: 1

Unique items  

Responses

200 OK

В ответ приходит идентификатор, который позволяет узнавать статус генерации и скачать готовый отчет.

Body

application/json
{
    "status": "OK",
    "result": {
        "reportId": "string",
        "estimatedGenerationTime": 0
    }
}

Name

Description

status*

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

result

Type: GenerateReportDTO

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GenerateReportDTO

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.

Name

Description

estimatedGenerationTime*

Type: integer<int64>

Ожидаемая продолжительность генерации в миллисекундах.

reportId*

Type: string

Идентификатор, который понадобится для отслеживания статуса генерации и получения готового отчета или документа.

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

Описание ошибки.

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

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

В методе POST v2/businesses/{businessId}/settings возвращается параметр onlyDefaultPrice со значением false.

Предыдущая
Отчет по товарам
Следующая
Получение заданного отчета или документа