Изменить свойство товара или вариации v 3.0 catalog.product.property.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: пользователь с правом «Просмотр каталога товаров» и правом на изменение инфоблока каталога
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод catalog.product.property.update изменяет свойство товаров или вариаций и возвращает его поля после изменения.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор свойства. Идентификатор можно получить методом catalog.product.property.list или из ответа catalog.product.property.add |
|
fields* |
Объект с полями, которые нужно изменить. Поля, которых нет в Поле |
Параметр fields
|
Название |
Описание |
|
name |
Название свойства. Пустая строка вызывает ошибку |
|
propertyType |
Базовый тип свойства. Возможные значения:
Сочетания Меняйте тип только у свойства без значений: сохраненные значения не преобразуются под новый тип |
|
userType |
Пользовательский тип свойства. Он уточняет базовый тип Основные значения и базовый тип
Значение Если |
|
userTypeSettings |
Настройки пользовательского типа. Если у свойства уже есть пользовательский тип, настройки можно передать без Значения могут быть строками, числами, логическими значениями или вложенными объектами с такими значениями. Ключи, которых нет у типа, метод отбрасывает без ошибки: например, у |
|
active |
Активность свойства. Возможные значения:
|
|
sort |
Сортировка |
|
code |
Символьный код свойства, например Метод не проверяет, что код уникален: два свойства могут получить один код. Свободен ли код, можно проверить методом catalog.product.property.list с фильтром по |
|
defaultValue |
Значение свойства по умолчанию |
|
rowCount |
Число строк поля ввода |
|
colCount |
Число колонок поля ввода |
|
listType |
Внешний вид свойства типа Возможные значения:
|
|
multiple |
Множественное свойство. Возможные значения:
|
|
multipleCnt |
Число полей для ввода множественных значений |
|
xmlId |
Внешний идентификатор свойства |
|
fileType |
Список расширений файлов для свойства типа |
|
linkIblockId |
Для свойств типа |
|
withDescription |
К значению свойства можно добавить описание. Возможные значения:
|
|
searchable |
Значения свойства участвуют в поиске. Возможные значения:
|
|
filtrable |
Свойство участвует в фильтрации товаров. Возможные значения:
|
|
isRequired |
Свойство обязательно для заполнения в карточке товара. Возможные значения:
|
|
hint |
Подсказка к полю свойства |
Флаги active, multiple, withDescription, searchable, filtrable и isRequired передаются значениями true или false. Строки Y и N вызывают ошибку.
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/catalog.product.property.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1291,"fields":{"name":"Материал подкладки и стелек","sort":550,"searchable":true,"isRequired":true}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.property.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1291,"fields":{"name":"Материал подкладки и стелек","sort":550,"searchable":true,"isRequired":true},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.product.property.update
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type ProductPropertyUpdateResult = {
item: {
id: number
iblockId: number
name: string
propertyType: string
userType: string | null
code: string | null
sort: number
active: boolean
multiple: boolean
isRequired: boolean
controlId: string
}
}
try {
const response = await $b24.actions.v3.call.make<ProductPropertyUpdateResult>({
method: 'catalog.product.property.update',
params: {
id: 1291,
fields: {
name: 'Материал подкладки и стелек',
sort: 550,
searchable: true,
isRequired: true,
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Property updated:', result.item.id, result.item.name)
}
} 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 updateProductProperty() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.product.property.update',
params: {
id: 1291,
fields: {
name: 'Материал подкладки и стелек',
sort: 550,
searchable: true,
isRequired: true,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Property updated:', result.item.id, result.item.name)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateProductProperty)
</script>
У методов catalog.product.property.* 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.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": 1291,
"fields": {
"name": "Материал подкладки и стелек",
"sort": 550,
"searchable": True,
"isRequired": True,
},
},
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.update',
[
'id' => 1291,
'fields' => [
'name' => 'Материал подкладки и стелек',
'sort' => 550,
'searchable' => true,
'isRequired' => true,
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
BX24.callMethod(
'catalog.product.property.update',
{
id: 1291,
fields: {
name: 'Материал подкладки и стелек',
sort: 550,
searchable: true,
isRequired: true,
},
},
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.update',
[
'id' => 1291,
'fields' => [
'name' => 'Материал подкладки и стелек',
'sort' => 550,
'searchable' => true,
'isRequired' => true,
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.product.property.update", b24.Params{
"id": 1291,
"fields": b24.Params{
"name": "Материал подкладки и стелек",
"sort": 550,
"searchable": true,
"isRequired": true,
},
})
if err != nil {
return fmt.Errorf("catalog.product.property.update: %w", err)
}
var result struct {
Item struct {
ID int `json:"id"`
Name string `json:"name"`
PropertyType string `json:"propertyType"`
ControlID string `json:"controlId"`
} `json:"item"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(result.Item.ID, result.Item.Name, result.Item.PropertyType, result.Item.ControlID)
Обработка ответа
HTTP-статус: 200
{
"result": {
"item": {
"id": 1291,
"timestampX": "2026-11-17T16:40:48+03:00",
"iblockId": 25,
"name": "Материал подкладки и стелек",
"active": true,
"sort": 550,
"code": "LINING_MATERIAL",
"defaultValue": null,
"propertyType": "S",
"userType": null,
"userTypeSettings": [],
"rowCount": 1,
"colCount": 30,
"listType": "L",
"multiple": false,
"multipleCnt": null,
"xmlId": null,
"fileType": null,
"linkIblockId": null,
"withDescription": false,
"searchable": true,
"filtrable": true,
"isRequired": true,
"hint": "Из чего сделана подкладка",
"controlId": "PROPERTY_1291"
}
},
"time": {
"start": 1794922848,
"finish": 1794922848.601051,
"duration": 0.6010510921478271,
"processing": 0,
"date_start": "2026-11-17T16:40:48+03:00",
"date_finish": "2026-11-17T16:40:48+03:00",
"operating_reset_at": 1794923400,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными ответа |
|
result.item |
Поля свойства после изменения. Описание полей |
|
time |
Информация о времени выполнения запроса |
Объект item
|
Название |
Описание |
|
id |
Идентификатор свойства |
|
timestampX |
Дата и время последнего изменения свойства |
|
iblockId |
Идентификатор торгового каталога, к которому относится свойство |
|
name |
Название свойства |
|
active |
Активность свойства:
|
|
sort |
Сортировка |
|
code |
Символьный код свойства |
|
defaultValue |
Значение по умолчанию |
|
propertyType |
Базовый тип свойства:
|
|
userType |
Пользовательский тип свойства, например |
|
Настройки пользовательского типа. Если настроек нет — пустой массив |
|
|
rowCount |
Число строк поля ввода |
|
colCount |
Число колонок поля ввода |
|
listType |
Внешний вид списка:
|
|
multiple |
Множественное свойство:
|
|
multipleCnt |
Число полей для ввода множественных значений |
|
xmlId |
Внешний идентификатор свойства |
|
fileType |
Расширения файлов для свойства типа |
|
linkIblockId |
Для свойств типа |
|
withDescription |
|
|
searchable |
|
|
filtrable |
|
|
isRequired |
|
|
hint |
Подсказка к полю свойства |
|
controlId |
Имя поля свойства в формах инфоблока в формате |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Ошибка при валидации объекта запроса",
"validation": [
{
"message": "Field `iblockId` cannot be changed"
}
]
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки валидации объекта
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Поле "#FIELD#" не доступно к заполнению |
Уберите из |
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не заполнено значение хотя бы одного обязательного поля: id, filter |
Передайте |
|
|
Обязательное поле |
Передайте объект |
|
|
No fields to update |
Передайте в |
|
|
Field |
Уберите |
|
|
Property type |
Свойство-флажок создайте методом catalog.product.property.add |
|
|
В поле |
Передайте значение нужного типа. Флаги передавайте значениями |
|
|
Не введено название. |
Передайте непустую строку в |
|
|
Invalid property type specified |
Передайте |
|
|
Custom property type settings are not supported for this property type |
Уберите |
|
|
Invalid custom property type settings specified |
Передайте в |
|
|
Код свойства не может начинаться с цифры.: |
Начните |
Ошибка фильтра
Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не удается распознать выражение фильтра |
Метод не принимает |
Ошибка отсутствия объекта
Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Запись с ID = |
Свойство не найдено или не относится к торговому каталогу. Проверьте идентификатор методом catalog.product.property.list |
Ошибка неизвестного поля
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Передайте в |
Ошибка доступа
Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Доступ запрещен |
Проверьте, что у пользователя есть право «Просмотр каталога товаров» и право на изменение инфоблока каталога |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить свойство товара или вариации v 3.0 catalog.product.property.add
- Получить значения полей свойства товара или вариации v 3.0 catalog.product.property.get
- Получить список свойств товаров или вариаций v 3.0 catalog.product.property.list
- Удалить свойство товара или вариации v 3.0 catalog.product.property.delete
- Получить список полей свойства товара v 3.0 catalog.product.property.field.list