Request
Responses
200 OK
400 Bad Request
- Body
- ApiErrorDTO
401 Unauthorized
- Body
403 Forbidden
- Body
404 Not Found
- Body
420 Method Failure
- Body
500 Internal Server Error
- Body

Список товаров, находящихся в карантине (цена в магазине)

Info

Console

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

Проверьте цену каждого из товаров, попавших в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса POST campaigns/{campaignId}/price-quarantine/confirm. Если цена в самом деле ошибочная, установите верную с помощью запроса POST campaigns/{campaignId}/offer-prices/updates.

𝓠 Что такое карантин?

𝓐 Товар попадает в карантин, если его цена меняется слишком резко или слишком сильно отличается от рыночной. Подробнее

В запросе можно использовать фильтры.

Результаты возвращаются постранично.

⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе

Request

POST

https://api.partner.market.yandex.ru/campaigns/{campaignId}/price-quarantine

Path parameters

Name

Type

Description

campaignId*

integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Query parameters

Name

Type

Description

page_token

string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается самая старая страница.

Рекомендуется передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token, параметры offset, page_number и page_size игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

limit

integer<int32>

Количество товаров на одной странице.
Example: 20

Body

application/json

{
    "offerIds": [
        "string"
    ],
    "cardStatuses": [
        "HAS_CARD_CAN_NOT_UPDATE"
    ],
    "categoryIds": [
        0
    ],
    "vendorNames": [
        "string"
    ],
    "tags": [
        "string"
    ]
}

Name	Type	Description
offerIds	string[]	Идентификаторы товаров, информация о которых нужна. ⚠️ Не используйте это поле одновременно с фильтрами по статусам карточек, категориям, брендам или тегам. Если вы хотите воспользоваться фильтрами, оставьте поле пустым. Ваш SKU — идентификатор товара в вашей системе. Разрешена любая последовательность длиной до 80 знаков. В нее могут входить английские и русские буквы, цифры и символы `. , / \ ( ) [ ] - = _` Правила использования SKU: У каждого товара SKU должен быть свой. SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU. Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге. Что такое SKU и как его назначать.
cardStatuses	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 — Разместите товар в магазине. Что обозначает каждый из статусов Enum: `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`
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
OfferCardStatusType	Enum: `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`

{
    "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	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
result	GetQuarantineOffersResultDTO	Список товаров в карантине.

ApiResponseStatusType

Тип ответа.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

GetQuarantineOffersResultDTO

Список товаров в карантине.

Name	Type	Description
paging	ScrollingPagerDTO	Информация о страницах результатов. Ссылка на следующую страницу.
offers	QuarantineOfferDTO[]	Страница списка товаров в карантине. Товар в карантине.

ScrollingPagerDTO

Информация о страницах результатов.

Name	Type	Description
nextPageToken	string	Идентификатор следующей страницы результатов.
prevPageToken	string	Идентификатор предыдущей страницы результатов.

QuarantineOfferDTO

Товар в карантине.

Name	Type	Description
offerId	string	Ваш SKU — идентификатор товара в вашей системе. Разрешена любая последовательность длиной до 80 знаков. В нее могут входить английские и русские буквы, цифры и символы `. , / \ ( ) [ ] - = _` Правила использования SKU: У каждого товара SKU должен быть свой. SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU. Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге. Что такое SKU и как его назначать.
currentPrice	BasePriceDTO	Deprecated Поле больше не используется. Используйте значение из `verdicts` → `params`. Новая цена.
lastValidPrice	BasePriceDTO	Deprecated Поле больше не используется. Используйте значение из `verdicts` → `params`. Последняя цена до попадания в карантин.
verdicts	PriceQuarantineVerdictDTO[]	Причины попадания товара в карантин. Причина попадания товара в карантин.

BasePriceDTO

Цена на товар.

Name

Type

Description

value*

number

Значение.

currencyId*

string

Валюта.

Если BasePriceDTO присутствует в запросе, указывайте RUR — российский рубль.
Example: RUR

PriceQuarantineVerdictDTO

Причина попадания товара в карантин.

Name	Type	Description
type	PriceQuarantineVerdictType	Тип карантина. Enum: `PRICE_CHANGE`, `LOW_PRICE`, `LOW_PRICE_PROMO`
params	PriceQuarantineVerdictParameterDTO[]	Цена, из-за которой товар попал в карантин, и значения для сравнения. Конкретный набор параметров зависит от типа карантина. Параметр карантина.

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
PriceQuarantineVerdictType	Enum: `PRICE_CHANGE`, `LOW_PRICE`, `LOW_PRICE_PROMO`

PriceQuarantineVerdictParameterDTO

Параметр карантина.

Name	Type	Description
name*	PriceQuarantineVerdictParamNameType	Название параметра. Enum: `CURRENT_PRICE`, `LAST_VALID_PRICE`, `MIN_PRICE`, `CURRENCY`
value*	string	Значение параметра.

PriceQuarantineVerdictParamNameType

Имя параметра причины скрытия товара по цене.

CURRENT_PRICE — цена, из-за которой товар попал в карантин;
LAST_VALID_PRICE — последняя цена до попадания в карантин (только для карантина типа PRICE_CHANGE);
MIN_PRICE — порог попадания в карантин (только для карантина типов LOW_PRICE и LOW_PRICE_PROMO);
CURRENCY — валюта.

Type	Description
PriceQuarantineVerdictParamNameType	Enum: `CURRENT_PRICE`, `LAST_VALID_PRICE`, `MIN_PRICE`, `CURRENCY`

400 Bad Request

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

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

ApiErrorDTO

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

Name	Type	Description
code*	string	Код ошибки.
message	string	Описание ошибки.

401 Unauthorized

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

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

403 Forbidden

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

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

420 Method Failure

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

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

Список товаров, находящихся в карантине (цена в магазине)

RequestRequest

Path parametersPath parameters

Query parametersQuery parameters

BodyBody

OfferCardStatusTypeOfferCardStatusType

ResponsesResponses

200 OK200 OK

BodyBody

ApiResponseStatusTypeApiResponseStatusType

GetQuarantineOffersResultDTOGetQuarantineOffersResultDTO

ScrollingPagerDTOScrollingPagerDTO

QuarantineOfferDTOQuarantineOfferDTO

BasePriceDTOBasePriceDTO

PriceQuarantineVerdictDTOPriceQuarantineVerdictDTO

PriceQuarantineVerdictTypePriceQuarantineVerdictType

PriceQuarantineVerdictParameterDTOPriceQuarantineVerdictParameterDTO

PriceQuarantineVerdictParamNameTypePriceQuarantineVerdictParamNameType

400 Bad Request400 Bad Request

BodyBody

ApiErrorDTOApiErrorDTO

401 Unauthorized401 Unauthorized

BodyBody

403 Forbidden403 Forbidden

BodyBody

404 Not Found404 Not Found

BodyBody

420 Method Failure420 Method Failure

BodyBody

500 Internal Server Error500 Internal Server Error

BodyBody

Была ли статья полезна?

Request

Path parameters

Query parameters

Body

OfferCardStatusType

Responses

200 OK

Body

ApiResponseStatusType

GetQuarantineOffersResultDTO

ScrollingPagerDTO

QuarantineOfferDTO

BasePriceDTO

PriceQuarantineVerdictDTO

PriceQuarantineVerdictType

PriceQuarantineVerdictParameterDTO

PriceQuarantineVerdictParamNameType

400 Bad Request

Body

ApiErrorDTO

401 Unauthorized

Body

403 Forbidden

Body

404 Not Found

Body

420 Method Failure

Body

500 Internal Server Error

Body