List of quarantined products by price in the cabinet

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 for all stores in the cabinet.

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 v2/businesses/{businessId}/price-quarantine/confirm. If the price is really wrong, set the correct price using a query. POST v2/businesses/{businessId}/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 products per minute, no more than 500 products per request

Request

POST

https://api.partner.market.yandex.ru/v2/businesses/{businessId}/price-quarantine

Path parameters

Name

Description

businessId

Type: integer

Cabinet ID. To find out, use the request GET v2/campaigns.

ℹ️ What is a cabinet and a store on the Market?

Min value: 1

Query parameters

Name

Description

limit

Type: integer

The number of values per page.

Min value: 1

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": [
    "example"
  ],
  "cardStatuses": [
    "HAS_CARD_CAN_NOT_UPDATE"
  ],
  "categoryIds": [
    0
  ],
  "vendorNames": [
    "example"
  ],
  "tags": [
    "example"
  ]
}

Name

Description

cardStatuses

Type: string[] | null

Filter by card status.

What is a product card?

Min items: 1

Unique items: true

Example
[
  "HAS_CARD_CAN_NOT_UPDATE"
]

categoryIds

Type: integer[] | null

Filter by category on the Market.

Min items: 1

Unique items: true

Example
[
  0
]

offerIds

Type: string[] | null

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.

Min items: 1

Max items: 500

Unique items: true

Example
[
  "example"
]

tags

Type: string[] | null

Filter by tags.

Min items: 1

Unique items: true

Example
[
  "example"
]

vendorNames

Type: string[] | null

Filter by brand.

Min items: 1

Unique items: true

Example
[
  "example"
]

Responses

200 OK

The list of products in quarantine.

Body

application/json
{
  "status": "OK",
  "result": {
    "paging": {
      "nextPageToken": "example",
      "prevPageToken": "example"
    },
    "offers": [
      {
        "offerId": "example",
        "currentPrice": {},
        "lastValidPrice": {},
        "verdicts": [
          null
        ]
      }
    ]
  }
}

Type: object

All of 2 types
  • Type: object

    status

    Type: string

    The type of response. Possible values:

    • OK — There are no errors.
    • ERROR — an error occurred while processing the request.

    Enum: OK, ERROR

    The standard wrapper for server responses.

    Example
    {
  "status": "OK"
}
  • Type: object

    result
    Type: object

    offers
    Type: object[]

    currentPrice
    Type: object

    currencyId

    Type: string

    Currency codes:

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

    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: 0

    Exclusive min: true

    The price of the product.

    Example
    {
  "value": 0,
  "currencyId": "RUR"
}

    lastValidPrice
    Type: object

    currencyId

    Type: string

    Currency codes:

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

    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: 0

    Exclusive min: true

    The price of the product.

    Example
    {
  "value": 0,
  "currencyId": "RUR"
}

    offerId

    Type: string

    Your SKU — the product ID in your system.

    Usage rules SKU:

    • For each product SKU there must be one.

    • Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.

    SKU 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.

    Warning

    Spaces at the beginning and end of the value are automatically deleted. For example, " SKU123 " and "SKU123" they will be treated as identical values.

    What is SKU and how to assign it

    Min length: 1

    Max length: 255

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

    Example: example

    verdicts
    Type: object[]

    params
    Type: object[]

    name

    Type: string

    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.

    Enum: CURRENT_PRICE, LAST_VALID_PRICE, MIN_PRICE, CURRENCY

    value

    Type: string

    The value of the parameter.

    Example: example

    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.

    Example
    [
  {
    "name": "CURRENT_PRICE",
    "value": "example"
  }
]

    type

    Type: string

    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.

    Enum: PRICE_CHANGE, LOW_PRICE, LOW_PRICE_PROMO

    The reasons for the product being quarantined.

    Min items: 1

    Example
    [
  {
    "type": "PRICE_CHANGE",
    "params": [
      {
        "name": "CURRENT_PRICE",
        "value": "example"
      }
    ]
  }
]

    The page of the list of products in quarantine.

    Example
    [
  {
    "offerId": "example",
    "currentPrice": {
      "value": 0,
      "currencyId": "RUR"
    },
    "lastValidPrice": {
      "value": 0,
      "currencyId": "RUR"
    },
    "verdicts": [
      {
        "type": "PRICE_CHANGE",
        "params": [
          {}
        ]
      }
    ]
  }
]

    paging

    Type: object

    All of 2 types

    • Type: object

      nextPageToken

      Type: string

      ID of the next results page.

      Example: example

      The ID of the next page.

      Example
      {
  "nextPageToken": "example"
}

    • Type: object

      prevPageToken

      Type: string

      ID of the previous results page.

      Example: example
      Example
      {
  "prevPageToken": "example"
}

    Information about the result pages.

    Example
    {
  "nextPageToken": "example",
  "prevPageToken": "example"
}

    The list of products in quarantine.

    Example
    {
  "paging": {
    "nextPageToken": "example",
    "prevPageToken": "example"
  },
  "offers": [
    {
      "offerId": "example",
      "currentPrice": {
        "value": 0,
        "currencyId": "RUR"
      },
      "lastValidPrice": {
        "value": 0,
        "currencyId": "RUR"
      },
      "verdicts": [
        {
          "type": "PRICE_CHANGE",
          "params": [
            null
          ]
        }
      ]
    }
  ]
}
    Example
    {
  "result": {
    "paging": {
      "nextPageToken": "example",
      "prevPageToken": "example"
    },
    "offers": [
      {
        "offerId": "example",
        "currentPrice": {
          "value": 0,
          "currencyId": "RUR"
        },
        "lastValidPrice": {
          "value": 0,
          "currencyId": "RUR"
        },
        "verdicts": [
          {}
        ]
      }
    ]
  }
}

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

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

401 Unauthorized

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

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

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": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

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

404 Not Found

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

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

420 Method Failure

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

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

500 Internal Server Error

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

  • Type: object

    All of 2 types

    • Type: object

      status

      Type: string

      The type of response. Possible values:

      • OK — There are no errors.
      • ERROR — an error occurred while processing the request.

      Enum: OK, ERROR

      The standard wrapper for server responses.

      Example
      {
  "status": "OK"
}

    • Type: object

      errors
      Type: object[]

      code

      Type: string

      The error code.

      Example: example

      message

      Type: string

      Description of the error.

      Example: example

      A list of errors.

      Min items: 1

      Example
      [
  {
    "code": "example",
    "message": "example"
  }
]
      Example
      {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

    A standard wrapper for server errors.

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

No longer supported, please use an alternative and newer version.

Previous
Yandex.Market Recommendations
Next
Viewing quarantine by price in the store