Изменить свойство товаров или вариаций catalog.productProperty.update

Scope: catalog

Кто может выполнять метод: пользователь с правом на просмотр каталога

Метод catalog.productProperty.update изменяет поля свойства товара или вариации.

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

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

Название
тип

Описание

id*
catalog_product_property.id

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

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

fields*
object

Набор полей для обновления свойства (подробное описание)

Параметр fields

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

Название
тип

Описание

iblockId*
catalog_catalog.id

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

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

name
string

Название свойства

propertyType
string

Базовый тип свойства. Изменять нельзя

active
char

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

  • Y — да
  • N — нет

sort
integer

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

code
string

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

defaultValue
text

Значение свойства по умолчанию

userType
string

Пользовательский тип свойства. Изменять нельзя

rowCount
integer

Число строк поля ввода

colCount
integer

Число колонок поля ввода

listType
char

Внешний вид списка. Допустимые значения:

  • L — выпадающий список
  • C — набор флажков

multiple
char

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

  • Y — да
  • N — нет

xmlId
string

Внешний идентификатор свойства

fileType
string

Список расширений файлов для свойства типа F

multipleCnt
integer

Число полей для ввода множественных значений

linkIblockId
catalog_catalog.id

Идентификатор связанного инфоблока.

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

withDescription
char

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

  • Y — да
  • N — нет

searchable
char

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

  • Y — да
  • N — нет

filtrable
char

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

  • Y — да
  • N — нет

isRequired
char

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

  • Y — да
  • N — нет

hint
string

Подсказка к полю

userTypeSettings
object

Настройки пользовательского типа. Поддерживаются только скалярные значения и вложенные объекты из скалярных значений.

Если указан userType, но не указан userTypeSettings, настройки не валидируются методом дополнительно

Примеры кода

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

curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"id":115,"fields":{"iblockId":19,"name":"Размер","propertyType":"L","isRequired":"Y","active":"Y"}}' \
          https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productProperty.update
        
curl -X POST \
          -H "Content-Type: application/json" \
          -H "Accept: application/json" \
          -d '{"id":115,"fields":{"iblockId":19,"name":"Размер","propertyType":"L","isRequired":"Y","active":"Y"},"auth":"**put_access_token_here**"}' \
          https://**put_your_bitrix24_address**/rest/catalog.productProperty.update
        
try {
            const response = await $b24.callMethod('catalog.productProperty.update', {
                id: 115,
                fields: {
                    iblockId: 19,
                    name: 'Размер',
                    propertyType: 'L',
                    isRequired: 'Y',
                    active: 'Y'
                }
            });
        
            console.log(response.getData().result);
        }
        catch (error) {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.productProperty.update',
                    [
                        'id' => 115,
                        'fields' => [
                            'iblockId' => 19,
                            'name' => 'Размер',
                            'propertyType' => 'L',
                            'isRequired' => 'Y',
                            'active' => 'Y',
                        ]
                    ]
                );
        
            print_r($response->getResponseData()->getResult());
        } catch (\Throwable $exception) {
            echo $exception->getMessage();
        }
        
BX24.callMethod(
            'catalog.productProperty.update',
            {
                id: 115,
                fields: {
                    iblockId: 19,
                    name: 'Размер',
                    propertyType: 'L',
                    isRequired: 'Y',
                    active: 'Y'
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'catalog.productProperty.update',
            [
                'id' => 115,
                'fields' => [
                    'iblockId' => 19,
                    'name' => 'Размер',
                    'propertyType' => 'L',
                    'isRequired' => 'Y',
                    'active' => 'Y',
                ]
            ]
        );
        
        print_r($result);
        

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

HTTP-статус: 200

{
            "result": {
                "productProperty": {
                    "active": "Y",
                    "code": null,
                    "colCount": 30,
                    "defaultValue": null,
                    "fileType": null,
                    "filtrable": "Y",
                    "hint": null,
                    "iblockId": 19,
                    "id": 115,
                    "name": "Размер",
                    "isRequired": "Y",
                    "linkIblockId": null,
                    "listType": "L",
                    "multiple": "N",
                    "multipleCnt": null,
                    "propertyType": "L",
                    "rowCount": 1,
                    "searchable": "N",
                    "sort": 500,
                    "timestampX": "2026-03-19T20:46:43+03:00",
                    "userType": null,
                    "userTypeSettings": null,
                    "withDescription": null,
                    "xmlId": null
                }
            },
            "time": {
                "start": 1773946003,
                "finish": 1773946003.953583,
                "duration": 0.9535830020904541,
                "processing": 0,
                "date_start": "2026-03-19T21:46:43+03:00",
                "date_finish": "2026-03-19T21:46:43+03:00",
                "operating_reset_at": 1773946603,
                "operating": 0
            }
        }
        

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

Название
тип

Описание

result
object

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

productProperty
catalog_product_property

Объект с информацией об обновленном свойстве

time
time

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

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

HTTP-статус: 400

{
            "error": "0",
            "error_description": "Required fields: iblockId"
        }
        

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Статус

Код

Описание

Значение

400

0

Required fields: iblockId

В fields не передан обязательный параметр iblockId

400

0

Access Denied

Недостаточно прав для просмотра каталога

400

Пустое значение

productProperty does not exist

Свойство с указанным id не найдено

400

0

The specified property does not belong to a product catalog

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

400

0

Invalid property type specified

Передана недопустимая комбинация propertyType и userType

400

0

Invalid custom property type settings specified

Передан недопустимый формат userTypeSettings

400

0

Код свойства не может начинаться с цифры

Неверный формат параметра code

400

0

Неверный код информационного блока

Неверный формат параметра iblockId

400

100

Invalid value {...} to match with parameter {id}. Should be value of type int

Неверный тип данных у значения параметра id

400

0

Wrong format of field ...

Передан параметр с типом, который не соответствует формату поля

400

0

Error updating product property

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

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

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

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

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

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

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