Список товаров, находящихся в карантине по цене в кабинете

Info

Console

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

Проверьте цену каждого из товаров, который попал в карантин. Если ошибки нет и цена правильная, подтвердите ее с помощью запроса 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

Description

businessId*

Type: integer<int64>

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

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

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

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

page_token

Type: string

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

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

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

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

Body

application/json

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

Name	Description
cardStatuses	Type: 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` Min items: `1` Unique items: `true`
categoryIds	Type: integer[] Фильтр по категориям на Маркете. Min items: `1` Unique items: `true`
offerIds	Type: string[] Идентификаторы товаров, информация о которых нужна. ⚠️ Не используйте это поле одновременно с фильтрами по статусам карточек, категориям, брендам или тегам. Если вы хотите воспользоваться фильтрами, оставьте поле пустым. Ваш SKU — идентификатор товара в вашей системе. Правила использования SKU: У каждого товара SKU должен быть свой. SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU. Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге. Что такое SKU и как его назначать Min length: `1` Max length: `255` Pattern: `^(?=.\S.)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$` Max items: `500` Min items: `1` Unique items: `true`
tags	Type: string[] Фильтр по тегам. Min items: `1` Unique items: `true`
vendorNames	Type: string[] Фильтр по брендам. Min items: `1` Unique items: `true`

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`

Responses

200 OK

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

Body

application/json

{
    "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

Description

result

Type: GetQuarantineOffersResultDTO

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

GetQuarantineOffersResultDTO

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

Name

Description

offers*

Type: QuarantineOfferDTO[]

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

paging

Type: ScrollingPagerDTO

Информация о страницах результатов.
Ссылка на следующую страницу.

ApiResponseStatusType

Тип ответа.

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

QuarantineOfferDTO

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

Name

Description

currentPrice

⦸

Type: BasePriceDTO

Этот параметр устарел. Вместо него используйте значение из verdicts → params

Новая цена.

lastValidPrice

⦸

Type: BasePriceDTO

Этот параметр устарел. Вместо него используйте значение из verdicts → params

Последняя цена до попадания в карантин.

offerId

Type: string

Ваш SKU — идентификатор товара в вашей системе.

Правила использования SKU:

У каждого товара SKU должен быть свой.
SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.
Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

Что такое SKU и как его назначать

Min length: 1

Max length: 255

Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

verdicts

Type: PriceQuarantineVerdictDTO[]

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

ScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

Идентификатор следующей страницы результатов.

prevPageToken

Type: string

Идентификатор предыдущей страницы результатов.

BasePriceDTO

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

Name

Description

currencyId*

Type: CurrencyType

Валюта.

При передаче валюты указывайте RUR(российский рубль), если в запросе есть BasePriceDTO, UpdatePriceWithDiscountDTO или GetPriceWithDiscountDTO.

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

value*

Type: number

Значение.

Min value (exclusive): 0

PriceQuarantineVerdictDTO

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

Name

Description

params*

Type: PriceQuarantineVerdictParameterDTO[]

Цена, из-за которой товар попал в карантин, и значения для сравнения. Конкретный набор параметров зависит от типа карантина.
Параметр карантина.

type

Type: PriceQuarantineVerdictType

Тип карантина.

Enum: PRICE_CHANGE, LOW_PRICE, LOW_PRICE_PROMO

CurrencyType

Коды валют. Возможные значения:

BYR — белорусский рубль.
KZT — казахстанский тенге.
RUR — российский рубль.
UAH — украинская гривна.

Type

Description

CurrencyType

PriceQuarantineVerdictParameterDTO

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

Name

Description

name*

Type: PriceQuarantineVerdictParamNameType

Название параметра.

Enum: CURRENT_PRICE, LAST_VALID_PRICE, MIN_PRICE, CURRENCY

value*

Type: string

Значение параметра.

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`

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

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

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

Рекомендации Маркета

Просмотр карантина по цене в магазине