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: catalog

Who 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
type

Description

id*
integer

Product identifier.

The identifier can be retrieved using the catalog.product.list method or from the catalog.product.add response

fields*
object

An object with the product fields to update. Pass only the fields you want to change. Field description

An empty object {} returns the product unchanged

Parameter fields

Name
type

Description

iblockId
integer

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
string

Product name

code
string

Symbolic code

xmlId
string

External code. Can be used for synchronization with an external system

active
string

Product activity.

Possible values:

  • Y — active
  • N — inactive

Other values are saved as N

sort
integer

Sort order

createdBy
integer

Identifier of the user who created the product. The identifier can be retrieved using the user.get method

modifiedBy
integer

Identifier of the user who modified the product

dateActiveFrom
datetime

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 null is accepted

dateActiveTo
datetime

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 null is accepted

previewText
string

Preview text

previewTextType
string

Preview text type.

Possible values:

  • text — text
  • html — HTML

previewPicture
object

Preview picture. Currently, the file cannot be uploaded or deleted with REST 3.0 methods: a value in the {"fileData": ["name.png", "base64"]} format passes validation, but the file is not saved. Upload the file using the previous version method catalog.product.update

detailText
string

Detail text

detailTextType
string

Detail text type.

Possible values:

  • text — text
  • html — HTML

detailPicture
object

Detail picture. Currently, the file cannot be uploaded or deleted with REST 3.0 methods: a value in the {"fileData": ["name.png", "base64"]} format passes validation, but the file is not saved. Upload the file using the previous version method catalog.product.update

iblockSectionId
integer

Identifier of the main section. The identifier can be retrieved using the catalog.section.list method

iblockSection
array

An array of identifiers of the sections to link the product to, for example [41, 39]. Set the main section in iblockSectionId

quantity
double

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
double

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
string

Quantity tracking mode.

Possible values:

  • Y — enabled
  • N — disabled
  • D — the value from the Trade Catalog module settings

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
string

Allow purchase when the product is out of stock.

Possible values:

  • Y — yes
  • N — no
  • D — the value from the Trade Catalog module settings

subscribe
string

Allow subscription to the product.

Possible values:

  • Y — yes
  • N — no
  • D — the value from the Trade Catalog module settings

vatId
integer

VAT rate identifier. The identifier can be retrieved using the catalog.vat.list method

vatIncluded
string

VAT is included in the price.

Possible values:

  • Y — yes
  • N — no

purchasingPrice
double

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
string

Purchase price currency, for example EUR. When inventory management is enabled, the value is not saved: the method does not return an error, but the field keeps its previous value

barcodeMulti
string

Unique barcode for each item.

Possible values:

  • Y — yes
  • N — no

weight
double

Weight

length
double

Length

width
double

Width

height
double

Height

measure
integer

Unit of measurement identifier. The identifier can be retrieved using the catalog.measure.list method

recurSchemeLength
integer

Payment period length. Used only in the on-premise version for content sales

recurSchemeType
string

Time unit of the payment period. Used only in the on-premise version for content sales

trialPriceId
integer

Identifier of the product for trial payment. Used only in the on-premise version for content sales

withoutOrder
string

Renewal without placing an order. Used only in the on-premise version for content sales

quantityTraceRaw
string

Quantity tracking mode including the module settings: Y, N, or D

paymentType
string

Payment type. Used only in the on-premise version for content sales

subscribeRaw
string

Subscription permission including the module settings: Y, N, or D

canBuyZeroRaw
string

Permission to purchase an out-of-stock product including the module settings: Y, N, or D

properties
object

Product property values to update. The key is PROPERTY_{id}, where id is the property identifier. Properties that are not passed are not changed.

Pass the value of a single property as an object {"VALUE": "TS-002"}. If you pass a string or a number without an object, the method does not change the property value and does not return an error.

Pass the values of a multiple property as an array, for example ["Cotton", "Linen"]: it replaces all current values. To change one value and keep its identifier, pass an object with VALUE_ID, for example {"VALUE": "Linen", "VALUE_ID": "3995"}. Value identifiers are returned by the catalog.product.get method.

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
type

Description

result
object

An object with the response data

result.item
object

Product fields after the update. Field description

time
time

Information about the request execution time

Item Object

Name
type

Description

id
integer

Product identifier

iblockId
integer

Identifier of the trade catalog information block

name
string

Product name

code
string or null

Symbolic code

xmlId
string

External code. If not set on creation, it matches id

active
string

Product activity: Y — active, N — inactive

sort
integer

Sort order

createdBy
integer

Identifier of the user who created the product

