List of quarantined products by price in the store

Info

Console

The method is available for all models.

If you are using an API Key token, one of the accesses in the list is required to call the method

pricing — Manage prices
pricing:read-only — View prices
all-methods — Full account management
all-methods:read-only — View all data

Returns a list of products that are in quarantine at the price set in the specified store.

Check the price of each of the quarantined items. If there is no error and the price is correct, confirm it with a request. POST campaigns/{campaignId}/price-quarantine/confirm. If the price is really wrong, set the correct price using a query. POST campaigns/{campaignId}/offer-prices/updates.

What is quarantine?

A product is quarantined if its price changes too sharply or differs too much from the market price. More detailed

Filters can be used in the request.

The results are returned page by page.

, Limit: 10,000 items per minute

Request

POST

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

The campaign ID.

You can find it using a query GET campaigns or find it in the seller's office on the Market — click on the name of your business and go to the page:

Modules and APIs → block Sending data to Yandex.Market.
Query log → drop-down list in the block Show logs.

, Do not send the store's ID instead, which is indicated in the seller's account on the Market next to the store's name and in some reports.

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

The number of values per page.

Min value: 1
Example: 20

page_token

Type: string

ID of the results page.

If the parameter is omitted, the first page is returned.

We recommend transmitting the value of the output parameter nextPageToken, received during the last request.

If set page_token and the request has parameters page and pageSize they are ignored.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json

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

Name	Description
cardStatuses	Type: OfferCardStatusType[] Filter by card status. What is a product card? Product card status: `HAS_CARD_CAN_NOT_UPDATE` — The Market card. `HAS_CARD_CAN_UPDATE` — It can be supplemented. `HAS_CARD_CAN_UPDATE_ERRORS` — The changes have not been accepted. `HAS_CARD_CAN_UPDATE_PROCESSING` — Changes are under review. `NO_CARD_NEED_CONTENT` — Create a card. `NO_CARD_MARKET_WILL_CREATE` — Creates a Marketplace. `NO_CARD_ERRORS` — It wasn't created because of a mistake. `NO_CARD_PROCESSING` — We check the data. `NO_CARD_ADD_TO_CAMPAIGN` — Place the product in the store. 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
categoryIds	Type: integer[] Filter by category on the Market. Min items: `1` Unique items
offerIds	Type: string[] The IDs of the products that information is needed about. Do not use this field at the same time as filters based on card statuses, categories, brands, or tags. If you want to use filters, leave the field empty. Your SKU is the product identifier in your system. SKU Usage Rules: Each product must have its own SKU. An already set SKU cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before. The SKU of the product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers. What is a SKU and how to assign it Min length: `1` Max length: `255` Pattern: `^(?=.\S.)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$` Min items: `1` Max items: `500` Unique items
tags	Type: string[] Filter by tags. Min items: `1` Unique items
vendorNames	Type: string[] Filter by brand. Min items: `1` Unique items

OfferCardStatusType

Product card status:

HAS_CARD_CAN_NOT_UPDATE — The Market card.
HAS_CARD_CAN_UPDATE — It can be supplemented.
HAS_CARD_CAN_UPDATE_ERRORS — The changes have not been accepted.
HAS_CARD_CAN_UPDATE_PROCESSING — Changes are under review.
NO_CARD_NEED_CONTENT — Create a card.
NO_CARD_MARKET_WILL_CREATE — Creates a Marketplace.
NO_CARD_ERRORS — It wasn't created because of a mistake.
NO_CARD_PROCESSING — We check the data.
NO_CARD_ADD_TO_CAMPAIGN — Place the product in the store.

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

The list of products in quarantine.

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

The list of products in quarantine.

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

GetQuarantineOffersResultDTO

The list of products in quarantine.

Name

Description

offers*

Type: QuarantineOfferDTO[]

The page of the list of products in quarantine.
The product is in quarantine.

paging

Type: ScrollingPagerDTO

Information about the result pages.
The ID of the next page.

ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

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

QuarantineOfferDTO

The product is in quarantine.

Name

Description

currentPrice

⦸

Type: BasePriceDTO

The price of the product.

lastValidPrice

⦸

Type: BasePriceDTO

The price of the product.

offerId

Type: string

Your SKU is the product identifier in your system.

SKU Usage Rules:

Each product must have its own SKU.
An already set SKU cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.

The SKU of the product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.

What is a SKU and how to assign it

Min length: 1

Max length: 255

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

verdicts

Type: PriceQuarantineVerdictDTO[]

The reasons for the product being quarantined.
The reason for the product being quarantined.

Min items: 1

ScrollingPagerDTO

Information about the result pages.

Name

Description

nextPageToken

Type: string

ID of the next results page.

prevPageToken

Type: string

ID of the previous results page.

BasePriceDTO

The price of the product.

Name

Description

currencyId*

Type: CurrencyType

Currency.

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

The price of the product.

Min value (exclusive): 0

PriceQuarantineVerdictDTO

The reason for the product being quarantined.

Name

Description

params*

Type: PriceQuarantineVerdictParameterDTO[]

The price that caused the product to be quarantined, and the values for comparison. The specific set of parameters depends on the type of quarantine.
The quarantine parameter.

type

Type: PriceQuarantineVerdictType

The type of quarantine.

Enum: PRICE_CHANGE, LOW_PRICE, LOW_PRICE_PROMO

CurrencyType

Currency codes:

RUR — the Russian ruble.
UAH — the Ukrainian hryvnia.
BYR — Belarusian ruble.
KZT — Kazakhstani tenge.
UZS — Uzbek sum.

Type

Description

CurrencyType

PriceQuarantineVerdictParameterDTO

The quarantine parameter.

Name

Description

name*

Type: PriceQuarantineVerdictParamNameType

The name of the parameter.

Enum: CURRENT_PRICE, LAST_VALID_PRICE, MIN_PRICE, CURRENCY

value*

Type: string

The value of the parameter.

PriceQuarantineVerdictType

Types of quarantine:

PRICE_CHANGE — the new price differs too much from the previous one. In the field params There will be a new price CURRENT_PRICE and the last price before being quarantined LAST_VALID_PRICE.
LOW_PRICE — the set price differs too much from the market price. In the field params the price will be set by you CURRENT_PRICE and the quarantine threshold MIN_PRICE.
LOW_PRICE_PROMO — the price after applying the shares differs too much from the market price. In the field params there will be a price after applying the shares CURRENT_PRICE and the quarantine threshold MIN_PRICE.

Type	Description
PriceQuarantineVerdictType	Enum: `PRICE_CHANGE`, `LOW_PRICE`, `LOW_PRICE_PROMO`

PriceQuarantineVerdictParamNameType

The name of the parameter for the reason for hiding the product by price.

CURRENT_PRICE — the price that caused the product to be quarantined.
LAST_VALID_PRICE — the last price before entering quarantine (only for quarantine type PRICE_CHANGE).
MIN_PRICE — quarantine threshold (only for quarantine types LOW_PRICE and LOW_PRICE_PROMO).
CURRENCY — currency.

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

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ApiErrorDTO

The general error format.

Name

Description

code*

Type: string

The error code.

message

Type: string

Description of the error.

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

404 Not Found

The requested resource was not found. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

Viewing quarantine at the price in the cabinet

Removal from quarantine at the price in the cabinet