Add Product or Variation Property v 3.0 catalog.product.property.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: a user with the "View product catalog" permission and permission to edit the catalog information block
The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The catalog.product.property.add method adds a string property of a product or variation to the trade catalog.
Only id and controlId are filled in the response; the other fields are returned as null. The saved property values can be retrieved using the catalog.productProperty.get method.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
An object with the fields of the new property. Field description |
Parameter fields
|
Name |
Description |
|
iblockId* |
Identifier of the trade catalog to which the property is added. For a product property, pass the product catalog; for a variation property, pass the variation catalog. The identifier can be retrieved using the catalog.catalog.list method. The method does not check that the information block is a trade catalog and adds the property to any existing information block |
|
name* |
Property name. An empty string causes a validation error |
|
code |
Symbolic code of the property, for example |
|
sort |
Sort order. Default: |
|
multiple |
Multiple property. Possible values:
Any other string value is saved as Default: |
|
isRequired |
Required property. Possible values:
Default: |
The property type cannot be set: the method always creates a string property.
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/catalog.product.property.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"iblockId":25,"name":"Material","code":"MATERIAL","sort":500,"multiple":"N","isRequired":"N"}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.property.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"iblockId":25,"name":"Material","code":"MATERIAL","sort":500,"multiple":"N","isRequired":"N"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.product.property.add
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type ProductPropertyAddResult = {
item: {
id: number
iblockId: number | null
name: string | null
sort: number | null
code: string | null
multiple: string | null
isRequired: string | null
controlId: string
}
}
try {
const response = await $b24.actions.v3.call.make<ProductPropertyAddResult>({
method: 'catalog.product.property.add',
params: {
fields: {
iblockId: 25,
name: 'Material',
code: 'MATERIAL',
sort: 500,
multiple: 'N',
isRequired: 'N',
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Property created:', result.item.id, result.item.controlId)
}
} 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 addProductProperty() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.product.property.add',
params: {
fields: {
iblockId: 25,
name: 'Material',
code: 'MATERIAL',
sort: 500,
multiple: 'N',
isRequired: 'N',
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Property created:', result.item.id, result.item.controlId)
} 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": 25,
"name": "Material",
"code": "MATERIAL",
"sort": 500,
"multiple": "N",
"isRequired": "N",
},
).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}")
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
try {
$response = $b24Service
->core
->call(
'catalog.product.property.add',
[
'fields' => [
'iblockId' => 25,
'name' => 'Material',
'code' => 'MATERIAL',
'sort' => 500,
'multiple' => 'N',
'isRequired' => 'N',
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
BX24.callMethod(
'catalog.product.property.add',
{
fields: {
iblockId: 25,
name: 'Material',
code: 'MATERIAL',
sort: 500,
multiple: 'N',
isRequired: 'N',
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
require_once('crest.php');
$result = CRest::call(
'catalog.product.property.add',
[
'fields' => [
'iblockId' => 25,
'name' => 'Material',
'code' => 'MATERIAL',
'sort' => 500,
'multiple' => 'N',
'isRequired' => 'N',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "catalog.product.property.add", b24.Params{
"fields": b24.Params{
"iblockId": 25,
"name": "Material",
"code": "MATERIAL",
"sort": 500,
"multiple": "N",
"isRequired": "N",
},
})
if err != nil {
return fmt.Errorf("catalog.product.property.add: %w", err)
}
// The method wraps the response in an object with the "item" key.
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("no item key in the response")
}
var item struct {
ID int `json:"id"`
ControlID string `json:"controlId"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.ControlID)
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": 1231,
"iblockId": null,
"name": null,
"sort": null,
"code": null,
"multiple": null,
"isRequired": null,
"controlId": "PROPERTY_1231"
}
},
"time": {
"start": 1792660313,
"finish": 1792660313.118533,
"duration": 0.11853289604187012,
"processing": 0,
"date_start": "2026-10-22T12:11:53+02:00",
"date_finish": "2026-10-22T12:11:53+02:00",
"operating_reset_at": 1792660860,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
An object with the response data |
|
result.item |
Fields of the created property. Field description |
|
time |
Information about the request execution time |
Item Object
|
Name |
Description |
|
id |
Identifier of the created property |
|
iblockId |
Information block identifier. Always |
|
name |
Property name. Always |
|
sort |
Sort order. Always |
|
code |
Symbolic code. Always |
|
multiple |
Multiple property flag. Always |
|
isRequired |
Required property flag. Always |
|
controlId |
Name of the property field in the information block forms in the |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
"message": "Error validating object.",
"validation": [
{
"message": "Required field \"name\" is empty.",
"field": "name"
}
]
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Object Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass |
|
|
Required field |
Pass |
|
|
Field |
Remove |
|
|
Field |
Remove |
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Required field |
Pass the |
|
|
This request requires data type |
Pass a number |
|
|
This request requires data type |
Pass an integer |
|
|
This request requires data type |
Pass the string |
|
|
This request requires data type |
Pass the string |
|
|
Name is not specified. |
Pass a non-empty string in |
|
|
Iblock Not Found |
The information block was not found. Check the identifier using the catalog.catalog.list method |
Unknown Field Error
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Pass only |
Access Error
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Access denied |
Make sure the user has the "View product catalog" permission and permission to edit the catalog information block |
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
- Get List of Product Property Fields v 3.0 catalog.product.property.field.list
- Get List of Product Property Types catalog.product.property.type.list
- Get Values of Product or Variation Property Fields catalog.productProperty.get
- Get a list of product properties or variations catalog.productProperty.list