Изменить свойство товаров или вариаций catalog.productProperty.update
Scope:
catalogКто может выполнять метод: пользователь с правом на просмотр каталога
Метод catalog.productProperty.update изменяет поля свойства товара или вариации.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
Идентификатор свойства. Идентификаторы свойств можно получить методом catalog.productProperty.list |
|
|
fields* |
Набор полей для обновления свойства (подробное описание) |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
iblockId* |
Идентификатор торгового каталога. Идентификаторы можно получить методом catalog.catalog.list |
|
name |
Название свойства |
|
propertyType |
Базовый тип свойства. Изменять нельзя |
|
active |
Признак активности. Допустимые значения:
|
|
sort |
Индекс сортировки |
|
code |
Символьный код свойства. Код свойства может состоять из латинских символов, цифр и знака подчеркивания. Первый символ не может быть цифрой |
|
defaultValue |
Значение свойства по умолчанию |
|
userType |
Пользовательский тип свойства. Изменять нельзя |
|
rowCount |
Число строк поля ввода |
|
colCount |
Число колонок поля ввода |
|
listType |
Внешний вид списка. Допустимые значения:
|
|
multiple |
Признак множественного значения. Допустимые значения:
|
|
xmlId |
Внешний идентификатор свойства |
|
fileType |
Список расширений файлов для свойства типа |
|
multipleCnt |
Число полей для ввода множественных значений |
|
linkIblockId |
Идентификатор связанного инфоблока. Доступные идентификаторы можно получить методом catalog.catalog.list |
|
withDescription |
Признак хранения описания значения. Допустимые значения:
|
|
searchable |
Признак участия в поиске. Допустимые значения:
|
|
filtrable |
Признак участия в фильтрации. Допустимые значения:
|
|
isRequired |
Признак обязательного значения. Допустимые значения:
|
|
hint |
Подсказка к полю |
|
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 |
Корневой объект ответа |
|
productProperty |
Объект с информацией об обновленном свойстве |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Required fields: iblockId"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Required fields: iblockId |
В |
|
|
|
Access Denied |
Недостаточно прав для просмотра каталога |
|
|
Пустое значение |
productProperty does not exist |
Свойство с указанным |
|
|
|
The specified property does not belong to a product catalog |
Свойство не относится к торговому каталогу |
|
|
|
Invalid property type specified |
Передана недопустимая комбинация |
|
|
|
Invalid custom property type settings specified |
Передан недопустимый формат |
|
|
|
Код свойства не может начинаться с цифры |
Неверный формат параметра |
|
|
|
Неверный код информационного блока |
Неверный формат параметра |
|
|
|
Invalid value { |
Неверный тип данных у значения параметра |
|
|
|
Wrong format of field |
Передан параметр с типом, который не соответствует формату поля |
|
|
|
Error updating product property |
Внутренняя ошибка при обновлении свойства |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить свойство товара или вариации catalog.productProperty.add
- Получить значения полей свойства товаров или вариаций catalog.productProperty.get
- Получить список свойств товаров или вариаций catalog.productProperty.list
- Удалить свойство товаров или вариаций catalog.productProperty.delete
- Получить поля свойства товаров или вариаций catalog.productProperty.getFields