Update Parent Product Fields v 3.0 catalog.product.sku.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" access 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 method catalog.product.sku.update updates parent product fields and returns its fields after the update.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Parent product identifier.

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

fields*
object

Object with the parent product fields to update. Pass only the fields being changed. Field description

An empty {} object returns the data without changes

Parameter fields

Name `type`	Description
iblockId `integer`	Identifier of the product catalog information block. The information block cannot be changed: you can pass only the current value
name `string`	Parent product name
code `string`	Symbolic code
xmlId `string`	External code. If not passed on creation, it matches `id`
active `string`	Activity. Possible values: `Y` — active `N` — inactive Any value other than `Y` is saved as `N`. Default: `Y`
sort `integer`	Sort index. Default: `500`
createdBy `integer`	Identifier of the user who created the record. The identifier can be retrieved using the user.get method
modifiedBy `integer`	Identifier of the user who modified the record. Defaults to the current user
dateActiveFrom `datetime`	Activity start date in ISO 8601 format
dateActiveTo `datetime`	Activity end date in ISO 8601 format
previewText `string`	Preview description
previewTextType `string`	Preview description type. Possible values: `text` — text `html` — HTML Default: `text`
previewPicture `object`	Preview picture. The method does not currently save the field value, see the warning below for details
detailText `string`	Detailed description
detailTextType `string`	Detailed description type. Possible values: `text` — text `html` — HTML Default: `text`
detailPicture `object`	Detail picture. The method does not currently save the field value, see the warning below for details
iblockSectionId `integer`	Identifier of the main section. The identifier can be retrieved using the catalog.section.list method. For a non-existent section, the method returns an access error
iblockSection `array`	Array of identifiers of all sections to link the product to
quantity `double`	Available quantity. The value is not saved when inventory management is enabled
quantityReserved `double`	Reserved quantity
quantityTrace `string`	Quantity tracking. Possible values: `Y` — enabled `N` — disabled Always `Y` when inventory management is enabled
canBuyZero `string`	Allow purchase when the product is out of stock. Possible values: `Y` — yes `N` — no The value is not saved for a parent product
subscribe `string`	Allow subscription to the product. Possible values: `Y` — yes `N` — no
vatId `integer`	VAT rate identifier. The identifier can be retrieved using the catalog.vat.list method
vatIncluded `string`	Whether VAT is included in the price. Possible values: `Y` — yes `N` — no
purchasingPrice `double`	Purchase price. The value is not saved when inventory management is enabled
purchasingCurrency `string`	Purchase price currency, for example `EUR`. The list of currencies can be retrieved using the crm.currency.list method. The value is not saved when inventory management is enabled
barcodeMulti `string`	Unique barcodes 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`	Product for trial payment. Used only in the on-premise version for content sales
withoutOrder `string`	Renewal without placing an order: `Y` or `N`. Used only in the on-premise version for content sales
quantityTraceRaw `string`	Quantity tracking, taking the default value into account. Possible values: `Y` — enabled `N` — disabled `D` — according to the module settings
paymentType `string`	Payment type. Possible values: `S` — one-time `R` — recurring `T` — trial Used only in the on-premise version for content sales
subscribeRaw `string`	Subscription to the product, taking the default value into account. Possible values: `Y` — allowed `N` — not allowed `D` — according to the module settings
canBuyZeroRaw `string`	Purchase when out of stock, taking the default value into account. Possible values: `Y` — allowed `N` — not allowed `D` — according to the module settings
properties `object`	Values of the properties to update. The key is `PROPERTY_{id}`, where `{id}` is the property identifier. Pass the value as a `{"VALUE": ...}` object or an array of such objects. The method does not save a value passed as a string or a number. Properties that are not passed keep their current values

The method accepts the previewPicture and detailPicture fields in the {"fileData": ["file_name", "base64_content"]} and {"remove": "Y"} formats, but does not currently save them: the picture is neither added nor removed, and no error occurs. Add product images using the catalog.product.image.add method.

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.sku.update

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":7553,"fields":{"name":"DOCS-V3-SKU Cotton T-shirt","detailText":"Composition: 100% cotton"}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.product.sku.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":7553,"fields":{"name":"DOCS-V3-SKU Cotton T-shirt","detailText":"Composition: 100% cotton"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.product.sku.update

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type SkuUpdateResult = {
          item: {
            id: number
            name: string
            timestampX: ISODate
          }
        }
        
        try {
          const response = await $b24.actions.v3.call.make<SkuUpdateResult>({
            method: 'catalog.product.sku.update',
            params: {
              id: 7553,
              fields: {
                name: 'DOCS-V3-SKU Cotton T-shirt',
                detailText: 'Composition: 100% cotton',
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('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 updateSku() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.product.sku.update',
                params: {
                  id: 7553,
                  fields: {
                    name: 'DOCS-V3-SKU Cotton T-shirt',
                    detailText: 'Composition: 100% cotton',
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Updated:', result.item.id, result.item.name)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateSku)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.product.sku.update(
                id=7553,
                fields={
                    "name": "DOCS-V3-SKU Cotton T-shirt",
                    "detailText": "Composition: 100% cotton",
                },
            ).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.sku.update',
                    [
                        'id' => 7553,
                        'fields' => [
                            'name' => 'DOCS-V3-SKU Cotton T-shirt',
                            'detailText' => 'Composition: 100% cotton',
                        ],
                    ]
                );
        
            $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.sku.update',
            {
                id: 7553,
                fields: {
                    name: 'DOCS-V3-SKU Cotton T-shirt',
                    detailText: 'Composition: 100% cotton',
                },
            },
            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.sku.update',
            [
                'id' => 7553,
                'fields' => [
                    'name' => 'DOCS-V3-SKU Cotton T-shirt',
                    'detailText' => 'Composition: 100% cotton',
                ],
            ]
        );
        
        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.sku.update", b24.Params{
        	"id": 7553,
        	"fields": b24.Params{
        		"name": "DOCS-V3-SKU Cotton T-shirt",
        		"detailText": "Composition: 100% cotton",
        	},
        })
        if err != nil {
        	return fmt.Errorf("catalog.product.sku.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("the response has no item key")
        }
        
        var item struct {
        	ID   int    `json:"id"`
        	Name string `json:"name"`
        	Type int    `json:"type"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parsing the response: %w", err)
        }
        fmt.Println(item.ID, item.Name, item.Type)

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 7553,
                    "iblockId": 25,
                    "name": "DOCS-V3-SKU Cotton T-shirt",
                    "code": "docs-v3-sku-t-shirt",
                    "xmlId": "7553",
                    "active": "Y",
                    "sort": 100,
                    "createdBy": 1,
                    "modifiedBy": 1,
                    "dateCreate": "2026-10-22T12:18:48+02:00",
                    "timestampX": "2026-10-22T12:19:11+02:00",
                    "dateActiveFrom": null,
                    "dateActiveTo": null,
                    "previewText": "Cotton T-shirt",
                    "previewTextType": "text",
                    "previewPicture": null,
                    "detailText": "Composition: 100% cotton",
                    "detailTextType": "text",
                    "detailPicture": null,
                    "iblockSectionId": 31,
                    "iblockSection": [
                        31
                    ],
                    "type": 3,
                    "available": "Y",
                    "bundle": "N",
                    "quantity": 0,
                    "quantityReserved": 0,
                    "quantityTrace": "N",
                    "canBuyZero": "Y",
                    "subscribe": "Y",
                    "vatId": null,
                    "vatIncluded": "N",
                    "purchasingPrice": null,
                    "purchasingCurrency": null,
                    "barcodeMulti": "N",
                    "weight": 0,
                    "length": null,
                    "width": null,
                    "height": null,
                    "measure": null,
                    "recurSchemeLength": null,
                    "recurSchemeType": "D",
                    "trialPriceId": null,
                    "withoutOrder": "N",
                    "quantityTraceRaw": "N",
                    "paymentType": "S",
                    "subscribeRaw": "D",
                    "canBuyZeroRaw": "Y",
                    "properties": {
                        "PROPERTY_309": null,
                        "PROPERTY_293": null,
                        "PROPERTY_295": null,
                        "PROPERTY_297": null,
                        "PROPERTY_299": null,
                        "PROPERTY_301": null,
                        "PROPERTY_303": null,
                        "PROPERTY_305": null,
                        "PROPERTY_307": null,
                        "PROPERTY_311": null,
                        "PROPERTY_313": null,
                        "PROPERTY_315": null,
                        "PROPERTY_329": null,
                        "PROPERTY_343": null,
                        "PROPERTY_359": null,
                        "PROPERTY_431": null,
                        "PROPERTY_433": null,
                        "PROPERTY_435": null,
                        "PROPERTY_893": null,
                        "PROPERTY_897": null,
                        "PROPERTY_901": null,
                        "PROPERTY_917": null,
                        "PROPERTY_921": null,
                        "PROPERTY_931": null,
                        "PROPERTY_933": null,
                        "PROPERTY_935": null,
                        "PROPERTY_1013": null,
                        "PROPERTY_1015": null,
                        "PROPERTY_1019": null,
                        "PROPERTY_1021": null,
                        "PROPERTY_1023": null,
                        "PROPERTY_1077": null,
                        "PROPERTY_1079": null,
                        "PROPERTY_1081": null,
                        "PROPERTY_1083": null,
                        "PROPERTY_1085": null,
                        "PROPERTY_1231": null
                    }
                }
            },
            "time": {
                "start": 1792660751,
                "finish": 1792660751.329827,
                "duration": 0.32982707023620605,
                "processing": 0,
                "date_start": "2026-10-22T12:19:11+02:00",
                "date_finish": "2026-10-22T12:19:11+02:00",
                "operating_reset_at": 1792660980,
                "operating": 0.3135650157928467
            }
        }

