Добавить значение списочного свойства catalog.productPropertyEnum.add

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: catalog

Кто может выполнять метод: пользователь с правом «Просмотр каталога товаров» и правом на изменение инфоблока свойства

Метод catalog.productPropertyEnum.add добавляет значение списочного свойства.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Набор полей нового значения списка (подробное описание)

Параметр fields

Обязательные параметры отмечены *

Название
тип

Описание

propertyId*
catalog_product_property.id

Идентификатор свойства товара или вариации.

Идентификаторы свойств можно получить методом catalog.productProperty.list

value*
string

Значение элемента списка

xmlId*
string

Внешний идентификатор значения списка. Должен быть уникальным в рамках свойства

def
char

Признак значения по умолчанию. Допустимые значения:

  • Y — по умолчанию
  • N — не по умолчанию

sort
integer

Индекс сортировки

Метод добавляет значения только для свойств типа L (список). Если передать propertyId свойства другого типа, метод вернет ошибку Only list properties are supported.

Примеры кода

Как использовать примеры в документации

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"fields":{"propertyId":431,"value":"Средний","xmlId":"M","def":"Y","sort":100}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productPropertyEnum.add
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"fields":{"propertyId":431,"value":"Средний","xmlId":"M","def":"Y","sort":100},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/catalog.productPropertyEnum.add
        
try {
            const response = await $b24.callMethod('catalog.productPropertyEnum.add', {
                fields: {
                    propertyId: 431,
                    value: 'Средний',
                    xmlId: 'M',
                    def: 'Y',
                    sort: 100,
                }
            });
        
            console.log(response.getData().result);
        } catch (error) {
            console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.productPropertyEnum.add',
                    [
                        'fields' => [
                            'propertyId' => 431,
                            'value' => 'Средний',
                            'xmlId' => 'M',
                            'def' => 'Y',
                            'sort' => 100,
                        ],
                    ]
                );
        
            print_r($response->getResponseData()->getResult());
        } catch (\Throwable $exception) {
            echo $exception->getMessage();
        }
        
BX24.callMethod(
            'catalog.productPropertyEnum.add',
            {
                fields: {
                    propertyId: 431,
                    value: 'Средний',
                    xmlId: 'M',
                    def: 'Y',
                    sort: 100,
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'catalog.productPropertyEnum.add',
            [
                'fields' => [
                    'propertyId' => 431,
                    'value' => 'Средний',
                    'xmlId' => 'M',
                    'def' => 'Y',
                    'sort' => 100,
                ]
            ]
        );
        
        print_r($result);

Обработка ответа

HTTP-статус: 200

{
            "result": {
                "productPropertyEnum": {
                "def": "Y",
                "id": 1739,
                "propertyId": 431,
                "sort": 100,
                "value": "Средний",
                "xmlId": "M"
                }
            },
            "time": {
                "start": 1774279799,
                "finish": 1774279799.330864,
                "duration": 0.33086395263671875,
                "processing": 0,
                "date_start": "2026-03-23T18:29:59+03:00",
                "date_finish": "2026-03-23T18:29:59+03:00",
                "operating_reset_at": 1774280399,
                "operating": 0
            }
        }

Возвращаемые данные

Название
тип

Описание

result
object

Корневой объект ответа

productPropertyEnum
catalog_product_property_enum

Объект добавленного значения списочного свойства

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
            "error": "BX_INVALID_VALUE",
            "error_description": "Запись со значением Внешний код, равным ..., уже есть в базе данных"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

0

Access Denied

Недостаточно прав для изменения свойства инфоблока

0

productPropertyEnum does not exist.

Свойство с переданным propertyId не найдено или не относится к торговому каталогу

0

Only list properties are supported

Передано свойство, тип которого не Список

0

Required fields: xmlId

Не передано обязательное поле xmlId

0

A value with xmlId '...' already exists.

Значение с таким xmlId уже существует в рамках свойства

BX_INVALID_VALUE

Запись со значением "Внешний код", равным "...", уже есть в базе данных

Локализованная ошибка дубликата xmlId

0

Internal error adding enumeration value. Try adding again.

Внутренняя ошибка при добавлении значения списка

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Обзор методов
Следующая
Изменить значения списочных свойств