метод REST scope: catalog

catalog.productProperty.add

Добавить свойство товара или вариации

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

Описание

Метод catalog.productProperty.add добавляет свойство товара или вариации.

Параметры

fields object обязательный

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

Параметр fields

iblockId catalog_catalog.id обязательный

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

Получить существующие идентификаторы можно методом catalog.catalog.list

name string обязательный

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

propertyType string обязательный

Базовый тип свойства. Допустимые значения:
- N — число
- S — строка
- L — список
- F — файл
- E — привязка к элементам
- G — привязка к разделам

active char необязательный

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

sort integer необязательный

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

code string необязательный

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

defaultValue text необязательный

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

userType string необязательный

Пользовательский тип свойства. Значение должно соответствовать указанному propertyType.

Примеры значений:
- DateTime — дата и время
- Money — денежное значение с валютой
- SKU — привязка к вариациям товара
- directory — привязка к справочнику
- employee — привязка к сотруднику
- UserID — привязка к пользователю
- EList — выбор элемента из списка
- EAutocomplete — привязка к элементам с автопоиском
- SectionAuto — привязка к разделам с автопоиском
- HTML — значение в формате HTML
- map_google — координаты и адрес на карте Google
- map_yandex — координаты и адрес на карте Яндекс
- DiskFile — привязка к файлу из Битрикс24.Диск
- ECrm — привязка к элементам CRM
- BoolEnum — чекбокс на базе списка, это значение используйте вместе с propertyType = L

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 необязательный

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

Примеры запроса

curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{"fields":{"iblockId":19,"name":"Рубрика","code":"CATEGORY","propertyType":"S","userType":"directory","multiple":"N","isRequired":"N","active":"Y","sort":100,"userTypeSettings":{"tableName":"b_hlbd_categories"}}}' \
  https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.productProperty.add

Ответ

HTTP-статус: 200

{
    "result": {
        "productProperty": {
            "active": "Y",
            "code": "CATEGORY",
            "colCount": 30,
            "defaultValue": null,
            "fileType": null,
            "filtrable": "N",
            "hint": null,
            "iblockId": 19,
            "id": 659,
            "isRequired": "N",
            "linkIblockId": null,
            "listType": "L",
            "multiple": "N",
            "multipleCnt": null,
            "name": "Рубрика",
            "propertyType": "S",
            "rowCount": 1,
            "searchable": "N",
            "sort": 100,
            "timestampX": "2026-03-19T15:46:23+03:00",
            "userType": "directory",
            "userTypeSettings": {
                "group": "N",
                "multiple": "N",
                "size": 1,
                "tableName": "b_hlbd_categories",
                "width": 0
            },
            "withDescription": null,
            "xmlId": null
        }
    },
    "time": {
        "start": 1773927983,
        "finish": 1773927983.409049,
        "duration": 0.40904903411865234,
        "processing": 0,
        "date_start": "2026-03-19T16:46:23+03:00",
        "date_finish": "2026-03-19T16:46:23+03:00",
        "operating_reset_at": 1773928583,
        "operating": 0
    }
}

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

result object

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

productProperty catalog_product_property

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

time time

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

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

HTTP-статус: 400

{
    "error": "0",
    "error_description": "Invalid property type specified"
}
Код Описание Значение
400 0 Required fields: iblockId, name, propertyType
400 0 Access Denied
400 0 The specified iblock is not a product catalog
400 0 Invalid property type specified
400 0 Invalid custom property type settings specified
400 0 Код свойства не может начинаться с цифры
400 0 Wrong format of field ...
400 0 Error adding property

Что будем искать? Например,Продвижение

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