Lists of product characteristics by category

Info

Console

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

⚙️ Limit: 100 categories per minute

Request

POST

https://api.partner.market.yandex.ru/v2/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 v2/categories/tree.

Min value (exclusive): 0

Query parameters

Name

Description

businessId

Type: integer<int64>

Cabinet ID. To find out, use the request GET v2/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

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

result

Type: object

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 v2/categories/tree.

Min value (exclusive): 0

parameters

Type: object[]

A list of characteristics.
Product characteristics.

Min items: 1

Information about the category parameters.

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.
The general error format.

Min items: 1

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

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.
The general error format.

Min items: 1

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

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.
The general error format.

Min items: 1

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

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.
The general error format.

Min items: 1

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

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.
The general error format.

Min items: 1

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

500 Internal Server Error

Internal error in Yandex. 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.
The general error format.

Min items: 1

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

Was the article helpful?

The category tree

Adding products and changing information