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.

The fields in the response define the rules for transmitting characteristics in methods:

⚙️ Limit: 100 categories per minute

Request

POST

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

Path parameters

Name

Description

categoryId

Type: integer

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

Exclusive min: true

Query parameters

Name

Description

businessId

Type: integer

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": 1,
        "name": "example",
        "type": "TEXT",
        "unit": {},
        "description": "example",
        "recommendationTypes": [
          null
        ],
        "required": true,
        "filtering": true,
        "distinctive": true,
        "multivalue": true,
        "allowCustomValues": true,
        "values": [
          null
        ],
        "constraints": {},
        "valueRestrictions": [
          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

categoryId

Type: integer

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

Exclusive min: true

parameters

Type: object[]

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.

Type: integer

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

Data type:

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

Enum: TEXT, ENUM, BOOLEAN, NUMERIC

constraints

Type: object

maxLength

Type: integer

The maximum length of the text.

maxValue

Type: number

The maximum number.

minValue

Type: number

The minimum number.

Restrictions on the values of characteristics.

Example

{
  "minValue": 0.5,
  "maxValue": 0.5,
  "maxLength": 0
}

description

Type: string

Description of the characteristic.

Example: example

name

Type: string

The name of the characteristic.

Example: example

recommendationTypes

Type: string[] | null

A list of possible recommendations for filling out the card, to which this characteristic applies.

Min items: 1

Unique items: true

Example

[
  "HAS_VIDEO"
]

unit

Type: object

defaultUnitId

Type: integer

The default unit of measurement.

units

Type: object[]

fullName

Type: string

The full name of the unit of measurement.

Example: килограмм

Type: integer

ID of the unit of measurement.

name

Type: string

The abbreviated name of the unit of measurement.

Example: кг

Acceptable units of measurement.

Example

[
  {
    "id": 0,
    "name": "кг",
    "fullName": "килограмм"
  }
]

Units of measurement of product characteristics.

Example

{
  "defaultUnitId": 0,
  "units": [
    {
      "id": 0,
      "name": "кг",
      "fullName": "килограмм"
    }
  ]
}

valueRestrictions

Type: object[]

limitedValues

Type: object[]

limitingOptionValueId

Type: integer

ID of the value of the limiting characteristic.

optionValueIds

Type: integer[]

Ids of acceptable values of the restricted characteristic.

Unique items: true

Example

[
  1
]

The values of the limiting characteristic and the corresponding allowable values of the current characteristic.

Example

[
  {
    "limitingOptionValueId": 0,
    "optionValueIds": [
      1
    ]
  }
]

limitingParameterId

Type: integer

ID of the limiting characteristic.

Min value: 1

Restrictions on values imposed by other characteristics. Only for type characteristics ENUM.

Min items: 1

Example

[
  {
    "limitingParameterId": 1,
    "limitedValues": [
      {
        "limitingOptionValueId": 0,
        "optionValueIds": [
          1
        ]
      }
    ]
  }
]

values

Type: object[]

Type: integer

ID of the value.

value

Type: string

Meaning.

Example: example

description

Type: string

Description of the value.

Example: example

A list of acceptable parameter values. Only for type characteristics ENUM.

Min items: 1

Example

[
  {
    "id": 0,
    "value": "example",
    "description": "example"
  }
]

A list of characteristics.

Min items: 1

Example

[
  {
    "id": 1,
    "name": "example",
    "type": "TEXT",
    "unit": {
      "defaultUnitId": 0,
      "units": [
        {
          "id": 0,
          "name": "кг",
          "fullName": "килограмм"
        }
      ]
    },
    "description": "example",
    "recommendationTypes": [
      "HAS_VIDEO"
    ],
    "required": true,
    "filtering": true,
    "distinctive": true,
    "multivalue": true,
    "allowCustomValues": true,
    "values": [
      {
        "id": 0,
        "value": "example",
        "description": "example"
      }
    ],
    "constraints": {
      "minValue": 0.5,
      "maxValue": 0.5,
      "maxLength": 0
    },
    "valueRestrictions": [
      {
        "limitingParameterId": 1,
        "limitedValues": [
          {}
        ]
      }
    ]
  }
]

Information about the category parameters.

Example

{
  "categoryId": 0,
  "parameters": [
    {
      "id": 1,
      "name": "example",
      "type": "TEXT",
      "unit": {
        "defaultUnitId": 0,
        "units": [
          {}
        ]
      },
      "description": "example",
      "recommendationTypes": [
        "HAS_VIDEO"
      ],
      "required": true,
      "filtering": true,
      "distinctive": true,
      "multivalue": true,
      "allowCustomValues": true,
      "values": [
        {
          "id": 0,
          "value": "example",
          "description": "example"
        }
      ],
      "constraints": {
        "minValue": 0.5,
        "maxValue": 0.5,
        "maxLength": 0
      },
      "valueRestrictions": [
        {
          "limitingParameterId": 1,
          "limitedValues": [
            null
          ]
        }
      ]
    }
  ]
}

Example

{
  "result": {
    "categoryId": 0,
    "parameters": [
      {
        "id": 1,
        "name": "example",
        "type": "TEXT",
        "unit": {
          "defaultUnitId": 0,
          "units": [
            null
          ]
        },
        "description": "example",
        "recommendationTypes": [
          "HAS_VIDEO"
        ],
        "required": true,
        "filtering": true,
        "distinctive": true,
        "multivalue": true,
        "allowCustomValues": true,
        "values": [
          {}
        ],
        "constraints": {
          "minValue": 0.5,
          "maxValue": 0.5,
          "maxLength": 0
        },
        "valueRestrictions": [
          {}
        ]
      }
    ]
  }
}

400 Bad Request

The request contains incorrect data. Learn more about errors when working with categories

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"
    }
  ]
}

Was the article helpful?

The category tree

Adding products and changing information