Add a Product Item v 3.0 crm.[type].productrow.add

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 is added

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.add method adds one product item to a CRM item and returns its ID. The object type is set by the <type> segment of the method name. The item amount is recalculated from the product items unless it was set manually.

Method Name for the Object Type

Object type	Method
Deal	`crm.deal.productrow.add`
Lead	`crm.lead.productrow.add`
Estimate	`crm.quote.productrow.add`
Invoice	`crm.smartinvoice.productrow.add`
CRM document	`crm.smartdocument.productrow.add`
SPA	`crm.smartprocess<entityTypeId>.productrow.add`, for example, `crm.smartprocess1038.productrow.add`

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.add, not crm.smartInvoice.productRow.add. 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

fields*
object

Object with the product item fields in the format {"field": "value"}. Parameter description

The required field is ownerId, and the object must contain at least one other field

The fields Parameter

Required parameters are marked with *

Name `type`	Description
ownerId* `integer`	ID of the CRM item to which the product item is added. The item type is set by the method name: `crm.deal.productrow.add` adds a product item to a deal. The ID can be retrieved with the crm.<type>.list method or from the response of the crm.<type>.add method
productId `integer`	ID of a catalog product. If `productName` is not passed, the product item name is taken from the catalog. The ID can be retrieved with the catalog.product.list method. If the field is not passed, the product item is created without a link to the catalog, and responses contain `productId: 0`
productName `string`	Product item name. For a product item without a catalog product, pass the name explicitly
price `double`	Unit price including discount and tax
quantity `double`	Quantity
discountTypeId `integer`	Discount type. Possible values: `1` — fixed amount discount, set in `discountSum` `2` — percentage discount, set in `discountRate` Default: `2`
discountRate `double`	Discount percentage. Use if `discountTypeId` equals `2`
discountSum `double`	Discount amount per unit. Use if `discountTypeId` equals `1`. With a percentage discount, the amount is calculated automatically
taxRate `double`	Tax rate in percent, for example, `20`. Without a value, the product item has no tax. Default: `null`
taxIncluded `boolean`	Whether the tax is included in the price. Possible values: `true` — the tax is included in `price` `false` — the tax is added on top of the price Default: `false`
measureCode `integer`	Unit of measure code from the classifier, for example, `796` — piece. The unit name in `measureName` is set by the code. Unit of measure codes can be retrieved with the catalog.measure.list method
measureName `string`	Unit of measure name. If `measureCode` is passed, the name is taken from the units of measure reference
sort `integer`	Position of the product item in the list. Default: `0`

The id, ownerTypeId, and productTypeId fields are read-only: the method returns an error for them. The list of fields, with an indication of whether each field can be edited, is returned by the crm.<type>.productrow.field.list method. The fields are described in the product item methods overview.

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.add

