Изменить значение списочного свойства v 3.0 catalog.product.property.enum.update

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: catalog

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

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод catalog.product.property.enum.update изменяет значение свойства типа «Список» и возвращает его поля после изменения.

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

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

Название
тип

Описание

id*
integer

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

Идентификатор можно получить методом catalog.product.property.enum.list или при создании значения методом catalog.product.property.enum.add

fields*
object

Объект с полями, которые нужно изменить. Передавайте только изменяемые поля. Описание полей

Пустой объект {} вызывает ошибку валидации

Параметр fields

Название
тип

Описание

value
string

Текст значения, до 255 символов. Пустая строка и null вызывают ошибку

xmlId
string

Внешний код значения, до 200 символов. Код должен быть уникальным среди значений всех списочных свойств Битрикс24: если код Y уже есть у значения другого свойства, использовать его нельзя

def
boolean

Признак значения по умолчанию.

Возможные значения:

  • true — значение по умолчанию
  • false — обычное значение

Значения Y, N и null не принимаются. Метод не снимает признак с других значений свойства, поэтому значений по умолчанию может оказаться несколько. Чтобы оставить одно, передайте прежнему значению def: false

sort
integer

Индекс сортировки. null сохраняется как 0

Поле id изменить нельзя. Перенести значение в другое свойство тоже нельзя: если передать propertyId, метод вернет ошибку. Вместо этого создайте значение в нужном свойстве методом catalog.product.property.enum.add. Если нужен прежний xmlId, сначала удалите старое значение: внешний код уникален среди всех списочных свойств.

Примеры кода

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

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/catalog.product.property.enum.update

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1789,"fields":{"value":"Лимонный","sort":350}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.property.enum.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1789,"fields":{"value":"Лимонный","sort":350},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.product.property.enum.update
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type EnumUpdateResult = {
  item: {
    id: number
    propertyId: number
    value: string
    def: boolean
    sort: number
    xmlId: string
  }
}

try {
  const response = await $b24.actions.v3.call.make<EnumUpdateResult>({
    method: 'catalog.product.property.enum.update',
    params: {
        id: 1789,
        fields: {
          value: 'Лимонный',
          sort: 350,
        },
      },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Value updated:', result.item.value)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function updateEnumValue() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.product.property.enum.update',
        params: {
              id: 1789,
              fields: {
                value: 'Лимонный',
                sort: 350,
              },
            },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Value updated:', result.item.value)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateEnumValue)
</script>

У методов catalog.product.property.enum.* REST 3.0 нет готовых оберток в b24pysdk, и SDK отправляет в REST 3.0 только методы из списка Config().api_v3_methods. Добавьте метод в этот список и вызовите его через call_method токена клиента с prefer_version=3.

from b24pysdk import Config
from b24pysdk.errors import BitrixSDKException
from b24pysdk.errors.v3 import BitrixAPIError

method = "catalog.product.property.enum.update"
Config().configure(api_v3_methods=Config().api_v3_methods | {method})
bitrix_token = client.get_token()

try:
    response = bitrix_token.call_method(
        api_method=method,
        params={
            "id": 1789,
            "fields": {
                "value": "Лимонный",
                "sort": 350,
            },
        },
        prefer_version=3,
    )
    result = response["result"]
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"code: {error.code}",
        f"message: {error.error.message}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
                'catalog.product.property.enum.update',
                [
                    'id' => 1789,
                    'fields' => [
                        'value' => 'Лимонный',
                        'sort' => 350,
                    ],
                ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    print_r($result);
} catch (Throwable $e) {
    echo $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'catalog.product.property.enum.update',
    {
        id: 1789,
        fields: {
            value: 'Лимонный',
            sort: 350,
        },
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'catalog.product.property.enum.update',
    [
        'id' => 1789,
        'fields' => [
            'value' => 'Лимонный',
            'sort' => 350,
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.product.property.enum.update", b24.Params{
	"id": 1789,
	"fields": b24.Params{
		"value": "Лимонный",
		"sort":  350,
	},
})
if err != nil {
	return fmt.Errorf("catalog.product.property.enum.update: %w", err)
}

// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
	return fmt.Errorf("в ответе нет ключа item")
}

var item struct {
	ID         int    `json:"id"`
	PropertyID int    `json:"propertyId"`
	Value      string `json:"value"`
	Def        bool   `json:"def"`
	Sort       int    `json:"sort"`
	XMLID      string `json:"xmlId"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Value, item.Sort)

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

HTTP-статус: 200

{
    "result": {
        "item": {
            "id": 1789,
            "propertyId": 1285,
            "value": "Лимонный",
            "def": false,
            "sort": 350,
            "xmlId": "color-yellow"
        }
    },
    "time": {
        "start": 1794922617,
        "finish": 1794922617.047431,
        "duration": 0.047430992126464844,
        "processing": 0,
        "date_start": "2026-11-17T16:36:57+03:00",
        "date_finish": "2026-11-17T16:36:57+03:00",
        "operating_reset_at": 1794923160,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

Объект с данными ответа

result.item
object

Поля значения после изменения. Описание полей

time
time

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

Объект item

Название
тип

Описание

id
integer

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

propertyId
integer

Идентификатор свойства, к которому относится значение

value
string

Текст значения

def
boolean

Признак значения по умолчанию: true — значение по умолчанию, false — обычное значение

sort
integer

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

xmlId
string

Внешний код значения

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Field `propertyId` cannot be changed"
            }
        ]
    }
}

Название
тип

Описание

error.code
string

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

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

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

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

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

Как исправить

-

Не заполнено значение хотя бы одного обязательного поля: id, filter

Передайте в id положительное число. Вместе с этим сообщением приходит второе: «Должно быть передано только одно из значений: id, filter»

fields

Обязательное поле fields не указано

Передайте объект fields

-

No fields to update

Передайте в fields хотя бы одно поле

-

Field propertyId cannot be changed

Уберите propertyId из fields. Чтобы перенести значение в другое свойство, создайте его там заново

BX_INVALID_VALUE

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

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

BX_EMPTY_REQUIRED

Не заполнено обязательное поле "Значение"

Передайте в value непустую строку

BX_INVALID_VALUE

Для значения поля "Значение" превышена максимальная длина: 255.

Сократите value до 255 символов

def

В поле def требуется тип данных bool для такого запроса

Передайте true или false, а не Y или N

BX_INVALID_VALUE

Неправильное значение для "По умолчанию"

Не передавайте null в def

Ошибки валидации объекта

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Поле

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

Как исправить

#FIELD#

Поле "#FIELD#" не доступно к заполнению

Уберите id из fields

Ошибка формата фильтра

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION

Поле

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

Как исправить

filter

Не удается распознать выражение фильтра filter

Метод не поддерживает filter. Передайте id значения

Ошибка отсутствия объекта

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Поле

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

Как исправить

id

Запись с ID = #ID# не найдена

Проверьте идентификатор методом catalog.product.property.enum.list

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

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

Как исправить

-

Неизвестное поле #FIELD# для сущности ProductPropertyEnumDto

Передайте в fields только поля из таблицы параметра fields

Ошибка доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Поле

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

Как исправить

-

Доступ запрещен

Проверьте, что у пользователя есть право «Просмотр каталога товаров» и право на изменение инфоблока свойства

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

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

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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