Рекомендации Маркета, касающиеся цен
Метод доступен для всех моделей.
Пока недоступен для продавцов Market Yandex Go.
Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке
- pricing — Управление ценами
- pricing:read-only — Просмотр цен
- all-methods — Полное управление кабинетом
- all-methods:read-only — Просмотр всех данных
Метод возвращает рекомендации нескольких типов.
- Порог для привлекательной цены.
- Оценка привлекательности цен на витрине.
Рекомендации показывают, какие цены нужно установить, чтобы привлечь покупателя.
В запросе можно использовать фильтры. Результаты возвращаются постранично.
⚙️ Лимит: 100 запросов в минуту |
---|
Request
POST
https://api.partner.market.yandex.ru/businesses/{businessId}/offers/recommendations
Path parameters
Name |
Description |
businessId* |
Type: integer<int64> Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET campaigns. ℹ️ Что такое кабинет и магазин на Маркете
Min value: |
Query parameters
Name |
Description |
limit |
Type: integer<int32> Количество значений на одной странице.
Min value: |
page_token |
Type: string Идентификатор страницы c результатами. Если параметр не указан, возвращается первая страница. Рекомендуем передавать значение выходного параметра Если задан |
Body
application/json
{
"offerIds": [
"string"
],
"competitivenessFilter": "OPTIMAL"
}
Name |
Description |
competitivenessFilter |
Type: PriceCompetitivenessType Фильтр, выводящий товары, с привлекательными, умеренными и непривлекательными ценами. Enum: |
offerIds |
Type: string[] Идентификаторы товаров, информация о которых нужна. ⚠️ Не используйте это поле одновременно с остальными фильтрами. Если вы хотите воспользоваться фильтрами, оставьте поле пустым. Правила использования SKU:
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Что такое SKU и как его назначать Min length: Max length: Pattern: Min items: Unique items |
PriceCompetitivenessType
Привлекательность цены:
OPTIMAL
— привлекательная.AVERAGE
— умеренная.LOW
— непривлекательная.
Type |
Description |
Enum: |
Responses
200 OK
Список товаров с рекомендациями.
Body
application/json
{
"status": "OK",
"result": {
"paging": {
"nextPageToken": "string",
"prevPageToken": "string"
},
"offerRecommendations": [
{
"offer": {
"offerId": "string",
"price": {
"value": 0,
"currencyId": "RUR"
},
"competitiveness": "OPTIMAL",
"shows": 0
},
"recommendation": {
"offerId": "string",
"competitivenessThresholds": {
"optimalPrice": {
"value": 0,
"currencyId": "RUR"
},
"averagePrice": {
"value": 0,
"currencyId": "RUR"
}
}
}
}
]
}
}
Name |
Description |
result |
Type: OfferRecommendationsResultDTO Список товаров с рекомендациями. |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
OfferRecommendationsResultDTO
Список товаров с рекомендациями.
Name |
Description |
offerRecommendations* |
Type: OfferRecommendationDTO[] Страница списка товаров. |
paging |
Type: ScrollingPagerDTO Информация о страницах результатов. |
ApiResponseStatusType
Тип ответа. Возможные значения:
OK
— ошибок нет.ERROR
— при обработке запроса произошла ошибка.
Type |
Description |
Enum: |
OfferRecommendationDTO
Информация о состоянии цен и рекомендации.
Name |
Description |
offer |
Type: OfferForRecommendationDTO Информация о состоянии цен. |
recommendation |
Type: OfferRecommendationInfoDTO Рекомендации. |
ScrollingPagerDTO
Информация о страницах результатов.
Name |
Description |
nextPageToken |
Type: string Идентификатор следующей страницы результатов. |
prevPageToken |
Type: string Идентификатор предыдущей страницы результатов. |
OfferForRecommendationDTO
Информация о состоянии цены на товар.
Name |
Description |
competitiveness |
Type: PriceCompetitivenessType Привлекательность цены на товар. Enum: |
offerId |
Type: string Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU:
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Что такое SKU и как его назначать Min length: Max length: Pattern: |
price |
Type: BasePriceDTO Цена на товар. |
shows |
Type: integer<int64> Количество показов карточки товара за последние 7 дней. |
OfferRecommendationInfoDTO
Рекомендации, касающиеся цены на товар.
Name |
Description |
competitivenessThresholds |
Type: PriceCompetitivenessThresholdsDTO Максимальные значения цены, при которых она является привлекательной или умеренной. |
offerId |
Type: string Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU:
SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов. Что такое SKU и как его назначать Min length: Max length: Pattern: |
BasePriceDTO
Цена на товар.
Name |
Description |
currencyId* |
Type: CurrencyType Валюта. Enum: |
value* |
Type: number Цена товара. Min value (exclusive): |
PriceCompetitivenessThresholdsDTO
Максимальные значения цены, при которых она является привлекательной или умеренной.
Name |
Description |
averagePrice |
Type: BasePriceDTO Цена на товар. |
optimalPrice |
Type: BasePriceDTO Цена на товар. |
CurrencyType
Коды валют:
RUR
— российский рубль.UAH
— украинская гривна.BYR
— белорусский рубль.KZT
— казахстанский тенге.UZS
— узбекский сум.
Type |
Description |
Enum: |
400 Bad Request
Запрос содержит неправильные данные. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
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: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
404 Not Found
Запрашиваемый ресурс не найден. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
420 Method Failure
Превышено ограничение на доступ к ресурсу. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
500 Internal Server Error
Внутренняя ошибка Маркета. Подробнее об ошибке
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Description |
errors |
Type: ApiErrorDTO[] Список ошибок. Min items: |
status |
Type: ApiResponseStatusType Тип ответа. Возможные значения:
Enum: |
No longer supported, please use an alternative and newer version.
Если у вас установлена такая цена или ниже, она считается привлекательной.