Editing product category characteristics
The method is available for models: FBY, FBS, Express and DBS.
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
- all-methods — Full account management
Edits product characteristics that are specific to the category it belongs to.
Here is only what belongs to a specific category.
If you need to change the main parameters of the product (name, description, images, video, manufacturer, barcode), use the request POST v2/businesses/{businessId}/offer-mappings/update.
To remove the characteristics that are set in the parameters with the type string, pass an empty value.
The data in the catalog is not updated instantly
It takes up to a few minutes.
| ⚙️ Limit: 10,000 items per minute |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/businesses/{businessId}/offer-cards/update
Path parameters
|
Name |
Description |
|
businessId* |
Type: integer<int64> Cabinet ID. To find out, use the request GET v2/campaigns. ℹ️ What is a cabinet and a store on the Market?
Min value: |
Body
application/json
{
"offersContent": [
{
"offerId": "string",
"categoryId": 0,
"parameterValues": [
{
"parameterId": 0,
"unitId": 0,
"valueId": 0,
"value": "string"
}
]
}
]
}
|
Name |
Description |
|
offersContent* |
Type: object[] A list of products with the specified characteristics. Min items: Max items: |
Responses
200 OK
The request was executed correctly, and the data has been processed.
Answer 200 by itself, it does not mean that the values passed are correct.
Be sure to look at the details of the response.: status, as well as a list of errors (results.errors) and comments (results.warnings), if there are any.
- If an error is returned for at least one product (
results.errors), fieldstatus=ERROR. Changes to all transferred items will not be applied. - If there are no errors, but at least one product has a comment returned (
results.warnings), fieldstatus=OK, and the changes will be applied.
If in status It's back ERROR, make sure that:
- All required specifications are filled in.
- the characteristics actually exist in the specified categories;
- the values correspond to the characteristics;
- your own values have the desired data type.
Fields will help you find problems. errors and warnings.
Body
application/json
{
"status": "OK",
"results": [
{
"offerId": "string",
"errors": [
{
"type": "OFFER_NOT_FOUND",
"parameterId": 0,
"message": "string"
}
],
"warnings": [
{
"type": "OFFER_NOT_FOUND",
"parameterId": 0,
"message": "string"
}
]
}
]
}
|
Name |
Description |
|
status* |
Type: string The type of response. Possible values:
Enum: |
|
results |
Type: object[] Errors and warnings that appeared when processing the transmitted values. Each item in the list corresponds to one product. If there are no errors or warnings, the field is not passed.
Min items: |
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: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
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: object[] A list of errors. Min items: |
|
status |
Type: string 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: object[] A list of errors. Min items: |
|
status |
Type: string 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: object[] A list of errors. Min items: |
|
status |
Type: string 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: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
423 Locked
The specified method cannot be applied to the resource. More information about the error
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: object[] A list of errors. Min items: |
|
status |
Type: string 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: object[] A list of errors. Min items: |
|
status |
Type: string The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.
ASCII characters 0 through 31 (except 9) and 127 are prohibited. from the table.