The limit for setting the sales quantum and the minimum number of items in an order
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
- offers-and-cards-management — Manage products and cards
- offers-and-cards-management:read-only — View products and cards
- all-methods — Full account management
- all-methods:read-only — View all data
Returns the installation limit The quantum and the minimum number of products in the order that you can specify for the products of the specified categories.
If you pass the value of the quantum or the minimum quantity of goods above the limit set by the Market, the goods will be hidden from the showcase.
For more information on how to sell products in several pieces, read in the Help of the Market for sellers.
| , Limit: 5,000 requests per hour |
|---|
Request
POST
https://api.partner.market.yandex.ru/categories/max-sale-quantum
Body
application/json
{
"marketCategoryIds": [
0
]
}
|
Name |
Description |
|
marketCategoryIds* |
Type: integer<int64>[] The IDs of the leaf categories on the Market are those that do not have child categories. Min items: Max items: Unique items |
Responses
200 OK
The limit for setting the quantum and minimum quantity of goods.
Body
application/json
{
"status": "OK",
"results": [
{
"id": 0,
"name": "string",
"maxSaleQuantum": 0
}
],
"errors": [
{
"categoryId": 0,
"type": "UNKNOWN_CATEGORY"
}
]
}
|
Name |
Description |
|
results* |
Type: MaxSaleQuantumDTO[] Categories and the limit for setting the quantity and minimum quantity of goods. |
|
errors |
Type: CategoryErrorDTO[] Errors that appeared due to the passed categories. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
MaxSaleQuantumDTO
The limit for setting the quantum and the minimum number of products by category.
|
Name |
Description |
|
id* |
Type: integer<int64> The category ID. |
|
maxSaleQuantum |
Type: integer The limit for setting the quantum and minimum quantity of goods. |
|
name |
Type: string The name of the category. |
CategoryErrorDTO
The error text.
|
Name |
Description |
|
categoryId |
Type: integer<int64> The category ID. |
|
type |
Type: CategoryErrorType Types of errors:
Enum: |
ApiResponseStatusType
The type of response. Possible values:
OK— there are no mistakes.ERROR— an error occurred while processing the request.
|
Type |
Description |
|
Enum: |
CategoryErrorType
Types of errors:
UNKNOWN_CATEGORY— an unknown category is specified.CATEGORY_IS_NOT_LEAF— a non-leaf category is specified. Specify the one that has no child categories.
|
Type |
Description |
|
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
500 Internal Server Error
Internal error of the 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. Min items: |
|
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.
If a sales quantum is set, the buyer will be able to add only a multiple of the number of products to the order.
For example, if the sales quantum is 5, the buyer will be able to add 5, 10, 15, etc. items to the basket, but 1, 2, or 7 will not be able to.