modifiedBy
integer

Identifier of the user who last modified the product

dateCreate
datetime

Creation date and time in ISO 8601 format

timestampX
datetime

Date and time of the last modification in ISO 8601 format

dateActiveFrom
datetime or null

Activity start date

dateActiveTo
datetime or null

Activity end date

previewText
string or null

Preview text

previewTextType
string

Preview text type: text — text, html — HTML

previewPicture
string or null

Identifier of the preview picture file. The file can be retrieved using the catalog.product.download method

detailText
string or null

Detail text

detailTextType
string

Detail text type: text — text, html — HTML

detailPicture
string or null

Identifier of the detail picture file. The file can be retrieved using the catalog.product.download method

iblockSectionId
integer or null

Identifier of the product's main section

iblockSection
array

An array of identifiers of all sections the product is linked to

type
integer

Product type. The list of types is returned by the catalog.product.type.list method. For a product created with catalog.product.add, the value is 1

available
string

Availability for purchase: Y — available, N — unavailable

bundle
string

Bundle flag: Y — yes, N — no

quantity
double

Available quantity

quantityReserved
double

Reserved quantity

quantityTrace
string

Effective quantity tracking mode: Y — enabled, N — disabled

canBuyZero
string

Effective permission to purchase an out-of-stock product: Y — yes, N — no

subscribe
string

Effective permission to subscribe to the product: Y — yes, N — no

vatId
integer or null

VAT rate identifier

vatIncluded
string

VAT is included in the price: Y — yes, N — no

purchasingPrice
double or null

Purchase price

purchasingCurrency
string or null

Purchase price currency

barcodeMulti
string

Unique barcode for each item: Y — yes, N — no

weight
double

Weight

length
double or null

Length

width
double or null

Width

height
double or null

Height

measure
integer or null

Unit of measurement identifier

recurSchemeLength
integer or null

Payment period length. Used only in the on-premise version for content sales

recurSchemeType
string

Time unit of the payment period. Used only in the on-premise version for content sales

trialPriceId
integer or null

Identifier of the product for trial payment. Used only in the on-premise version for content sales

withoutOrder
string

Renewal without placing an order: Y — yes, N — no. Used only in the on-premise version for content sales

quantityTraceRaw
string

Saved value of the quantity tracking mode: Y, N, or D — the value from the module settings

paymentType
string

Payment type. Used only in the on-premise version for content sales

subscribeRaw
string

Saved value of the subscription permission: Y, N, or D — the value from the module settings

canBuyZeroRaw
string

Saved value of the permission to purchase an out-of-stock product: Y, N, or D — the value from the module settings

properties
object

Product property values. The key is PROPERTY_{id}, where id is the property identifier. The response contains all properties of the information block.

Key value:

  • null — the value is not filled in
  • an object {"VALUE": ..., "VALUE_ID": ...} — the value of a single property and the identifier of this value
  • an array of such objects — the values of a multiple property

For a "File" type property, VALUE returns the file identifier

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
                "message": "Entity with ID 99999999 was not found."
            }
        }
        

Name
type

Description

error.code
string

String error code. Use it to identify the type of exception

error.message
string

Text description of the error

error.validation
array

Array with error details. Present only in data validation errors BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Name of the field where the validation error occurred

error.validation[].message
string

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 id. This message comes with a second one: "Only one of the following values must be provided: id, filter"

fields

Required field fields is missing

Pass the fields object

-

Product - #ID# is not exists in catalog - #IBLOCK_ID#

Do not pass iblockId, or pass the current information block of the product

-

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 PROPERTY_{id} format in properties

-

The properties field names one property by several keys: #KEYS#

Specify each property with one key, for example only PROPERTY_301

dateActiveFrom

Wrong format of field dateActiveFrom.

Currently, the date cannot be set with REST 3.0 methods. Pass null or do not pass the field

dateActiveFrom

This request requires data type DateTime in field dateActiveFrom

Currently, the date cannot be set with REST 3.0 methods. Pass null or do not pass the field

sort

This request requires data type int in field sort

Pass an integer

Object Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field

Error description

How to Fix

#FIELD#

Field #FIELD# is read-only

Remove the id, type, available, bundle, dateCreate, timestampX fields from fields

Object Not Found Error

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field

Error description

How to Fix

id

Entity with ID #ID# was not found

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

filter

Invalid filter filter

The method does not support filter. Pass the product id

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

fields

Unknown field #FIELD# found in entity ProductDto

Pass only the fields from the Parameter fields table in fields. Pass property values in properties

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 iblockSectionId that does not exist in the 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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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