Update a Product Item v 3.0 crm.[type].productrow.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: crm

Who can execute the method: a user with permission to edit the CRM item to which the product item belongs

This 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 crm.<type>.productrow.update method updates the fields of a product item and returns the product item after the write. The object type is set by the <type> segment of the method name. The method changes only the passed fields, and the product item ID stays the same.

Method Name for the Object Type

Object type

Method

Deal

crm.deal.productrow.update

Lead

crm.lead.productrow.update

Estimate

crm.quote.productrow.update

Invoice

crm.smartinvoice.productrow.update

CRM document

crm.smartdocument.productrow.update

SPA

crm.smartprocess<entityTypeId>.productrow.update, for example, crm.smartprocess1038.productrow.update

For an SPA, the method name includes the type ID entityTypeId. SPA type IDs are returned by the crm.type.list method in the entityTypeId field. An SPA has product item methods only if linking to catalog products is enabled in the type settings.

The method name is written in lowercase: crm.smartinvoice.productrow.update, not crm.smartInvoice.productRow.update. If the name is written in a different case, the method returns the "Method Not Found" error.

Method Parameters

Required parameters are marked with *

Name
type

Description

id*
integer

Product item ID.

The ID can be retrieved with the crm.<type>.productrow.list method. The product item must belong to an item of the type set in the method name

fields*
object

Object with the new field values in the format {"field": "value"}. Pass at least one field.

You can change the productId, productName, price, quantity, discountTypeId, discountRate, discountSum, taxRate, taxIncluded, measureCode, measureName, and sort fields. They are described in the fields parameter table of the crm.<type>.productrow.add method.

The ownerId field cannot be changed: a product item cannot be moved to another item. To move a product item, delete it with the crm.<type>.productrow.delete method and add it to the target item with the crm.<type>.productrow.add method

select
array

List of product item fields to return in the response, for example, ["id","price","quantity"]. The available fields are described in the product item methods overview.

Default: id only

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}/crm.smartprocess1038.productrow.update

The examples change the price and quantity of a product item in an SPA item with the type ID 1038. For a different object type, replace the method name according to the table above.

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":2411,"fields":{"price":4500,"quantity":3},"select":["id","productName","price","quantity","sort"]}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.productrow.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":2411,"fields":{"price":4500,"quantity":3},"select":["id","productName","price","quantity","sort"],"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.productrow.update
        

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make: such a call returns the SDK error JSSDK_CORE_METHOD_NOT_SUPPORT_IN_API_V3. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(ApiVersion.v3).call.