Returned Data

Name `type`	Description
result `object`	Object with the response data
result.item `object`	Parent product fields after the update. Field description
time `time`	Information about the request execution time

Item Object

Name `type`	Description
id `integer`	Parent product identifier
iblockId `integer`	Identifier of the product catalog information block
name `string`	Parent product name
code `string` or `null`	Symbolic code
xmlId `string`	External code. If not set, it matches `id`
active `string`	Activity: `Y` — active, `N` — inactive
sort `integer`	Sort index
createdBy `integer`	Identifier of the user who created the record
modifiedBy `integer`	Identifier of the user who last modified the record
dateCreate `datetime`	Creation date and time
timestampX `datetime`	Date and time of the last modification
dateActiveFrom `datetime` or `null`	Activity start date
dateActiveTo `datetime` or `null`	Activity end date
previewText `string` or `null`	Preview description
previewTextType `string`	Preview description type: `text` or `html`
previewPicture `string` or `null`	Preview picture file identifier
detailText `string` or `null`	Detailed description
detailTextType `string`	Detailed description type: `text` or `html`
detailPicture `string` or `null`	Detail picture file identifier
iblockSectionId `integer` or `null`	Main section identifier
iblockSection `array`	Array of identifiers of all sections the product is linked to
type `integer`	Product type: `3` — parent product with variations, `6` — without variations
available `string`	Availability for purchase: `Y` — available, `N` — unavailable
bundle `string`	Whether the product has a bundle: `Y` — yes, `N` — no
quantity `double`	Available quantity
quantityReserved `double`	Reserved quantity
quantityTrace `string`	Whether quantity tracking is enabled: `Y` — yes, `N` — no
canBuyZero `string`	Whether purchase is allowed when the product is out of stock: `Y` — yes, `N` — no
subscribe `string`	Whether subscription to the product is allowed: `Y` — yes, `N` — no
vatId `integer` or `null`	VAT rate identifier
vatIncluded `string`	Whether VAT is included in the price: `Y` — yes, `N` — no
purchasingPrice `double` or `null`	Purchase price. Returned if the user has the "View purchase price" access permission
purchasingCurrency `string` or `null`	Purchase price currency. Returned if the user has the "View purchase price" access permission
barcodeMulti `string`	Unique barcodes for each item: `Y` — yes, `N` — no
weight `double` or `null`	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`	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 quantity tracking value: `Y` — yes, `N` — no, `D` — according to the module settings
paymentType `string`	Payment type: `S` — one-time, `R` — recurring, `T` — trial. Used only in the on-premise version for content sales
subscribeRaw `string`	Saved subscription value: `Y` — yes, `N` — no, `D` — according to the module settings
canBuyZeroRaw `string`	Saved value of purchase when out of stock: `Y` — yes, `N` — no, `D` — according to the module settings
properties `object`	Product property values. The keys are `PROPERTY_{id}`, where `{id}` is the property identifier. The value is `null`, a `{"VALUE": ..., "VALUE_ID": ...}` object, or an array of such objects for a multiple property

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
                "message": "Entity with ID 999999 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 `id`. A second message comes with this 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#	Remove `iblockId` from `fields` or pass the current information block of the record
`-`	The properties field accepts only the property keys PROPERTY_{id}, unknown keys: #KEYS#	Pass only keys of the `PROPERTY_{id}` form in `properties`

Object Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field	Error description	How to Fix
`#FIELD#`	Field `#FIELD#` is read-only	Remove read-only fields from `fields`: `id`, `type`, `available`, `bundle`, `dateCreate`, `timestampX`

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	The record does not exist or is not a parent product. Check the identifier using the catalog.product.sku.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 `id`

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field	Error description	How to Fix
`-`	Unknown field `#FIELD#` found in entity `ProductDto`	Pass in `fields` only the fields from the Parameter fields table

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

Field	Error description	How to Fix
`-`	Access denied	Check the user's permissions for the catalog and the information block. The error also occurs if the section from `iblockSectionId` does not exist

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

Was the article helpful?

Update Parent Product Fields

Get Parent Product Field Values

Update Parent Product Fields v 3.0 catalog.product.sku.update

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Item ObjectItem Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Object Validation ErrorsObject Validation Errors

Object Not Found ErrorObject Not Found Error

Filter Format ErrorFilter Format Error

Unknown Field ErrorUnknown Field Error

Access ErrorAccess Error

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

Parameter fields

Code Examples

Response Handling

Returned Data

Item Object

Error Handling

Possible Error Codes

Request Validation Errors

Object Validation Errors

Object Not Found Error

Filter Format Error

Unknown Field Error

Access Error

Statuses and System Error Codes

Continue Learning