Update Parent Product Fields 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, a catalog view permission ("View product catalog", "View catalog products", or "Edit selling price"), and the permission to edit the catalog information block element

The catalog.product.sku.update method updates the fields of a parent product.

The method does not check the product type: with the identifier of a simple product or a variation, it updates that product and returns an empty array "sku": []. Before the call, make sure that the identifier belongs to a parent product using the catalog.product.sku.get method.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
catalog_product_sku.id

Identifier of the parent product.

You can retrieve parent product identifiers using the catalog.product.sku.list method

fields*
object

Values of the fields to update (detailed description).

The method changes only the passed fields, the other fields keep their values. The method accepts an empty {} object without an error and updates only the timestampX modification date

Parameter fields

Name
type

Description

iblockId
catalog_catalog.id

Identifier of the catalog information block. A product cannot be moved to another information block: pass the current information block of the product or do not pass the field

name
string

Name of the parent product. An empty string is not accepted

active
string

Whether the parent product is active. Possible values:

  • Y — active
  • N — inactive

The method saves any other value as N

code
string

Symbolic code

xmlId
string

External code

sort
integer

Sort index.

The method saves a value that is not a number as null without an error

iblockSectionId
catalog_section.id

Identifier of the main catalog section. To unlink the product from sections, pass null

iblockSection
catalog_section.id[]

Array of identifiers of all sections to link the parent product to

previewText
string

Preview description

previewTextType
string

Type of the preview description. Possible values:

  • text — text
  • html — HTML

The method saves any other value as text

detailText
string

Detailed description

detailTextType
string

Type of the detailed description. Possible values:

  • text — text
  • html — HTML

The method saves any other value as text

previewPicture
object

Preview image. An object in the format {"fileData": ["file_name.png", "base64_content"]}.

To delete the image, pass {"remove": "Y"}

detailPicture
object

Detailed image. An object in the format {"fileData": ["file_name.png", "base64_content"]}.

To delete the image, pass {"remove": "Y"}

createdBy
user.id

Identifier of the user who created the product

modifiedBy
user.id

Identifier of the user who modified the product. Default is the current user

propertyN
any

Product property value, where N is the property identifier, for example property303.

For a single property, pass a {"value": ...} object. The method does not save a value passed as a string or a number and clears the current property value.

For a multiple property, pass an array of values or of {"value": ..., "valueId": ...} objects:

  • the method updates a value with valueId
  • the method adds a value without valueId
  • the method deletes the values that are not in the array. An empty array clears the property

Properties that are not passed keep their current values. The catalog.product.sku.get and catalog.product.sku.list methods return the valueId of property values

The id, type, available, bundle, dateCreate, and timestampX fields cannot be changed: the method skips them without an error. The method also skips unknown fields in fields.

Currently, the dateActiveFrom and dateActiveTo activity dates cannot be changed: the method rejects any date format with the Incorrect starting date format.<br> error.