import { ApiVersion, Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type ProductRowUpdateResult = {
          item: {
            id: number
            productName: string
            price: number
            quantity: number
            sort: number
          }
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<ProductRowUpdateResult>(
            'crm.smartprocess1038.productrow.update',
            {
              id: 2411,
              fields: {
                price: 4500,
                quantity: 3,
              },
              select: ['id', 'productName', 'price', 'quantity', 'sort'],
            },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Product row updated:', result.item)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        

CRM methods are not yet included in the list of REST 3.0 methods known to $b24.actions.v3.call.make. Call the method through the REST 3.0 HTTP client — $b24.getHttpClient(B24Js.ApiVersion.v3).call.

<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function updateProductRow() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.smartprocess1038.productrow.update',
                {
                  id: 2411,
                  fields: {
                    price: 4500,
                    quantity: 3,
                  },
                  select: ['id', 'productName', 'price', 'quantity', 'sort'],
                },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Product row updated:', result.item)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', updateProductRow)
        </script>
        

b24pysdk has no ready-made wrappers for CRM methods, and the SDK sends to REST 3.0 only the methods from the Config().api_v3_methods list. Add the method to this list and call it via bitrix_token.call_method with prefer_version=3.

from b24pysdk import Config
        from b24pysdk.errors import BitrixSDKException
        from b24pysdk.errors.v3 import BitrixAPIError
        
        method = "crm.smartprocess1038.productrow.update"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={
                    "id": 2411,
                    "fields": {
                        "price": 4500,
                        "quantity": 3,
                    },
                    "select": ["id", "productName", "price", "quantity", "sort"],
                },
                prefer_version=3,
            )
            result = response["result"]
            print(result)
        except BitrixAPIError as error:
            print(
                "Bitrix API error",
                f"code: {error.code}",
                f"message: {error.error.message}",
                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(
                    'crm.smartprocess1038.productrow.update',
                    [
                        'id' => 2411,
                        'fields' => [
                            'price' => 4500,
                            'quantity' => 3,
                        ],
                        'select' => ['id', 'productName', 'price', 'quantity', 'sort'],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            print_r($result);
        } catch (Throwable $e) {
            echo $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(
            'crm.smartprocess1038.productrow.update',
            {
                id: 2411,
                fields: {
                    price: 4500,
                    quantity: 3,
                },
                select: ['id', 'productName', 'price', 'quantity', 'sort'],
            },
            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(
            'crm.smartprocess1038.productrow.update',
            [
                'id' => 2411,
                'fields' => [
                    'price' => 4500,
                    'quantity' => 3,
                ],
                'select' => ['id', 'productName', 'price', 'quantity', 'sort'],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.smartprocess1038.productrow.update", b24.Params{
        	"id": 2411,
        	"fields": b24.Params{
        		"price":    4500,
        		"quantity": 3,
        	},
        	"select": []string{"id", "productName", "price", "quantity", "sort"},
        })
        if err != nil {
        	return fmt.Errorf("crm.smartprocess1038.productrow.update: %w", err)
        }
        
        var result struct {
        	Item struct {
        		ID          int     `json:"id"`
        		ProductName string  `json:"productName"`
        		Price       float64 `json:"price"`
        		Quantity    float64 `json:"quantity"`
        		Sort        int     `json:"sort"`
        	} `json:"item"`
        }
        if err := json.Unmarshal(res.Result, &result); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(result.Item.ID, result.Item.Price, result.Item.Quantity)
        

Response Handling

HTTP status: 200

{
            "result": {
                "item": {
                    "id": 2411,
                    "productName": "Installation",
                    "price": 4500,
                    "quantity": 3,
                    "sort": 0
                }
            },
            "time": {
                "start": 1793709949,
                "finish": 1793709949.853585,
                "duration": 0.8535850048065186,
                "processing": 0,
                "date_start": "2026-11-03T15:45:49+03:00",
                "date_finish": "2026-11-03T15:45:49+03:00",
                "operating_reset_at": 1793710260,
                "operating": 0.3442521095275879
            }
        }
        

Returned Data

Name
type

Description

result
object

Object with response data

result.item
object

Product item after the update, with the fields from select. Without select, the object contains only id. Description of product item fields

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "The product row field \"ownerId\" is read-only.",
                        "field": "ownerId"
                    }
                ]
            }
        }
        

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

id

Required field id is missing

Pass the product item id

fields

Required field fields is missing

Pass the fields object

fields

No product row fields specified

Pass at least one field in fields

ownerId

The product row field ownerId is read-only

Remove ownerId from fields. To move a product item to another item, delete it and add it again

price

This request requires data type float in field price

Pass a value of the type specified in the field description

Object Validation Errors

Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION

Field

Error description

How to Fix

productId

Field value is not one of the possible values

The product is not in the catalog, or you do not have access to it. Check productId with the catalog.product.list method

id

Field id is read-only

Remove the read-only field from fields. The method responds the same way to ownerTypeId and productTypeId

Product Item Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field

Error description

How to Fix

-

Entity with ID #ID# was not found

The product item does not exist, belongs to an item of a different object type, or you do not have permission to edit the item. Check id with the crm.<type>.productrow.list method and check the method name

Unknown Field Error

Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Field

Error description

How to Fix

-

Unknown field #FIELD# found in entity ProductRowDto

Check the field name in fields or select. Field names are written in camelCase: productName, not PRODUCT_NAME

Method Not Found

Error Code: BITRIX_REST_V3_EXCEPTION_METHODNOTFOUNDEXCEPTION, HTTP status: 404

Field

Error description

How to Fix

-

Method #METHOD# was not found

Check the method name: it is written in lowercase, for example, crm.deal.productrow.update. For an SPA, check entityTypeId with the crm.type.list method and make sure linking to products is enabled in the type

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