Set Products in Deal crm.deal.productrows.set
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:
crmWho can execute the method: user with "modify" access permission for the deal
DEPRECATED
The development of this method has been halted. Please use crm.item.productrow.*.
The method crm.deal.productrows.set creates or updates the product rows of a deal. Existing rows that are not passed to the method will be removed from the deal.
To modify only one row, use the methods crm.item.productrow.*.
|
Name |
Description |
|
id* |
Identifier of the deal. Can be obtained using the method to retrieve the list of deals: |
|
rows |
Product rows An array of objects in the following format:
where
The list of available fields is described below |
List of Available Fields for Product Rows
|
Name |
Description |
|
PRODUCT_ID |
Identifier of the product in the catalog. The list of products can be obtained using the method Default - |
|
PRODUCT_NAME |
Name of the product row. If If neither |
|
PRICE |
Final cost of the product per unit Default - |
|
PRICE_EXCLUSIVE |
Cost per unit considering discounts, excluding taxes |
|
PRICE_NETTO |
Cost per unit excluding discounts and taxes |
|
PRICE_BRUTTO |
Cost per unit excluding discounts but including taxes |
|
QUANTITY |
Quantity of product units Default - |
|
DISCOUNT_TYPE_ID |
Type of discount
Default - |
|
DISCOUNT_RATE |
Discount value in percentage (if percentage discount type is used) Default - |
|
DISCOUNT_SUM |
Absolute discount value (if absolute discount type is used) Default - |
|
TAX_RATE |
Tax rate in percentage |
|
TAX_INCLUDED |
Indicator of whether tax is included in the price
Default - |
|
MEASURE_CODE |
Unit of measure code If |
|
MEASURE_NAME |
Text representation of the unit of measure (e.g., pcs, kg, m, l, etc.) If |
|
SORT |
Sorting Default - |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":5,"rows":[{"PRODUCT_ID":456,"PRICE":1000,"QUANTITY":10,"DISCOUNT_TYPE_ID":1,"DISCOUNT_SUM":100,"TAX_RATE":13,"MEASURE_CODE":796,"MEASURE_NAME":"pcs","SORT":10},{"PRODUCT_NAME":"Product #2","PRICE":500,"QUANTITY":5,"DISCOUNT_TYPE_ID":2,"DISCOUNT_RATE":10,"TAX_RATE":10,"MEASURE_CODE":166,"MEASURE_NAME":"kg","SORT":20}]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.deal.productrows.set
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":5,"rows":[{"PRODUCT_ID":456,"PRICE":1000,"QUANTITY":10,"DISCOUNT_TYPE_ID":1,"DISCOUNT_SUM":100,"TAX_RATE":13,"MEASURE_CODE":796,"MEASURE_NAME":"pcs","SORT":10},{"PRODUCT_NAME":"Product #2","PRICE":500,"QUANTITY":5,"DISCOUNT_TYPE_ID":2,"DISCOUNT_RATE":10,"TAX_RATE":10,"MEASURE_CODE":166,"MEASURE_NAME":"kg","SORT":20}],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.deal.productrows.set
// 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
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'crm.deal.productrows.set',
params: {
id: 5,
rows: [
{
PRODUCT_ID: 456,
PRICE: 1000,
QUANTITY: 10,
DISCOUNT_TYPE_ID: 1,
DISCOUNT_SUM: 100,
TAX_RATE: 13,
MEASURE_CODE: 796,
MEASURE_NAME: 'pcs',
SORT: 10,
},
{
PRODUCT_NAME: 'Product #2',
PRICE: 500,
QUANTITY: 5,
DISCOUNT_TYPE_ID: 2,
DISCOUNT_RATE: 10,
TAX_RATE: 10,
MEASURE_CODE: 166,
MEASURE_NAME: 'kg',
SORT: 20,
},
],
},
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('Product rows set:', result)
}
} 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 setDealProductRows() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.deal.productrows.set',
params: {
id: 5,
rows: [
{
PRODUCT_ID: 456,
PRICE: 1000,
QUANTITY: 10,
DISCOUNT_TYPE_ID: 1,
DISCOUNT_SUM: 100,
TAX_RATE: 13,
MEASURE_CODE: 796,
MEASURE_NAME: 'pcs',
SORT: 10,
},
{
PRODUCT_NAME: 'Product #2',
PRICE: 500,
QUANTITY: 5,
DISCOUNT_TYPE_ID: 2,
DISCOUNT_RATE: 10,
TAX_RATE: 10,
MEASURE_CODE: 166,
MEASURE_NAME: 'kg',
SORT: 20,
},
],
},
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('Product rows set:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', setDealProductRows)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.deal.productrows.set(
bitrix_id=123,
rows=[
{"PRODUCT_ID": 1001, "PRICE": 1200, "QUANTITY": 2, "CURRENCY_ID": "USD", "TAX_RATE": 20},
{"PRODUCT_NAME": "Implementation Service", "PRICE": 5000, "QUANTITY": 1, "CURRENCY_ID": "USD", "TAX_RATE": 0},
],
).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(
'crm.deal.productrows.set',
[
'id' => 5,
'rows' => [
[
'PRODUCT_ID' => 456,
'PRICE' => 1000,
'QUANTITY' => 10,
'DISCOUNT_TYPE_ID' => 1,
'DISCOUNT_SUM' => 100,
'TAX_RATE' => 13,
'MEASURE_CODE' => 796,
'MEASURE_NAME' => "pcs",
'SORT' => 10,
],
[
'PRODUCT_NAME' => "Product #2",
'PRICE' => 500,
'QUANTITY' => 5,
'DISCOUNT_TYPE_ID' => 2,
'DISCOUNT_RATE' => 10,
'TAX_RATE' => 10,
'MEASURE_CODE' => 166,
'MEASURE_NAME' => "kg",
'SORT' => 20,
],
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error setting deal product rows: ' . $e->getMessage();
}
BX24.callMethod(
'crm.deal.productrows.set',
{
id: 5,
rows: [
{
PRODUCT_ID: 456,
PRICE: 1000,
QUANTITY: 10,
DISCOUNT_TYPE_ID: 1,
DISCOUNT_SUM: 100,
TAX_RATE: 13,
MEASURE_CODE: 796,
MEASURE_NAME: "pcs",
SORT: 10,
},
{
PRODUCT_NAME: "Product #2",
PRICE: 500,
QUANTITY: 5,
DISCOUNT_TYPE_ID: 2,
DISCOUNT_RATE: 10,
TAX_RATE: 10,
MEASURE_CODE: 166,
MEASURE_NAME: "kg",
SORT: 20,
},
],
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.deal.productrows.set',
[
'id' => 5,
'rows' => [
[
'PRODUCT_ID' => 456,
'PRICE' => 1000,
'QUANTITY' => 10,
'DISCOUNT_TYPE_ID' => 1,
'DISCOUNT_SUM' => 100,
'TAX_RATE' => 13,
'MEASURE_CODE' => 796,
'MEASURE_NAME' => "pcs",
'SORT' => 10,
],
[
'PRODUCT_NAME' => "Product #2",
'PRICE' => 500,
'QUANTITY' => 5,
'DISCOUNT_TYPE_ID' => 2,
'DISCOUNT_RATE' => 10,
'TAX_RATE' => 10,
'MEASURE_CODE' => 166,
'MEASURE_NAME' => "kg",
'SORT' => 20,
],
]
]
);
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.deal.productrows.set", b24.Params{
"id": 5,
"rows": []b24.Params{
{
"PRODUCT_ID": 456,
"PRICE": 1000,
"QUANTITY": 10,
"DISCOUNT_TYPE_ID": 1,
"DISCOUNT_SUM": 100,
"TAX_RATE": 13,
"MEASURE_CODE": 796,
"MEASURE_NAME": "pcs",
"SORT": 10,
},
{
"PRODUCT_NAME": "Product #2",
"PRICE": 500,
"QUANTITY": 5,
"DISCOUNT_TYPE_ID": 2,
"DISCOUNT_RATE": 10,
"TAX_RATE": 10,
"MEASURE_CODE": 166,
"MEASURE_NAME": "kg",
"SORT": 20,
},
},
})
if err != nil {
return fmt.Errorf("crm.deal.productrows.set: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
Response Handling
HTTP Status: 200
{
"result": true,
"time": {
"start": 1735134795.171273,
"finish": 1735134796.404978,
"duration": 1.2337050437927246,
"processing": 0.9462978839874268,
"date_start": "2024-12-25T15:53:15+02:00",
"date_finish": "2024-12-25T15:53:16+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response, contains |
|
time |
Information about the execution time of the request |
Error Handling
HTTP Status: 400
{
"error": "ERROR_CORE",
"error_description": "Discount Sum (DISCOUNT_SUM) is required if Percentage Discount Type (DISCOUNT_TYPE_ID) is defined and Discount Rate (DISCOUNT_RATE) is 100%<br>"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Description |
Value |
|
The parameter id is invalid or not defined |
An incorrect value was passed to the |
|
Access denied |
The user does not have permission to "modify" the deal |
|
Not found |
The deal with the provided |
|
Discount Rate ( |
|
|
Discount Sum ( |
|
|
Discount Sum ( |
|
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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 |