The examples add a catalog product to an SPA item with the type ID 1038. For a different object type, replace the method name according to the table above.

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 '{"fields":{"ownerId":37,"productId":6461,"price":100.5,"quantity":2,"discountTypeId":2,"discountRate":10,"taxRate":20,"taxIncluded":true,"measureCode":796}}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/crm.smartprocess1038.productrow.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"ownerId":37,"productId":6461,"price":100.5,"quantity":2,"discountTypeId":2,"discountRate":10,"taxRate":20,"taxIncluded":true,"measureCode":796},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/crm.smartprocess1038.productrow.add

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 ProductRowAddResult = {
          id: number
        }
        
        try {
          const response = await $b24.getHttpClient(ApiVersion.v3).call<ProductRowAddResult>(
            'crm.smartprocess1038.productrow.add',
            {
              fields: {
                ownerId: 37,
                productId: 6461,
                price: 100.5,
                quantity: 2,
                discountTypeId: 2,
                discountRate: 10,
                taxRate: 20,
                taxIncluded: true,
                measureCode: 796,
              },
            },
            Text.getUuidRfc4122()
          )
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Product row created:', result.id)
          }
        } 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 addProductRow() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.getHttpClient(B24Js.ApiVersion.v3).call(
                'crm.smartprocess1038.productrow.add',
                {
                  fields: {
                    ownerId: 37,
                    productId: 6461,
                    price: 100.5,
                    quantity: 2,
                    discountTypeId: 2,
                    discountRate: 10,
                    taxRate: 20,
                    taxIncluded: true,
                    measureCode: 796,
                  },
                },
                B24Js.Text.getUuidRfc4122()
              )
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Product row created:', result.id)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', addProductRow)
        </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.add"
        Config().configure(api_v3_methods=Config().api_v3_methods | {method})
        
        try:
            response = bitrix_token.call_method(
                api_method=method,
                params={
                    "fields": {
                        "ownerId": 37,
                        "productId": 6461,
                        "price": 100.5,
                        "quantity": 2,
                        "discountTypeId": 2,
                        "discountRate": 10,
                        "taxRate": 20,
                        "taxIncluded": True,
                        "measureCode": 796,
                    },
                },
                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.add',
                    [
                        'fields' => [
                            'ownerId' => 37,
                            'productId' => 6461,
                            'price' => 100.5,
                            'quantity' => 2,
                            'discountTypeId' => 2,
                            'discountRate' => 10,
                            'taxRate' => 20,
                            'taxIncluded' => true,
                            'measureCode' => 796,
                        ],
                    ]
                );
        
            $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.add',
            {
                fields: {
                    ownerId: 37,
                    productId: 6461,
                    price: 100.5,
                    quantity: 2,
                    discountTypeId: 2,
                    discountRate: 10,
                    taxRate: 20,
                    taxIncluded: true,
                    measureCode: 796,
                },
            },
            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.add',
            [
                'fields' => [
                    'ownerId' => 37,
                    'productId' => 6461,
                    'price' => 100.5,
                    'quantity' => 2,
                    'discountTypeId' => 2,
                    'discountRate' => 10,
                    'taxRate' => 20,
                    'taxIncluded' => true,
                    'measureCode' => 796,
                ],
            ]
        );
        
        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.add", b24.Params{
        	"fields": b24.Params{
        		"ownerId":        37,
        		"productId":      6461,
        		"price":          100.5,
        		"quantity":       2,
        		"discountTypeId": 2,
        		"discountRate":   10,
        		"taxRate":        20,
        		"taxIncluded":    true,
        		"measureCode":    796,
        	},
        })
        if err != nil {
        	return fmt.Errorf("crm.smartprocess1038.productrow.add: %w", err)
        }
        
        var result struct {
        	ID int `json:"id"`
        }
        if err := json.Unmarshal(res.Result, &result); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(result.ID)

Response Handling

HTTP status: 200

{
            "result": {
                "id": 2409
            },
            "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.id `integer`	ID of the created product item. The product item fields can be retrieved with the crm.<type>.productrow.get method
time `time`	Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION",
                "message": "Error validating object.",
                "validation": [
                    {
                        "message": "Field value is not one of the possible values.",
                        "field": "productId"
                    }
                ]
            }
        }

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
`fields`	Required field `fields` is missing	Pass the `fields` object
`-`	No product row fields specified	Pass at least one field other than `ownerId` in `fields`, for example, `productId` or `productName`
`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
`ownerId`	Required field `ownerId` is empty	Pass `ownerId` in `fields`
`ownerId`	Field value must be 1 or greater	Pass a positive item ID
`ownerId`	Field value is not one of the possible values	This object type has no item with this ID, or you do not have access to it. Check `ownerId` and the method name
`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
`ownerTypeId`	Field `ownerTypeId` is read-only	Remove the read-only field from `fields`. The method responds the same way to `id` and `productTypeId`

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 against the fields parameter table. 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.add`. 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

Was the article helpful?

Overview of Methods

Update a Product Item

Add a Product Item v 3.0 crm.[type].productrow.add

Method Name for the Object TypeMethod Name for the Object Type

Method ParametersMethod Parameters

The fields ParameterThe fields Parameter

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Object Validation ErrorsObject Validation Errors

Unknown Field ErrorUnknown Field Error

Method Not FoundMethod Not Found

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Name for the Object Type

Method Parameters

The fields Parameter

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Request Validation Errors

Object Validation Errors

Unknown Field Error

Method Not Found

Statuses and System Error Codes

Continue Learning