Списки характеристик товаров по категориям

Возвращает список характеристик с допустимыми значениями для заданной категории.

⚙️ Лимит: 50 категорий в минуту

Request

POST

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

Path parameters

Name

Type

Description

categoryId*

integer<int64>

Идентификатор категории на Маркете.

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом POST businesses/{businessId}/offer-cards.

Responses

200 OK

Список характеристик товаров из заданной категории.

Body

application/json
{
    "status": "OK",
    "result": {
        "categoryId": 0,
        "parameters": [
            {
                "id": 0,
                "name": "string",
                "type": "TEXT",
                "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

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

result

CategoryContentParametersDTO

Информация о параметрах категории.

ApiResponseStatusType

Тип ответа.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

CategoryContentParametersDTO

Информация о параметрах категории.

Name

Type

Description

categoryId*

integer<int32>

Идентификатор категории на Маркете.

parameters

CategoryParameterDTO[]

Список характеристик.
Характеристика товара.

CategoryParameterDTO

Характеристика товара.

Name

Type

Description

id*

integer<int64>

Идентификатор характеристики.

name

string

Название характеристики.

type*

ParameterType

Тип данных.
Enum: TEXT, ENUM, BOOLEAN, NUMERIC

description

string

Описание характеристики.

recommendationTypes

OfferCardRecommendationType[]

Перечень возможных рекомендаций по заполнению карточки, к которым относится данная характеристика.
Рекомендация по дополнению или замене контента.

Часть рекомендаций относятся к основным параметрам, которые есть у товаров любых категорий. Другие — к тем характеристикам, которые есть у товара потому, что он относится к определенной категории.

1. Рекомендации, относящиеся к основным параметрам

Каждая такая рекомендация относится к единственному параметру. Чтобы заполнить этот параметр, пользуйтесь запросом POST businesses/{businessId}/offer-mappings/update.

|Рекомендация |Содержание |Параметр в updateOfferMappings| |--------------------|---------------------------------------------------------------------|------------------------------| |HAS_VIDEO |Добавьте на карточку видео. |videos | |RECOGNIZED_VENDOR |Напишите название производителя так, как его пишет сам производитель.|vendor | |PICTURE_COUNT |Добавьте изображения. |pictures | |HAS_DESCRIPTION |Заполните описание. |description | |HAS_BARCODE |Укажите штрихкод. |barcode | |FIRST_PICTURE_SIZE|Замените первое изображение более крупным. |pictures |

2. Рекомендации, относящиеся к характеристикам по категориям

Каждая такая рекомендация предполагает заполнение одной или нескольких характеристик. Чтобы узнать, какие именно характеристики нужно заполнить, воспользуйтесь запросом POST category/{categoryId}/parameters. Например, если вы получили рекомендацию MAIN, нужно заполнить характеристики, имеющие MAIN в массиве recommendationTypes.

|Рекомендация |Содержание | |-------------|----------------------------------------------------------------------------| |MAIN |Заполните ключевые характеристики товара. | |ADDITIONAL |Заполните дополнительные характеристики товара. | |FILTERABLE |Заполните характеристики, используемые в фильтрах. | |DISTINCTIVE|Заполните характеристики, которыми отличаются друг от друга варианты товара.|
Enum: HAS_VIDEO, RECOGNIZED_VENDOR, MAIN, ADDITIONAL, DISTINCTIVE, FILTERABLE, PICTURE_COUNT, HAS_DESCRIPTION, HAS_BARCODE, FIRST_PICTURE_SIZE

required*

boolean

Обязательность характеристики.

filtering*

boolean

Используется ли характеристика в фильтре.

distinctive*

boolean

Является ли характеристика особенностью варианта.

multivalue*

boolean

Можно ли передать сразу несколько значений.

allowCustomValues*

boolean

Можно ли передавать собственное значение, которого нет в списке вариантов Маркета. Только для характеристик типа ENUM.

values

ParameterValueOptionDTO[]

Список допустимых значений параметра. Только для характеристик типа ENUM.
Значение характеристики.

constraints

ParameterValueConstraintsDTO

Ограничения на значения. Только для характеристик типа TEXT и NUMERIC.

valueRestrictions

ValueRestrictionDTO[]

Ограничения на значения, накладываемые другими характеристиками. Только для характеристик типа ENUM.
Ограничение на возможные значения, накладываемое другой характеристикой.

Если ограничивающая характеристика принимает определенное значение, список возможных значений ограничиваемой характеристики сокращается.

Пример

Характеристика размер сама по себе может принимать девять разных значений: S, M, L, 44, 46, 48, 42/164, 46/176, 44S.

Если ограничивающая характеристика размерная сетка принимает значение RU, список возможных значений размера сокращается до 44, 46, 48.

ParameterType

Тип данных:

  • TEXT — текст;
  • ENUM — список возможных значений;
  • BOOLEAN — true или false;
  • NUMERIC — число.

Type

Description

ParameterType

Enum: TEXT, ENUM, BOOLEAN, NUMERIC

OfferCardRecommendationType

Рекомендация по дополнению или замене контента.

Часть рекомендаций относятся к основным параметрам, которые есть у товаров любых категорий. Другие — к тем характеристикам, которые есть у товара потому, что он относится к определенной категории.

1. Рекомендации, относящиеся к основным параметрам

Каждая такая рекомендация относится к единственному параметру. Чтобы заполнить этот параметр, пользуйтесь запросом POST businesses/{businessId}/offer-mappings/update.

Рекомендация Содержание Параметр в updateOfferMappings
HAS_VIDEO Добавьте на карточку видео. videos
RECOGNIZED_VENDOR Напишите название производителя так, как его пишет сам производитель. vendor
PICTURE_COUNT Добавьте изображения. pictures
HAS_DESCRIPTION Заполните описание. description
HAS_BARCODE Укажите штрихкод. barcode
FIRST_PICTURE_SIZE Замените первое изображение более крупным. pictures

2. Рекомендации, относящиеся к характеристикам по категориям

Каждая такая рекомендация предполагает заполнение одной или нескольких характеристик. Чтобы узнать, какие именно характеристики нужно заполнить, воспользуйтесь запросом POST category/{categoryId}/parameters. Например, если вы получили рекомендацию MAIN, нужно заполнить характеристики, имеющие MAIN в массиве recommendationTypes.

Рекомендация Содержание
MAIN Заполните ключевые характеристики товара.
ADDITIONAL Заполните дополнительные характеристики товара.
FILTERABLE Заполните характеристики, используемые в фильтрах.
DISTINCTIVE Заполните характеристики, которыми отличаются друг от друга варианты товара.

Type

Description

OfferCardRecommendationType

Enum: HAS_VIDEO, RECOGNIZED_VENDOR, MAIN, ADDITIONAL, DISTINCTIVE, FILTERABLE, PICTURE_COUNT, HAS_DESCRIPTION, HAS_BARCODE, FIRST_PICTURE_SIZE

ParameterValueOptionDTO

Значение характеристики.

Name

Type

Description

id*

integer<int64>

Идентификатор значения.

value*

string

Значение.

description

string

Описание значения.

ParameterValueConstraintsDTO

Ограничения на значения характеристик.

Name

Type

Description

minValue

number<double>

Минимальное число.

maxValue

number<double>

Максимальное число.

maxLength

integer<int32>

Максимальная длина текста.

ValueRestrictionDTO

Ограничение на возможные значения, накладываемое другой характеристикой.

Если ограничивающая характеристика принимает определенное значение, список возможных значений ограничиваемой характеристики сокращается.

Пример

Характеристика размер сама по себе может принимать девять разных значений: S, M, L, 44, 46, 48, 42/164, 46/176, 44S.

Если ограничивающая характеристика размерная сетка принимает значение RU, список возможных значений размера сокращается до 44, 46, 48.

Name

Type

Description

limitingParameterId*

integer<int64>

Идентификатор ограничивающей характеристики.

limitedValues*

OptionValuesLimitedDTO[]

Значения ограничивающей характеристики и соответствующие допустимые значения текущей характеристики.
Значение ограничивающей характеристики и список допустимых значений ограничиваемой характеристики.

OptionValuesLimitedDTO

Значение ограничивающей характеристики и список допустимых значений ограничиваемой характеристики.

Name

Type

Description

limitingOptionValueId*

integer<int64>

Идентификатор значения ограничивающей характеристики.

optionValueIds*

integer<int64>[]

Идентификаторы допустимых значений ограничиваемой характеристики.

400 Bad Request

Запрос содержит неправильные данные.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

ApiErrorDTO

Общий формат ошибки.

Name

Type

Description

code*

string

Код ошибки.

message

string

Описание ошибки.

401 Unauthorized

В запросе не указаны данные для авторизации.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Type

Description

status

ApiResponseStatusType

Тип ответа.
Enum: OK, ERROR

errors

ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.
Предыдущая
Информация о карточках магазина
Следующая
Заполнение карточек
В этой статье: