Список товаров, находящихся в карантине (основная цена)
Возвращает список товаров, которые находятся на карантине по основной цене. Основная цена задается в каталоге и действует во всех магазинах кабинета.
Проверьте цену каждого из товаров, попавших в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST businesses/{businessId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST businesses/{businessId}/offer-prices/updates.
𝓠 Что такое карантин?
𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее
В запросе можно использовать фильтры.
Результаты возвращаются постранично.
⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе |
---|
Request
POST
https://api.partner.market.yandex.ru/businesses/{businessId}/price-quarantine
Path parameters
Name |
Type |
Description |
businessId* |
integer<int64> |
Идентификатор кабинета. Чтобы узнать идентификатор, воспользуйтесь запросом GET campaigns. |
Query parameters
Name |
Type |
Description |
page_token |
string |
Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра Если задан |
limit |
integer<int32> |
Количество товаров на одной странице.
|
Body
{
"offerIds": [
"string"
],
"cardStatuses": [
"HAS_CARD_CAN_NOT_UPDATE"
],
"categoryIds": [
0
],
"vendorNames": [
"string"
],
"tags": [
"string"
]
}
Name |
Type |
Description |
offerIds |
string[] |
Идентификаторы товаров, информация о которых нужна.
Разрешена любая последовательность длиной до 80 знаков. В нее могут входить английские и русские буквы, цифры и символы Правила использования SKU:
Что такое SKU и как его назначать
|
cardStatuses |
Фильтр по статусам карточек. Что такое карточка товара
Что обозначает каждый из статусов
|
|
categoryIds |
integer[] |
Фильтр по категориям на Маркете. |
vendorNames |
string[] |
Фильтр по брендам. |
tags |
string[] |
Фильтр по тегам. |
OfferCardStatusType
Статус карточки товара:
- HAS_CARD_CAN_NOT_UPDATE — Карточка Маркета.
- HAS_CARD_CAN_UPDATE — Можно дополнить.
- HAS_CARD_CAN_UPDATE_ERRORS — Изменения не приняты.
- HAS_CARD_CAN_UPDATE_PROCESSING — Изменения на проверке.
- NO_CARD_NEED_CONTENT — Создайте карточку.
- NO_CARD_MARKET_WILL_CREATE — Создаст Маркет.
- NO_CARD_ERRORS — Не создана из-за ошибки.
- NO_CARD_PROCESSING — Проверяем данные.
- NO_CARD_ADD_TO_CAMPAIGN — Разместите товар в магазине.
Что обозначает каждый из статусов
Type |
Description |
Enum: |
Responses
200 OK
Список товаров в карантине.
Body
{
"status": "OK",
"result": {
"paging": {
"nextPageToken": "string",
"prevPageToken": "string"
},
"offers": [
{
"offerId": "string",
"currentPrice": {
"value": 0,
"currencyId": "RUR"
},
"lastValidPrice": {
"value": 0,
"currencyId": "RUR"
},
"verdicts": [
{
"type": "PRICE_CHANGE",
"params": [
{
"name": "CURRENT_PRICE",
"value": "string"
}
]
}
]
}
]
}
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
result |
Список товаров в карантине. |
GetQuarantineOffersResultDTO
Список товаров в карантине.
Name |
Type |
Description |
paging |
Информация о страницах результатов. |
|
offers |
Страница списка товаров в карантине. |
ScrollingPagerDTO
Информация о страницах результатов.
Name |
Type |
Description |
nextPageToken |
string |
Идентификатор следующей страницы результатов. |
prevPageToken |
string |
Идентификатор предыдущей страницы результатов. |
QuarantineOfferDTO
Товар в карантине.
Name |
Type |
Description |
offerId |
string |
Ваш SKU — идентификатор товара в вашей системе. Разрешена любая последовательность длиной до 80 знаков. В нее могут входить английские и русские буквы, цифры и символы Правила использования SKU:
Что такое SKU и как его назначать
|
currentPrice |
Deprecated Поле больше не используется. Используйте значение из Новая цена. |
|
lastValidPrice |
Deprecated Поле больше не используется. Используйте значение из Последняя цена до попадания в карантин. |
|
verdicts |
Причины попадания товара в карантин. |
BasePriceDTO
Цена на товар.
Name |
Type |
Description |
value* |
number |
Значение. |
currencyId* |
Валюта. Если
|
PriceQuarantineVerdictDTO
Причина попадания товара в карантин.
Name |
Type |
Description |
type |
Тип карантина.
|
|
params |
Цена, из-за которой товар попал в карантин, и значения для сравнения. Конкретный набор параметров зависит от типа карантина. |
CurrencyType
Коды валют. Возможные значения:
BYR
— белорусский рубль.KZT
— казахстанский тенге.RUR
— российский рубль.UAH
— украинская гривна.
Type |
Description |
Enum: |
PriceQuarantineVerdictType
Типы карантина:
PRICE_CHANGE
— новая цена слишком сильно отличается от прежней. В полеparams
будет новая ценаCURRENT_PRICE
и последняя цена до попадания в карантинLAST_VALID_PRICE
.LOW_PRICE
— установленная цена слишком сильно отличается от рыночной. В полеparams
будет установленная вами ценаCURRENT_PRICE
и порог попадания в карантинMIN_PRICE
.LOW_PRICE_PROMO
— цена после применения акций слишком сильно отличается от рыночной. В полеparams
будет цена после применения акцийCURRENT_PRICE
и порог попадания в карантинMIN_PRICE
.
Type |
Description |
Enum: |
PriceQuarantineVerdictParameterDTO
Параметр карантина.
Name |
Type |
Description |
name* |
Название параметра.
|
|
value* |
string |
Значение параметра. |
PriceQuarantineVerdictParamNameType
Имя параметра причины скрытия товара по цене.
CURRENT_PRICE
— цена, из-за которой товар попал в карантин;LAST_VALID_PRICE
— последняя цена до попадания в карантин (только для карантина типаPRICE_CHANGE
);MIN_PRICE
— порог попадания в карантин (только для карантина типовLOW_PRICE
иLOW_PRICE_PROMO
);CURRENCY
— валюта.
Type |
Description |
Enum: |
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
Name |
Type |
Description |
code* |
string |
Код ошибки. |
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |