Add Product Row to CRM Object crm.item.productrow.add
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
crmWho can execute the method: requires access permission to modify the CRM object to which the product row is being added.
Adds a product row to a CRM object.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Object containing field values for adding the product row to the CRM object |
Parameter fields
|
Name |
Description |
|
ownerId* |
Identifier of the CRM object. |
|
ownerType* |
Identifier of the CRM object type. Pass the Short symbolic code of the type |
|
productId |
Identifier of the product from the catalog. |
|
productName |
Name of the product in the product row. If not provided, but |
|
price |
Price per unit of the product row, including discounts and taxes. |
|
quantity |
Quantity of the product. Default is 1 |
|
discountTypeId |
Type of discount. Possible values:
|
|
discountRate |
The discount value in percentage (if using the percentage discount type) |
|
discountSum |
The absolute value of the discount (if using the absolute discount type) |
|
taxRate |
Tax rate in percentage. |
|
taxIncluded |
Indicator of whether the tax is included in the price. Possible values:
|
|
measureCode |
Unit of measure code. If not provided and |
|
sort |
Sorting |
Code Examples
How to Use Examples in Documentation
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
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type ProductRowAddResult = {
productRow: {
id: number
ownerId: number
ownerType: string
productId: number
price: number
quantity: number
discountTypeId: number
discountRate: number
taxRate: number
taxIncluded: string
measureCode: number
sort: number
type: number
productName: string
priceAccount: number
priceExclusive: number
priceNetto: number
priceBrutto: number
discountSum: number
customized: string
measureName: string
xmlId: string
}
}
try {
const response = await $b24.actions.v2.call.make<ProductRowAddResult>({
method: 'crm.item.productrow.add',
params: {
fields: {
ownerId: 13142,
ownerType: 'D',
productId: 9621,
price: 80000,
quantity: 2,
discountTypeId: 2,
discountRate: 20,
taxRate: 20,
taxIncluded: 'Y',
measureCode: 796,
sort: 10,
},
},
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(result.productRow.id, result.productRow.productName, result.productRow.price)
}
} 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 addProductRow() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.item.productrow.add',
params: {
fields: {
ownerId: 13142,
ownerType: 'D',
productId: 9621,
price: 80000,
quantity: 2,
discountTypeId: 2,
discountRate: 20,
taxRate: 20,
taxIncluded: 'Y',
measureCode: 796,
sort: 10,
},
},
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(result.productRow.id, result.productRow.productName, result.productRow.price)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addProductRow)
</script>
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();
}
Example
from b24pysdk.client import BaseClient
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
client: BaseClient
try:
bitrix_response = client.crm.item.productrow.add(
fields={
"ownerId": 13142,
"ownerType": "D",
"productId": 9621,
"price": 80000,
"quantity": 2,
"discountTypeId": 2,
"discountRate": 20,
"taxRate": 20,
"taxIncluded": "Y",
"measureCode": 796,
"sort": 10,
},
).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}")
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>';
Response on Success
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+03:00",
"date_finish":"2024-05-28T12:15:23+03:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
productRow |
Object containing information about the added product row |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error":"OWNER_NOT_FOUND",
"error_description":"Owner was not found"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
Working with this type of objects is not supported |
|
|
Access denied |
|
|
The provided CRM object was not found |
|
|
Required parameters not provided |
|
|
Other errors (e.g., fatal errors) |
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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
- Product Items in CRM Objects: Overview of Methods
- Update the Product Row of a CRM Object crm.item.productrow.update
- Get the List of Fields for Product Rows crm.item.productrow.fields
- Get Information About a Product Item by Id crm.item.productrow.get
- Save Product Row of CRM Object crm.item.productrow.set
- Get Unpaid Product Rows of CRM Object crm.item.productrow.getAvailableForPayment
- Get Product Rows of the CRM Object crm.item.productrow.list
- Delete Product Row from CRM Object crm.item.productrow.delete