Update Product v 3.0 catalog.product.update
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 "Edit product" permission and one of the following permissions: "View product catalog", "View catalog products", or "Edit selling price"
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.update method updates product fields and returns the product with all its fields.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Product identifier. The identifier can be retrieved using the catalog.product.list method or from the catalog.product.add response |
|
fields* |
An object with the product fields to update. Pass only the fields you want to change. Field description An empty object |
Parameter fields
|
Name |
Description |
|
iblockId |
Identifier of the trade catalog information block. The product's information block cannot be changed: a value different from the current one causes an error |
|
name |
Product name |
|
code |
Symbolic code |
|
xmlId |
External code. Can be used for synchronization with an external system |
|
active |
Product activity. Possible values:
Other values are saved as |
|
sort |
Sort order |
|
createdBy |
Identifier of the user who created the product. The identifier can be retrieved using the user.get method |
|
modifiedBy |
Identifier of the user who modified the product |
|
dateActiveFrom |
Activity start date. Currently, the date cannot be set with REST 3.0 methods: a value in ISO 8601 format causes the "Wrong format of field" error, and values in other formats cause a data type error. Only |
|
dateActiveTo |
Activity end date. Currently, the date cannot be set with REST 3.0 methods: a value in ISO 8601 format causes the "Wrong format of field" error, and values in other formats cause a data type error. Only |
|
previewText |
Preview text |
|
previewTextType |
Preview text type. Possible values:
|
|
previewPicture |
Preview picture. Currently, the file cannot be uploaded or deleted with REST 3.0 methods: a value in the |
|
detailText |
Detail text |
|
detailTextType |
Detail text type. Possible values:
|
|
detailPicture |
Detail picture. Currently, the file cannot be uploaded or deleted with REST 3.0 methods: a value in the |
|
iblockSectionId |
Identifier of the main section. The identifier can be retrieved using the catalog.section.list method |
|
iblockSection |
An array of identifiers of the sections to link the product to, for example |
|
quantity |
Available quantity. When inventory management is enabled, the value is not saved: the method does not return an error, but the field keeps its previous value |
|
quantityReserved |
Reserved quantity. When inventory management is enabled, the value is not saved: the method does not return an error, but the field keeps its previous value |
|
quantityTrace |
Quantity tracking mode. Possible values:
When inventory management is enabled, the value is not saved: the method does not return an error, but the field keeps its previous value |
|
canBuyZero |
Allow purchase when the product is out of stock. Possible values:
|
|
subscribe |
Allow subscription to the product. Possible values:
|
|
vatId |
VAT rate identifier. The identifier can be retrieved using the catalog.vat.list method |
|
vatIncluded |
VAT is included in the price. Possible values:
|
|
purchasingPrice |
Purchase price. When inventory management is enabled, the value is not saved: the method does not return an error, but the field keeps its previous value |
|
purchasingCurrency |
Purchase price currency, for example |
|
barcodeMulti |
Unique barcode for each item. Possible values:
|
|
weight |
Weight |
|
length |
Length |
|
width |
Width |
|
height |
Height |
|
measure |
Unit of measurement identifier. The identifier can be retrieved using the catalog.measure.list method |
|
recurSchemeLength |
Payment period length. Used only in the on-premise version for content sales |
|
recurSchemeType |
Time unit of the payment period. Used only in the on-premise version for content sales |
|
trialPriceId |
Identifier of the product for trial payment. Used only in the on-premise version for content sales |
|
withoutOrder |
Renewal without placing an order. Used only in the on-premise version for content sales |
|
quantityTraceRaw |
Quantity tracking mode including the module settings: |
|
paymentType |
Payment type. Used only in the on-premise version for content sales |
|
subscribeRaw |
Subscription permission including the module settings: |
|
canBuyZeroRaw |
Permission to purchase an out-of-stock product including the module settings: |
|
properties |
Product property values to update. The key is Pass the value of a single property as an object Pass the values of a multiple property as an array, for example Properties of the "File" type are currently not saved |
The id, type, available, bundle, dateCreate, and timestampX fields are filled in automatically. If you pass them in fields, the method returns an error.
Currently, REST 3.0 methods do not save product files: the previewPicture and detailPicture pictures and values of "File" type properties. Upload the files using the previous version method catalog.product.update.
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.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":7549,"fields":{"name":"Basic T-shirt, white","sort":100,"properties":{"PROPERTY_301":{"VALUE":"TS-001-W"}}}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":7549,"fields":{"name":"Basic T-shirt, white","sort":100,"properties":{"PROPERTY_301":{"VALUE":"TS-001-W"}}},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.product.update
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type ProductResult = {
item: {
id: number
iblockId: number
name: string
code: string | null
active: 'Y' | 'N'
iblockSectionId: number | null
type: number
vatId: number | null
measure: number | null
dateCreate: ISODate
properties: Record<string, { VALUE: string, VALUE_ID: string } | Array<{ VALUE: string, VALUE_ID: string }> | null>
}
}
try {
const response = await $b24.actions.v3.call.make<ProductResult>({
method: 'catalog.product.update',
params: {
id: 7549,
fields: {
name: 'Basic T-shirt, white',
sort: 100,
properties: {
PROPERTY_301: {
VALUE: 'TS-001-W',
},
},
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Product 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 product() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.product.update',
params: {
id: 7549,
fields: {
name: 'Basic T-shirt, white',
sort: 100,
properties: {
PROPERTY_301: {
VALUE: 'TS-001-W',
},
},
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Product updated:', result.item.id, result.item.name)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', product)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.product.update(
bitrix_id=7549,
fields={
"name": "Basic T-shirt, white",
"sort": 100,
"properties": {
"PROPERTY_301": {
"VALUE": "TS-001-W",
},
},
},
).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.update',
[
'id' => 7549,
'fields' => [
'name' => 'Basic T-shirt, white',
'sort' => 100,
'properties' => [
'PROPERTY_301' => [
'VALUE' => 'TS-001-W',
],
],
],
]
);
$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.update',
{
id: 7549,
fields: {
name: 'Basic T-shirt, white',
sort: 100,
properties: {
PROPERTY_301: {
VALUE: 'TS-001-W',
},
},
},
},
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.update',
[
'id' => 7549,
'fields' => [
'name' => 'Basic T-shirt, white',
'sort' => 100,
'properties' => [
'PROPERTY_301' => [
'VALUE' => 'TS-001-W',
],
],
],
]
);
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.update", b24.Params{
"id": 7549,
"fields":b24.Params{
"name": "Basic T-shirt, white",
"sort": 100,
"properties":b24.Params{
"PROPERTY_301":b24.Params{
"VALUE":"TS-001-W",
},
},
},
})
if err != nil {
return fmt.Errorf("catalog.product.update: %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"`
Name string `json:"name"`
Type int `json:"type"`
Properties map[string]json.RawMessage `json:"properties"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println(item.ID, item.Name)
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": 7549,
"iblockId": 25,
"name": "Basic T-shirt, white",
"code": "tshirt-basic",
"xmlId": "7549",
"active": "Y",
"sort": 100,
"createdBy": 1,
"modifiedBy": 1,
"dateCreate": "2026-10-22T12:17:25+02:00",
"timestampX": "2026-10-22T12:17:26+02:00",
"dateActiveFrom": null,
"dateActiveTo": null,
"previewText": "Cotton T-shirt",
"previewTextType": "text",
"previewPicture": null,
"detailText": null,
"detailTextType": "text",
"detailPicture": null,
"iblockSectionId": 41,
"iblockSection": [
41
],
"type": 1,
"available": "Y",
"bundle": "N",
"quantity": 0,
"quantityReserved": 0,
"quantityTrace": "Y",
"canBuyZero": "Y",
"subscribe": "Y",
"vatId": 1,
"vatIncluded": "Y",
"purchasingPrice": null,
"purchasingCurrency": null,
"barcodeMulti": "N",
"weight": 0,
"length": null,
"width": null,
"height": null,
"measure": 9,
"recurSchemeLength": null,
"recurSchemeType": "D",
"trialPriceId": null,
"withoutOrder": "N",
"quantityTraceRaw": "D",
"paymentType": "S",
"subscribeRaw": "D",
"canBuyZeroRaw": "D",
"properties": {
"PROPERTY_301": {
"VALUE": "TS-001-W",
"VALUE_ID": "4009"
},
"PROPERTY_303": null,
"PROPERTY_305": [
{
"VALUE": "Cotton",
"VALUE_ID": "4005"
},
{
"VALUE": "Polyester",
"VALUE_ID": "4007"
}
],
"PROPERTY_359": null
}
}
},
"time": {
"start": 1792660646,
"finish": 1792660646.862908,
"duration": 0.862907886505127,
"processing": 0,
"date_start": "2026-10-22T12:17:26+02:00",
"date_finish": "2026-10-22T12:17:26+02:00",
"operating_reset_at": 1792660980,
"operating": 4.309731721878052
}
}
In the response, properties contains all properties of the information block. The example shows some of them.
Returned Data
|
Name |
Description |
|
result |
An object with the response data |
|
result.item |
Product fields after the update. Field description |
|
time |
Information about the request execution time |
Item Object
|
Name |
Description |
|
id |
Product identifier |
|
iblockId |
Identifier of the trade catalog information block |
|
name |
Product name |
|
code |
Symbolic code |
|
xmlId |
External code. If not set on creation, it matches |
|
active |
Product activity: |
|
sort |
Sort order |
|
createdBy |
Identifier of the user who created the product |
|
modifiedBy |
Identifier of the user who last modified the product |
|
dateCreate |
Creation date and time in ISO 8601 format |
|
timestampX |
Date and time of the last modification in ISO 8601 format |
|
dateActiveFrom |
Activity start date |
|
dateActiveTo |
Activity end date |
|
previewText |
Preview text |
|
previewTextType |
Preview text type: |
|
previewPicture |
Identifier of the preview picture file. The file can be retrieved using the catalog.product.download method |
|
detailText |
Detail text |
|
detailTextType |
Detail text type: |
|
detailPicture |
Identifier of the detail picture file. The file can be retrieved using the catalog.product.download method |
|
iblockSectionId |
Identifier of the product's main section |
|
iblockSection |
An array of identifiers of all sections the product is linked to |
|
type |
Product type. The list of types is returned by the catalog.product.type.list method. For a product created with |
|
available |
Availability for purchase: |
|
bundle |
Bundle flag: |
|
quantity |
Available quantity |
|
quantityReserved |
Reserved quantity |
|
quantityTrace |
Effective quantity tracking mode: |
|
canBuyZero |
Effective permission to purchase an out-of-stock product: |
|
subscribe |
Effective permission to subscribe to the product: |
|
vatId |
VAT rate identifier |
|
vatIncluded |
VAT is included in the price: |
|
purchasingPrice |
Purchase price |
|
purchasingCurrency |
Purchase price currency |
|
barcodeMulti |
Unique barcode for each item: |
|
weight |
Weight |
|
length |
Length |
|
width |
Width |
|
height |
Height |
|
measure |
Unit of measurement identifier |
|
recurSchemeLength |
Payment period length. Used only in the on-premise version for content sales |
|
recurSchemeType |
Time unit of the payment period. Used only in the on-premise version for content sales |
|
trialPriceId |
Identifier of the product for trial payment. Used only in the on-premise version for content sales |
|
withoutOrder |
Renewal without placing an order: |
|
quantityTraceRaw |
Saved value of the quantity tracking mode: |
|
paymentType |
Payment type. Used only in the on-premise version for content sales |
|
subscribeRaw |
Saved value of the subscription permission: |
|
canBuyZeroRaw |
Saved value of the permission to purchase an out-of-stock product: |
|
properties |
Product property values. The key is Key value:
For a "File" type property, |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
"message": "Entity with ID 99999999 was not found."
}
}
|
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
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
At least one of the required fields must be not empty: id, filter |
Pass the product |
|
|
Required field |
Pass the |
|
|
Product - #ID# is not exists in catalog - #IBLOCK_ID# |
Do not pass |
|
|
VAT vatId is not exists |
Pass the identifier of an existing VAT rate |
|
|
Currency purchasingCurrency is not exists |
Pass the code of an existing currency |
|
|
User createdBy is not exists |
Pass the identifier of an existing user |
|
|
User modifiedBy is not exists |
Pass the identifier of an existing user |
|
|
The properties field accepts only the property keys PROPERTY_{id}, unknown keys: #KEYS# |
Pass only keys in the |
|
|
The properties field names one property by several keys: #KEYS# |
Specify each property with one key, for example only |
|
|
Wrong format of field |
Currently, the date cannot be set with REST 3.0 methods. Pass |
|
|
This request requires data type |
Currently, the date cannot be set with REST 3.0 methods. Pass |
|
|
This request requires data type |
Pass an integer |
Object Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Field |
Remove the |
Object Not Found Error
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Entity with ID |
Check the identifier using the catalog.product.list method |
Filter Format Error
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Invalid filter |
The method does not support |
Unknown Field Error
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Pass only the fields from the Parameter fields table in |
Access Error
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
HTTP status: 403
|
Field |
Error description |
How to Fix |
|
|
Access denied |
Make sure the user has the "Edit product" permission and permission to modify information block elements. The error is also caused by a section in |
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 |