The method skips the trade catalog fields of a parent product, canBuyZero, vatId, vatIncluded, quantity, purchasingPrice, purchasingCurrency, measure, weight, length, width, and height, without an error and does not retain them in cloud Bitrix24. They can be changed only in the on-premise version with the "Enable the Commercial Catalog tab for products with SKU's" option enabled. Change the values for variations using the catalog.product.offer.update method.

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":7679,"fields":{"sort":300,"previewText":"Loose-fit cotton T-shirt","property303":{"value":"Cotton Yard"},"property305":["Cotton"]}}' \
        https://**put_your_bitrix24_address**/rest/**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":7679,"fields":{"sort":300,"previewText":"Loose-fit cotton T-shirt","property303":{"value":"Cotton Yard"},"property305":["Cotton"]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.product.sku.update
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type PropertyValue = { value: string; valueId: string }
        type Picture = { id: string; url: string; urlMachine: string }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type SkuUpdateResult = {
          sku: {
            active: string
            available: string
            bundle: string
            code: string | null
            createdBy: number
            dateActiveFrom: ISODate | null
            dateActiveTo: ISODate | null
            dateCreate: ISODate
            detailPicture: Picture | null
            detailText: string | null
            detailTextType: string
            iblockId: number
            iblockSection: number[] | null
            iblockSectionId: number | null
            id: number
            modifiedBy: number
            name: string
            previewPicture: Picture | null
            previewText: string | null
            previewTextType: string
            property303: PropertyValue | null
            property305: PropertyValue[] | null
            sort: number | null
            timestampX: ISODate
            type: number
            xmlId: string | null
          }
        }
        
        try {
          const response = await $b24.actions.v2.call.make<SkuUpdateResult>({
            method: 'catalog.product.sku.update',
            params: {
              id: 7679,
              fields: {
                sort: 300,
                previewText: 'Loose-fit cotton T-shirt',
                property303: { value: 'Cotton Yard' },
                property305: ['Cotton'],
              },
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Updated SKU product:', result.sku.id, result.sku.sort)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function updateSkuProduct() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v2.call.make({
                method: 'catalog.product.sku.update',
                params: {
                  id: 7679,
                  fields: {
                    sort: 300,
                    previewText: 'Loose-fit cotton T-shirt',
                    property303: { value: 'Cotton Yard' },
                    property305: ['Cotton'],
                  },
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Updated SKU product:', result.sku.id, result.sku.sort)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateSkuProduct)
        </script>
        
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.product.sku.update(
                bitrix_id=7679,
                fields={
                    "sort": 300,
                    "previewText": "Loose-fit cotton T-shirt",
                    "property303": {"value": "Cotton Yard"},
                    "property305": ["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}")
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.product.sku.update',
                    [
                        'id'     => 7679,
                        'fields' => [
                            'sort'        => 300,
                            'previewText' => 'Loose-fit cotton T-shirt',
                            'property303' => ['value' => 'Cotton Yard'],
                            'property305' => ['Cotton'],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $e->getMessage();
        }
        
BX24.callMethod(
            'catalog.product.sku.update',
            {
                id: 7679,
                fields: {
                    sort: 300,
                    previewText: 'Loose-fit cotton T-shirt',
                    property303: { value: 'Cotton Yard' },
                    property305: ['Cotton'],
                },
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'catalog.product.sku.update',
            [
                'id' => 7679,
                'fields' => [
                    'sort' => 300,
                    'previewText' => 'Loose-fit cotton T-shirt',
                    'property303' => ['value' => 'Cotton Yard'],
                    'property305' => ['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": 7679,
        	"fields": b24.Params{
        		"sort":        300,
        		"previewText": "Loose-fit cotton T-shirt",
        		"property303": b24.Params{"value": "Cotton Yard"},
        		"property305": []string{"Cotton"},
        	},
        })
        if err != nil {
        	return fmt.Errorf("catalog.product.sku.update: %w", err)
        }
        
        // The method wraps the response in an object with the "sku" key.
        raw, ok := b24.Unwrap(res.Result, "sku")
        if !ok {
        	return fmt.Errorf("no sku key in the response")
        }
        
        // Optional fields can be null, so pointers are used for them.
        type propertyValue struct {
        	Value   string `json:"value"`
        	ValueID string `json:"valueId"`
        }
        var item struct {
        	ID          b24.ID          `json:"id"`
        	Name        string          `json:"name"`
        	Sort        *int            `json:"sort"`
        	PreviewText *string         `json:"previewText"`
        	TimestampX  string          `json:"timestampX"`
        	Property303 *propertyValue  `json:"property303"`
        	Property305 []propertyValue `json:"property305"`
        }
        if err := json.Unmarshal(raw, &item); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(item.ID, item.TimestampX)
        

Response Handling

HTTP status: 200

{
            "result": {
                "sku": {
                    "active": "Y",
                    "available": "N",
                    "bundle": "N",
                    "code": "basic-t-shirt",
                    "createdBy": 1269,
                    "dateActiveFrom": null,
                    "dateActiveTo": null,
                    "dateCreate": "2026-11-05T18:38:10+01:00",
                    "detailPicture": null,
                    "detailText": "<p>T-shirt made of 100% cotton</p>",
                    "detailTextType": "html",
                    "iblockId": 25,
                    "iblockSection": [
                        31
                    ],
                    "iblockSectionId": 31,
                    "id": 7679,
                    "modifiedBy": 1269,
                    "name": "Basic T-shirt",
                    "previewPicture": null,
                    "previewText": "Loose-fit cotton T-shirt",
                    "previewTextType": "text",
                    "property303": {
                        "value": "Cotton Yard",
                        "valueId": "4117"
                    },
                    "property305": [
                        {
                            "value": "Cotton",
                            "valueId": "4119"
                        }
                    ],
                    "sort": 300,
                    "timestampX": "2026-11-05T18:38:23+01:00",
                    "type": 6,
                    "xmlId": "tshirt-basic-01"
                }
            },
            "time": {
                "start": 1793893103,
                "finish": 1793893103.99537,
                "duration": 0.9953699111938477,
                "processing": 0,
                "date_start": "2026-11-05T18:38:23+01:00",
                "date_finish": "2026-11-05T18:38:23+01:00",
                "operating_reset_at": 1793893680,
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Root element of the response

result.sku
catalog_product_sku

Object with all parent product fields after the update.

The response contains all information block properties as propertyN keys, empty properties have the null value. The example shows only the property303 and property305 properties.

If id belongs to a simple product or a variation, the method updates the product and returns an empty array []

time
time

Information about the execution time of the request

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "sku does not exist."
        }
        

Name
type

Description

error
string

String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

Possible Error Codes

Status

Code

Description

Value

400

200040300010

Access Denied

The user does not have a permission to view the catalog

400

200040300040

Access Denied

The user does not have the "Edit product" permission

400

200040300043

Access Denied

The user does not have the permission to edit the catalog information block element

400

200040300050

Access Denied

The section from iblockSectionId does not exist, or the user does not have the permission to link products to it

400

Empty value

sku does not exist.

No product exists with the specified id. The method returns the same error if id is a string that is not a number

400

100

Could not find value for parameter

The id parameter is not provided

400

100

Could not find value for parameter

The fields parameter is not provided

400

100

Invalid value {abc} to match with parameter {fields}. Should be value of type array.

fields is not an object

400

0

iblock is not catalog

iblockId contains an information block that is not a trade catalog

400

0

productType is not allowed for this catalog

iblockId contains the variation information block

400

0

Name is not specified.

name is an empty string

400

0

Wrong format of field name.

The field contains an array or an object instead of a value. The text contains the field name

400

0

User createdBy is not exists

The user from createdBy is not found. For modifiedBy, the error is User modifiedBy is not exists

400

0

Incorrect starting date format.

The dateActiveFrom field is passed. For dateActiveTo, the error is Incorrect expiration date format.<br>

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