# catalog.productProperty.add

URL: https://chugunov.pro/api-bitrix24/catalog/product-property/catalog-product-property-add/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Добавить свойство товара или вариации
Scope: `catalog`
Кто может выполнять метод: пользователь с правом на изменение каталога товаров

## Описание

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

## Параметры

- `fields` `object` — обязательный. Набор полей нового свойства [(подробное описание)](#fields)

### Параметр fields

- `iblockId` `catalog_catalog.id` — обязательный. Идентификатор торгового каталога. 
  Получить существующие идентификаторы можно методом [catalog.catalog.list](https://chugunov.pro/api-bitrix24/catalog/catalog/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](https://chugunov.pro/api-bitrix24/catalog/catalog/catalog-catalog-list/)
- `withDescription` `char` — необязательный. Признак хранения описания значения. Допустимые значения:
  - `Y` — да
  - `N` — нет
- `searchable` `char` — необязательный. Признак участия в поиске. Допустимые значения:
  - `Y` — да
  - `N` — нет
- `filtrable` `char` — необязательный. Признак участия в фильтрации. Допустимые значения:
  - `Y` — да
  - `N` — нет
- `isRequired` `char` — необязательный. Признак обязательного значения. Допустимые значения:
  - `Y` — да
  - `N` — нет
- `hint` `string` — необязательный. Подсказка к полю
- `userTypeSettings` `object` — необязательный. Настройки пользовательского типа. Поддерживаются только скалярные значения и вложенные объекты из скалярных значений

## Ответ

HTTP-статус: 200

```json
{
    "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

```json
{
    "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

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

### cURL (Webhook)

```bash
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
```

### cURL (OAuth)

```bash
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"}},"auth":"**put_access_token_here**"}' \
  https://**put_your_bitrix24_address**/rest/catalog.productProperty.add
```

### JS (TS)

```ts
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type ProductPropertyResult = {
  productProperty: {
    active: string,
    code: string | null,
    colCount: number,
    defaultValue: string | null,
    fileType: string | null,
    filtrable: string,
    hint: string | null,
    iblockId: number,
    id: number,
    isRequired: string,
    linkIblockId: number | null,
    listType: string,
    multiple: string,
    multipleCnt: number | null,
    name: string,
    propertyType: string,
    rowCount: number,
    searchable: string,
    sort: number,
    timestampX: ISODate,
    userType: string | null,
    userTypeSettings: Record<string, unknown> | null,
    withDescription: string | null,
    xmlId: string | null,
  },
}

try {
  const response = await $b24.actions.v2.call.make<ProductPropertyResult>({
    method: 'catalog.productProperty.add',
    params: {
      fields: {
        iblockId: 19,
        name: 'Category',
        code: 'CATEGORY',
        propertyType: 'S',
        userType: 'directory',
        multiple: 'N',
        isRequired: 'N',
        active: 'Y',
        sort: 100,
        userTypeSettings: {
          tableName: 'b_hlbd_categories', // existing catalog in Bitrix24
        },
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info(result.productProperty.id, result.productProperty.name)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function addProductProperty() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'catalog.productProperty.add',
        params: {
          fields: {
            iblockId: 19,
            name: 'Category',
            code: 'CATEGORY',
            propertyType: 'S',
            userType: 'directory',
            multiple: 'N',
            isRequired: 'N',
            active: 'Y',
            sort: 100,
            userTypeSettings: {
              tableName: 'b_hlbd_categories', // existing catalog in Bitrix24
            },
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info(result.productProperty.id, result.productProperty.name)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

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

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.product_property.add(
        fields={
            "iblockId": 19,
            "name": "Рубрика",
            "propertyType": "S",
            "multiple": "N",
            "active": "Y",
            "sort": 100,
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
try {
    $response = $b24Service
        ->core
        ->call(
            'catalog.productProperty.add',
            [
                'fields' => [
                    'iblockId' => 19,
                    'name' => 'Рубрика',
                    'code' => 'CATEGORY',
                    'propertyType' => 'S',
                    'userType' => 'directory',
                    'multiple' => 'N',
                    'isRequired' => 'N',
                    'active' => 'Y',
                    'sort' => 100,
                    'userTypeSettings' => [
                        'tableName' => 'b_hlbd_categories', // существующий справочник в Битрикс24
                    ],
                ],
            ]
        );

    print_r($response->getResponseData()->getResult());
} catch (\Throwable $exception) {
    echo $exception->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'catalog.productProperty.add',
    {
        fields: {
            iblockId: 19,
            name: 'Рубрика',
            code: 'CATEGORY',
            propertyType: 'S',
            userType: 'directory',
            multiple: 'N',
            isRequired: 'N',
            active: 'Y',
            sort: 100,
            userTypeSettings: {
                tableName: 'b_hlbd_categories', // существующий справочник в Битрикс24
            }
        }
    },
    function(result) {
        if (result.error()) {
            console.error(result.error());
        } else {
            console.log(result.data());
        }
    }
);
```

### PHP CRest

```php
require_once('crest.php');

$result = CRest::call(
    'catalog.productProperty.add',
    [
        'fields' => [
            'iblockId' => 19,
            'name' => 'Рубрика',
            'code' => 'CATEGORY',
            'propertyType' => 'S',
            'userType' => 'directory',
            'multiple' => 'N',
            'isRequired' => 'N',
            'active' => 'Y',
            'sort' => 100,
            'userTypeSettings' => [
                'tableName' => 'b_hlbd_categories', // существующий справочник в Битрикс24
            ],
        ]
    ]
);

print_r($result);
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.productProperty.add", b24.Params{
	"fields": b24.Params{
		"iblockId":     19,
		"name":         "Рубрика",
		"code":         "CATEGORY",
		"propertyType": "S",
		"userType":     "directory",
		"multiple":     "N",
		"isRequired":   "N",
		"active":       "Y",
		"sort":         100,
		"userTypeSettings": b24.Params{
			"tableName": "b_hlbd_categories",
		},
	},
})
if err != nil {
	return fmt.Errorf("catalog.productProperty.add: %w", err)
}

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

var item struct {
	Active    string `json:"active"`
	Code      string `json:"code"`
	ColCount  int    `json:"colCount"`
	Filtrable string `json:"filtrable"`
	IblockID  b24.ID `json:"iblockId"`
	ID        b24.ID `json:"id"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Active, item.Code)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/catalog/product-property/catalog-product-property-add.html