Add Product Property or Variation catalog.productProperty.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
catalogWho can execute the method: user with permission to modify the product catalog
The method catalog.productProperty.add adds a property to a product or variation.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Set of fields for the new property (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
iblockId* |
Identifier of the trade catalog. Existing identifiers can be obtained using the method catalog.catalog.list |
|
name* |
Name of the property |
|
propertyType* |
Basic type of the property. Allowed values:
|
|
active |
Activity status. Allowed values:
|
|
sort |
Sorting index |
|
code |
Symbolic code of the property. The property code can consist of Latin letters, numbers, and underscores. The first character cannot be a digit |
|
defaultValue |
Default value of the property |
|
userType |
Custom property type. The value must correspond to the specified Value examples:
|
|
rowCount |
Number of rows in the input field |
|
colCount |
Number of columns in the input field |
|
listType |
Appearance of the list. Allowed values:
|
|
multiple |
Indicator of multiple values. Allowed values:
|
|
xmlId |
External identifier of the property |
|
fileType |
List of file extensions for property type |
|
multipleCnt |
Number of fields for entering multiple values |
|
linkIblockId |
Identifier of the linked information block. Available identifiers can be obtained using the catalog.catalog.list method |
|
withDescription |
Indicator of storing the description of the value. Allowed values:
|
|
searchable |
Indicator of participation in search. Allowed values:
|
|
filtrable |
Indicator of participation in filtering. Allowed values:
|
|
isRequired |
Indicator of required value. Allowed values:
|
|
hint |
Hint for the field |
|
userTypeSettings |
Settings for the custom type. Only scalar values and nested objects from scalar values are supported |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"iblockId":19,"name":"Category","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 -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"iblockId":19,"name":"Category","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
// 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)
}
<!-- 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>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.product_property.add(
fields={
"iblockId": 19,
"name": "Category",
"propertyType": "S",
"multiple": "N",
"active": "Y",
"sort": 100,
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Bitrix API error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
try {
$response = $b24Service
->core
->call(
'catalog.productProperty.add',
[
'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 directory in Bitrix24
],
],
]
);
print_r($response->getResponseData()->getResult());
} catch (\Throwable $exception) {
echo $exception->getMessage();
}
BX24.callMethod(
'catalog.productProperty.add',
{
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 directory in Bitrix24
}
}
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.log(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.productProperty.add',
[
'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 directory in Bitrix24
],
]
]
);
print_r($result);
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "catalog.productProperty.add", b24.Params{
"fields": b24.Params{
"iblockId": 19,
"name": "Category",
"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)
}
// The method wraps the response in an object with the "productProperty" key.
raw, ok := b24.Unwrap(res.Result, "productProperty")
if !ok {
return fmt.Errorf("no productProperty key in the response")
}
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("parse response: %w", err)
}
fmt.Println(item.Active, item.Code)
Response Handling
HTTP status: 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": "Category",
"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
}
}
Returned Data
|
Name |
Description |
|
result |
Root object of the response |
|
productProperty |
Object with information about the added property |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "0",
"error_description": "Invalid property type specified"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Required fields: iblockId, name, propertyType |
Required fields not provided in |
|
|
|
Access Denied |
No permission to modify the information block |
|
|
|
The specified iblock is not a product catalog |
The provided |
|
|
|
Invalid property type specified |
An invalid combination of |
|
|
|
Invalid custom property type settings specified |
An invalid format for |
|
|
|
Property code cannot start with a digit |
Invalid format for the |
|
|
|
Wrong format of field |
A parameter with a type that does not match the field format was provided |
|
|
|
Error adding property |
Internal error while creating the property |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Update Product or Variation Property catalog.productProperty.update
- Get Values of Product or Variation Property Fields catalog.productProperty.get
- Get a list of product properties or variations catalog.productProperty.list
- How to Add a Product with Custom Property Values
- Delete product property or variation catalog.productProperty.delete
- Get Product or Variation Property Fields catalog.productProperty.getFields