Add Product Row to CRM Object crm.item.productrow.add

Scope: crm

Who can execute the method: requires access permission to modify the CRM object to which the product row is being added.

This method adds a product row to a CRM object.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Object containing field values for adding the product row to the CRM object

Parameter fields

Name `type`	Description
ownerId* `integer`	Identifier of the CRM object
ownerType* `string`	Identifier of the `CRM object type`. Pass the Short symbolic code of the type
productId `catalog_product.id`	Identifier of the product from the catalog
productName `string`	Name of the product in the product row. If not provided, but `productId` is given, the product name from the product catalog is used
price `double`	Price per unit of the product row, including discounts and taxes
quantity `double`	Quantity of the product. Default is 1
discountTypeId `integer`	Type of discount. Possible values: `1` — absolute value `2` — percentage value Default is 2
discountRate `double`	Discount value in percentage (if using the percentage discount type)
discountSum `double`	Absolute discount value (if using the absolute discount type)
taxRate `double`	Tax rate in percentage
taxIncluded `string`	Indicator of whether the tax is included in the price. Possible values: `Y` – tax included `N` – tax not included Default is N
measureCode `catalog_measure.code`	Unit of measure code. If not provided and `productId` is given, the unit of measure from the product catalog is used
sort `integer`	Sorting

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"ownerId":13142,"ownerType":"D","productId":9621,"price":80000,"quantity":2,"discountTypeId":2,"discountRate":20,"taxRate":20,"taxIncluded":"Y","measureCode":796,"sort":10}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.productrow.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"ownerId":13142,"ownerType":"D","productId":9621,"price":80000,"quantity":2,"discountTypeId":2,"discountRate":20,"taxRate":20,"taxIncluded":"Y","measureCode":796,"sort":10},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.item.productrow.add

try
        {
        	const response = await $b24.callMethod(
        		'crm.item.productrow.add', {
        			fields: {
        				ownerId: 13142,
        				ownerType: 'D',
        				productId: 9621,
        				price: 80000.000000,
        				quantity: 2,
        				discountTypeId: 2,
        				discountRate: 20,
        				taxRate: 20,
        				taxIncluded: 'Y',
        				measureCode: 796,
        				sort: 10,
        			},
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.item.productrow.add',
                    [
                        'fields' => [
                            'ownerId'        => 13142,
                            'ownerType'      => 'D',
                            'productId'      => 9621,
                            'price'          => 80000.000000,
                            'quantity'       => 2,
                            'discountTypeId' => 2,
                            'discountRate'   => 20,
                            'taxRate'        => 20,
                            'taxIncluded'    => 'Y',
                            'measureCode'    => 796,
                            'sort'           => 10,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding product row: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.item.productrow.add', {
                fields: {
                    ownerId: 13142,
                    ownerType: 'D',
                    productId: 9621,
                    price: 80000.000000,
                    quantity: 2,
                    discountTypeId: 2,
                    discountRate: 20,
                    taxRate: 20,
                    taxIncluded: 'Y',
                    measureCode: 796,
                    sort: 10,
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'crm.item.productrow.add',
            [
                'fields' => [
                    'ownerId' => 13142,
                    'ownerType' => 'D',
                    'productId' => 9621,
                    'price' => 80000.000000,
                    'quantity' => 2,
                    'discountTypeId' => 2,
                    'discountRate' => 20,
                    'taxRate' => 20,
                    'taxIncluded' => 'Y',
                    'measureCode' => 796,
                    'sort' => 10,
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Successful Response

HTTP Status: 200

{
           "result":{
              "productRow":{
                 "id":17647,
                 "ownerId":13142,
                 "ownerType":"D",
                 "productId":9621,
                 "price":80000,
                 "quantity":2,
                 "discountTypeId":2,
                 "discountRate":20,
                 "taxRate":20,
                 "taxIncluded":"Y",
                 "measureCode":796,
                 "sort":10,
                 "type":4,
                 "productName":"iphone 14",
                 "priceAccount":80000,
                 "priceExclusive":66666.67,
                 "priceNetto":83333.34,
                 "priceBrutto":100000.01,
                 "discountSum":16666.67,
                 "customized":"Y",
                 "measureName":"pcs",
                 "xmlId":""
              }
           },
           "time":{
              "start":1716887721.77879,
              "finish":1716887723.259695,
              "duration":1.4809050559997559,
              "processing":1.2986550331115723,
              "date_start":"2024-05-28T12:15:21+02:00",
              "date_finish":"2024-05-28T12:15:23+02:00"
           }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
productRow `crm_item_product_row`	Object containing information about the added product row
time `time`	Information about the request execution time

Error Handling

HTTP Status: 400

{
           "error":"OWNER_NOT_FOUND",
           "error_description":"Owner was not found"
        }

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description
`ENTITY_TYPE_NOT_SUPPORTED`	Working with this type of objects is not supported
`ACCESS_DENIED`	Access denied
`OWNER_NOT_FOUND`	The provided CRM object was not found
`100`	Required parameters were not provided
`0`	Other errors (e.g., fatal errors)

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Product Items

Update Product Item

Add Product Row to CRM Object crm.item.productrow.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Successful ResponseSuccessful Response

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Continue LearningContinue Learning