Lists of product characteristics by category

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

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 a list of characteristics with acceptable values for the specified leaf category, which has no child categories.

, Limit: 100 categories per minute

Request

POST

https://api.partner.market.yandex.ru/category/{categoryId}/parameters

Path parameters

Name

Description

categoryId*

Type: integer<int64>

The ID of the category on the Market.

To find out the ID of the category to which the product you are interested in belongs, use the request POST categories/tree.

Min value: 1

Query parameters

Name

Description

businessId

Type: integer<int64>

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

Pass the parameter to get the characteristics that are the features of the product variant in this cabinet.

Min value: 1

Responses

200 OK

A list of product characteristics from the specified category.

Body

application/json

{
    "status": "OK",
    "result": {
        "categoryId": 0,
        "parameters": [
            {
                "id": 0,
                "name": "string",
                "type": "TEXT",
                "unit": {
                    "defaultUnitId": 0,
                    "units": [
                        {
                            "id": 0,
                            "name": "кг",
                            "fullName": "килограмм"
                        }
                    ]
                },
                "description": "string",
                "recommendationTypes": [
                    "HAS_VIDEO"
                ],
                "required": false,
                "filtering": false,
                "distinctive": false,
                "multivalue": false,
                "allowCustomValues": false,
                "values": [
                    {
                        "id": 0,
                        "value": "string",
                        "description": "string"
                    }
                ],
                "constraints": {
                    "minValue": 0,
                    "maxValue": 0,
                    "maxLength": 0
                },
                "valueRestrictions": [
                    {
                        "limitingParameterId": 0,
                        "limitedValues": [
                            {
                                "limitingOptionValueId": 0,
                                "optionValueIds": [
                                    0
                                ]
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

Name

Description

result

Type: CategoryContentParametersDTO

Information about the category parameters.

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

CategoryContentParametersDTO

Information about the category parameters.

Name

Description

categoryId*

Type: integer<int32>

The ID of the category on the Market.

When changing the category, make sure that the product characteristics and their values in the parameter parameterValues you are submitting for a new category.

You can get a list of Market categories using a request. POST categories/tree.

Min value: 1

parameters

Type: CategoryParameterDTO[]

A list of characteristics.
Product characteristics.

Min items: 1

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`

CategoryParameterDTO

Product characteristics.

Name	Description
allowCustomValues*	Type: boolean Is it possible to pass a custom value that is not in the list of Market options? Only for type characteristics `ENUM`.
distinctive*	Type: boolean Whether the characteristic is a feature of the variant.
filtering*	Type: boolean Whether the characteristic is used in the filter.
id*	Type: integer<int64> The identifier of the characteristic. Min value: `1`
multivalue*	Type: boolean Is it possible to pass multiple values at once?
required*	Type: boolean Mandatory characteristics.
type*	Type: ParameterType The type of data. Enum: `TEXT`, `ENUM`, `BOOLEAN`, `NUMERIC`
constraints	Type: ParameterValueConstraintsDTO Restrictions on values. Only for type characteristics `TEXT` and `NUMERIC`.
description	Type: string Description of the characteristic.
name	Type: string The name of the characteristic.
recommendationTypes	Type: OfferCardRecommendationType[] A list of possible recommendations for filling out the card, to which this characteristic applies. A recommendation for adding or replacing content. It is not refunded for cards that are filled with the Market or contain used goods. Some of the recommendations relate to the main parameters, which are available for products of any category. Others belong to those characteristics which the product has because it belongs to a certain category. 1. Recommendations related to the main parameters Each such recommendation applies to the only parameter. To fill in this parameter, use the request POST businesses/{businessId}/offer-mappings/update. Recommendations for filling in the parameters in `updateOfferMappings`: `RECOGNIZED_VENDOR` — write the manufacturer's name as the manufacturer himself writes it (parameter `vendor`). `PICTURE_COUNT` — add images (parameter `pictures`). Requirements The percentage of its completion is sent for the recommendation. `FIRST_PICTURE_SIZE`— replace the first image with a larger one (parameter `pictures`). Requirements `TITLE_LENGTH` — change the name (parameter `name`). Make a name according to the scheme: type + brand or manufacturer + model + features, if any (size, weight, color). Requirements `DESCRIPTION_LENGTH` — add a description of the recommended size (parameter `description`). Requirements `AVERAGE_PICTURE_SIZE` — replace all images with high-quality images (parameter `pictures`). Requirements `FIRST_VIDEO_LENGTH` — add the first video of the recommended length (parameter `videos`). Requirements `FIRST_VIDEO_SIZE` — replace the first video with a high-quality video (parameter `videos`). Requirements `AVERAGE_VIDEO_SIZE` — replace all videos with high-quality videos (parameter `videos`). Requirements `VIDEO_COUNT` — add at least one video (parameter `videos`). Requirements The percentage of its completion is sent for the recommendation. 2. Recommendations related to characteristics by category Each such recommendation involves filling out one or more characteristics. To find out exactly which characteristics you need to fill out, use the request POST category/{categoryId}/parameters. For example, if you have received a recommendation `MAIN`, you need to fill in the characteristics that have `MAIN` in the array `recommendationTypes`. Recommendations: `MAIN` — fill in the key product characteristics that are used in the search and filters. The percentage of its completion is sent for the recommendation. `ADDITIONAL` — fill in additional product specifications. The percentage of its completion is sent for the recommendation. `DISTINCTIVE` — fill in the characteristics that distinguish the product options from each other. The percentage of its completion is sent for the recommendation. 3. Outdated recommendations `HAS_VIDEO`. `FILTERABLE`. `HAS_DESCRIPTION`. `HAS_BARCODE`. Enum: `HAS_VIDEO`, `RECOGNIZED_VENDOR`, `MAIN`, `ADDITIONAL`, `DISTINCTIVE`, `FILTERABLE`, `PICTURE_COUNT`, `HAS_DESCRIPTION`, `HAS_BARCODE`, `FIRST_PICTURE_SIZE`, `TITLE_LENGTH`, `DESCRIPTION_LENGTH`, `AVERAGE_PICTURE_SIZE`, `FIRST_VIDEO_SIZE`, `FIRST_VIDEO_LENGTH`, `AVERAGE_VIDEO_SIZE`, `VIDEO_COUNT` Min items: `1` Unique items
unit	Type: CategoryParameterUnitDTO Units of measurement of product characteristics.
valueRestrictions	Type: ValueRestrictionDTO[] Restrictions on values imposed by other characteristics. Only for type characteristics `ENUM`. A restriction on possible values imposed by another characteristic. If the limiting characteristic takes on a certain value, the list of possible values of the limited characteristic is reduced. Example Characteristic size It can take nine different values by itself.: `S`, `M`, `L`, `44`, `46`, `48`, `42/164`, `46/176`, `44S`. If the limiting characteristic is The size grid takes the value `RU`, the list of possible size values is reduced to `44`, `46`, `48`. Min items: `1`
values	Type: ParameterValueOptionDTO[] A list of acceptable parameter values. Only for type characteristics `ENUM`. The value of the characteristic. Min items: `1`

ParameterType

Data type:

TEXT — the text.
ENUM — a list of possible values.
BOOLEAN — true or false.
NUMERIC — the number.

Type	Description
ParameterType	Enum: `TEXT`, `ENUM`, `BOOLEAN`, `NUMERIC`

ParameterValueConstraintsDTO

Restrictions on the values of characteristics.

Name	Description
maxLength	Type: integer<int32> The maximum length of the text.
maxValue	Type: number<double> The maximum number.
minValue	Type: number<double> The minimum number.

OfferCardRecommendationType

A recommendation for adding or replacing content. It is not refunded for cards that are filled with the Market or contain used goods.

Some of the recommendations relate to the main parameters, which are available for products of any category. Others belong to those characteristics which the product has because it belongs to a certain category.

1. Recommendations related to the main parameters

Each such recommendation applies to the only parameter. To fill in this parameter, use the request POST businesses/{businessId}/offer-mappings/update.

Recommendations for filling in the parameters in updateOfferMappings:

RECOGNIZED_VENDOR — write the manufacturer's name as the manufacturer himself writes it (parameter vendor).
PICTURE_COUNT — add images (parameter pictures). Requirements

The percentage of its completion is sent for the recommendation.
FIRST_PICTURE_SIZE— replace the first image with a larger one (parameter pictures). Requirements
TITLE_LENGTH — change the name (parameter name). Make a name according to the scheme: type + brand or manufacturer + model + features, if any (size, weight, color). Requirements
DESCRIPTION_LENGTH — add a description of the recommended size (parameter description). Requirements
AVERAGE_PICTURE_SIZE — replace all images with high-quality images (parameter pictures). Requirements
FIRST_VIDEO_LENGTH — add the first video of the recommended length (parameter videos). Requirements
FIRST_VIDEO_SIZE — replace the first video with a high-quality video (parameter videos). Requirements
AVERAGE_VIDEO_SIZE — replace all videos with high-quality videos (parameter videos). Requirements
VIDEO_COUNT — add at least one video (parameter videos). Requirements

The percentage of its completion is sent for the recommendation.

2. Recommendations related to characteristics by category

Each such recommendation involves filling out one or more characteristics. To find out exactly which characteristics you need to fill out, use the request POST category/{categoryId}/parameters. For example, if you received a recommendation MAIN, you need to fill in the characteristics that have MAIN in the array recommendationTypes.

Recommendations:

MAIN — fill in the key product characteristics that are used in the search and filters.

The percentage of its completion is sent for the recommendation.
ADDITIONAL — fill in additional product specifications.

The percentage of its completion is sent for the recommendation.
DISTINCTIVE — fill in the characteristics that distinguish the product options from each other.

The percentage of its completion is sent for the recommendation.

3. Outdated recommendations

HAS_VIDEO.
FILTERABLE.
HAS_DESCRIPTION.
HAS_BARCODE.

Type	Description
OfferCardRecommendationType	Enum: `HAS_VIDEO`, `RECOGNIZED_VENDOR`, `MAIN`, `ADDITIONAL`, `DISTINCTIVE`, `FILTERABLE`, `PICTURE_COUNT`, `HAS_DESCRIPTION`, `HAS_BARCODE`, `FIRST_PICTURE_SIZE`, `TITLE_LENGTH`, `DESCRIPTION_LENGTH`, `AVERAGE_PICTURE_SIZE`, `FIRST_VIDEO_SIZE`, `FIRST_VIDEO_LENGTH`, `AVERAGE_VIDEO_SIZE`, `VIDEO_COUNT`

CategoryParameterUnitDTO

Units of measurement of product characteristics.

Name

Description

defaultUnitId*

Type: integer<int64>

The default unit of measurement.

units*

Type: UnitDTO[]

Acceptable units of measurement.
Unit of measurement.

ValueRestrictionDTO

A restriction on possible values imposed by another characteristic.

If the limiting characteristic takes on a certain value, the list of possible values of the limited characteristic is reduced.

Example

Characteristic size It can take nine different values by itself.: S, M, L, 44, 46, 48, 42/164, 46/176, 44S.

If the limiting characteristic is The size grid takes the value RU, the list of possible size values is reduced to 44, 46, 48.

Name

Description

limitedValues*

Type: OptionValuesLimitedDTO[]

The values of the limiting characteristic and the corresponding allowable values of the current characteristic.
The value of the limiting characteristic and the list of acceptable values of the limited characteristic.

limitingParameterId*

Type: integer<int64>

ID of the limiting characteristic.

Min value: 1

ParameterValueOptionDTO

The value of the characteristic.

Name	Description
id*	Type: integer<int64> ID of the value.
value*	Type: string Meaning.
description	Type: string Description of the value.

UnitDTO

Unit of measurement.

Name	Description
fullName*	Type: string The full name of the unit of measurement. Example: `kilogram`
id*	Type: integer<int64> ID of the unit of measurement.
name*	Type: string The abbreviated name of the unit of measurement. Example: `kg`

OptionValuesLimitedDTO

The value of the limiting characteristic and the list of acceptable values of the limited characteristic.

Name

Description

limitingOptionValueId*

Type: integer<int64>

ID of the value of the limiting characteristic.

optionValueIds*

Type: integer<int64>[]

Ids of acceptable values of the restricted characteristic.

Min value: 1

Unique 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: 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?

The category tree

Adding products and changing information