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

Метод доступен для всех моделей.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

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

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

Request

POST

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

Path parameters

Name

Description

categoryId*

Type: integer<int64>

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

Чтобы узнать идентификатор категории, к которой относится интересующий вас товар, воспользуйтесь запросом POST categories/tree.

Min value: 1

Responses

200 OK

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

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

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

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

CategoryContentParametersDTO

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

Name

Description

categoryId*

Type: integer<int32>

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

При изменении категории убедитесь, что характеристики товара и их значения в параметре parameterValues вы передаете для новой категории.

Список категорий Маркета можно получить с помощью запроса POST categories/tree.

Min value: 1

parameters

Type: CategoryParameterDTO[]

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

Min items: 1

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

CategoryParameterDTO

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

Name

Description

allowCustomValues*

Type: boolean

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

distinctive*

Type: boolean

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

filtering*

Type: boolean

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

id*

Type: integer<int64>

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

Min value: 1

multivalue*

Type: boolean

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

required*

Type: boolean

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

type*

Type: ParameterType

Тип данных.

Enum: TEXT, ENUM, BOOLEAN, NUMERIC

constraints

Type: ParameterValueConstraintsDTO

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

description

Type: string

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

name

Type: string

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

recommendationTypes

Type: OfferCardRecommendationType[]

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

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

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

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

Рекомендации по заполнению параметров в updateOfferMappings:

  • RECOGNIZED_VENDOR — напишите название производителя так, как его пишет сам производитель (параметр vendor).

  • PICTURE_COUNT — добавьте изображения (параметр pictures). Требования

    Для рекомендации приходит процент ее выполнения.

  • FIRST_PICTURE_SIZE— замените первое изображение более крупным (параметр pictures). Требования

  • TITLE_LENGTH — измените название (параметр name). Составьте название по схеме: тип + бренд или производитель + модель + особенности, если есть (размер, вес, цвет). Требования

  • DESCRIPTION_LENGTH — добавьте описание рекомендуемого размера (параметр description). Требования

  • AVERAGE_PICTURE_SIZE — замените все изображения на изображения высокого качества (параметр pictures). Требования

  • FIRST_VIDEO_LENGTH — добавьте первое видео рекомендуемой длины (параметр videos). Требования

  • FIRST_VIDEO_SIZE — замените первое видео на видео высокого качества (параметр videos). Требования

  • AVERAGE_VIDEO_SIZE — замените все видео на видео высокого качества (параметр videos). Требования

  • VIDEO_COUNT — добавьте хотя бы одно видео (параметр videos). Требования

    Для рекомендации приходит процент ее выполнения.

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

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

Рекомендации:

  • MAIN — заполните ключевые характеристики товара, которые используются в поиске и фильтрах.

    Для рекомендации приходит процент ее выполнения.

  • ADDITIONAL — заполните дополнительные характеристики товара.

    Для рекомендации приходит процент ее выполнения.

  • DISTINCTIVE — заполните характеристики, которыми отличаются друг от друга варианты товара.

    Для рекомендации приходит процент ее выполнения.

3. Устаревшие рекомендации

  • 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

unit

Type: CategoryParameterUnitDTO

Единицы измерения характеристики товара.

valueRestrictions

Type: ValueRestrictionDTO[]

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

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

Пример

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

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

Min items: 1

values

Type: ParameterValueOptionDTO[]

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

Min items: 1

ParameterType

Тип данных:

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

Type

Description

ParameterType

Enum: TEXT, ENUM, BOOLEAN, NUMERIC

ParameterValueConstraintsDTO

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

Name

Description

maxLength

Type: integer<int32>

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

maxValue

Type: number<double>

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

minValue

Type: number<double>

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

OfferCardRecommendationType

Рекомендация по дополнению или замене контента. Не возвращается для карточек, которые заполнены Маркетом или содержат бывшие в употреблении товары.

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

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

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

Рекомендации по заполнению параметров в updateOfferMappings:

  • RECOGNIZED_VENDOR — напишите название производителя так, как его пишет сам производитель (параметр vendor).

  • PICTURE_COUNT — добавьте изображения (параметр pictures). Требования

    Для рекомендации приходит процент ее выполнения.

  • FIRST_PICTURE_SIZE— замените первое изображение более крупным (параметр pictures). Требования

  • TITLE_LENGTH — измените название (параметр name). Составьте название по схеме: тип + бренд или производитель + модель + особенности, если есть (размер, вес, цвет). Требования

  • DESCRIPTION_LENGTH — добавьте описание рекомендуемого размера (параметр description). Требования

  • AVERAGE_PICTURE_SIZE — замените все изображения на изображения высокого качества (параметр pictures). Требования

  • FIRST_VIDEO_LENGTH — добавьте первое видео рекомендуемой длины (параметр videos). Требования

  • FIRST_VIDEO_SIZE — замените первое видео на видео высокого качества (параметр videos). Требования

  • AVERAGE_VIDEO_SIZE — замените все видео на видео высокого качества (параметр videos). Требования

  • VIDEO_COUNT — добавьте хотя бы одно видео (параметр videos). Требования

    Для рекомендации приходит процент ее выполнения.

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

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

Рекомендации:

  • MAIN — заполните ключевые характеристики товара, которые используются в поиске и фильтрах.

    Для рекомендации приходит процент ее выполнения.

  • ADDITIONAL — заполните дополнительные характеристики товара.

    Для рекомендации приходит процент ее выполнения.

  • DISTINCTIVE — заполните характеристики, которыми отличаются друг от друга варианты товара.

    Для рекомендации приходит процент ее выполнения.

3. Устаревшие рекомендации

  • 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

Единицы измерения характеристики товара.

Name

Description

defaultUnitId*

Type: integer<int64>

Единица измерения по умолчанию.

units*

Type: UnitDTO[]

Допустимые единицы измерения.
Единица измерения.

ValueRestrictionDTO

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

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

Пример

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

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

Name

Description

limitedValues*

Type: OptionValuesLimitedDTO[]

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

limitingParameterId*

Type: integer<int64>

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

Min value: 1

ParameterValueOptionDTO

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

Name

Description

id*

Type: integer<int64>

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

value*

Type: string

Значение.

description

Type: string

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

UnitDTO

Единица измерения.

Name

Description

fullName*

Type: string

Полное название единицы измерения.

Example: килограмм

id*

Type: integer<int64>

Идентификатор единицы измерения.

name*

Type: string

Сокращенное название единицы измерения.

Example: кг

OptionValuesLimitedDTO

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

Name

Description

limitingOptionValueId*

Type: integer<int64>

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

optionValueIds*

Type: integer<int64>[]

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

Min value: 1

400 Bad Request

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

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

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

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

401 Unauthorized

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR
Предыдущая
Дерево категорий
Следующая
Добавление товаров и изменение информации