Save Product Rows of CRM Object crm.item.productrow.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: access permission to modify the CRM object whose product rows are saved is required.
Saves the set of product rows of a CRM object.
The method replaces all product rows of the CRM object with the set that is passed. Rows that are absent from productRows are deleted together with their items in payments, and the total of the CRM object is recalculated. If an empty array is passed, the CRM object is left with no product rows.
To add a single row without changing the rest, use the crm.item.productrow.add method.
The set is saved as a whole: if at least one row fails validation, the method returns the INVALID_ARG_VALUE error and leaves the product rows of the CRM object unchanged.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
ownerId* |
Identifier of the CRM object. |
|
ownerType* |
Short symbolic code of the CRM object type: |
|
productRows* |
Array of objects containing information about the product rows to be saved in the object (detailed description) |
Parameter productRows
In every row, pass either productId (identifier of a product from the catalog) or productName (name of an arbitrary row).
|
Name |
Description |
|
Identifier of an existing product row. It can be retrieved with the crm.item.productrow.list method. |
|
|
productId |
Identifier of the product from the catalog. |
|
productName |
Name of the product in the product row. |
|
price |
Price per unit of the product row, including discounts and taxes. It is specified in the currency of the CRM object. |
|
quantity |
Quantity of the product. |
|
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:
|
|
taxName |
Name of the tax rate. For example, |
|
measureCode |
Unit of measurement code. |
|
sort |
Sorting |
The method calculates the priceAccount, priceExclusive, priceNetto, priceBrutto, measureName, type, customized, xmlId, and storeId fields on its own. The method ignores values passed for these fields without raising an error: sending back a row retrieved with the crm.item.productrow.list method does not change them.
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ownerType":"D","ownerId":13143,"productRows":[{"productId":9621,"price":99999.99,"quantity":1,"sort":10},{"productId":9623,"price":15900,"quantity":2,"sort":10}]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.productrow.set
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"ownerType":"D","ownerId":13143,"productRows":[{"productId":9621,"price":99999.99,"quantity":1,"sort":10},{"productId":9623,"price":15900,"quantity":2,"sort":10}],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.item.productrow.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
// Shape of the payload returned in result (match the "response handling" section of the page)
type ProductRowsResult = {
productRows: {
id: number
ownerId: number
ownerType: string
productId: number
productName: string
price: number
priceAccount: number
priceExclusive: number
priceNetto: number
priceBrutto: number
quantity: number
discountTypeId: number
discountRate: number
discountSum: number
taxRate: number | null
taxIncluded: string
taxName: string
customized: string
measureCode: number
measureName: string
sort: number
xmlId: string
type: number
}[]
}
try {
const response = await $b24.actions.v2.call.make<ProductRowsResult>({
method: 'crm.item.productrow.set',
params: {
ownerType: 'D',
ownerId: 13143,
productRows: [
{
productId: 9621,
price: 99999.99,
quantity: 1,
sort: 10,
},
{
productId: 9623,
price: 15900,
quantity: 2,
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.productRows)
}
} 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 setProductRows() {
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.set',
params: {
ownerType: 'D',
ownerId: 13143,
productRows: [
{
productId: 9621,
price: 99999.99,
quantity: 1,
sort: 10,
},
{
productId: 9623,
price: 15900,
quantity: 2,
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.productRows)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', setProductRows)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.item.productrow.set(
owner_type="D",
owner_id=13143,
product_rows=[
{
"productId": 9621,
"price": 99999.99,
"quantity": 1,
"sort": 10,
},
{
"productId": 9623,
"price": 15900,
"quantity": 2,
"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}")
try {
$response = $b24Service
->core
->call(
'crm.item.productrow.set',
[
'ownerType' => 'D',
'ownerId' => 13143,
'productRows' => [
[
'productId' => 9621,
'price' => 99999.99,
'quantity' => 1,
'sort' => 10,
],
[
'productId' => 9623,
'price' => 15900,
'quantity' => 2,
'sort' => 10,
],
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error setting product rows: ' . $e->getMessage();
}
BX24.callMethod(
'crm.item.productrow.set', {
ownerType: 'D',
ownerId: 13143,
productRows: [{
productId: 9621,
price: 99999.99,
quantity: 1,
sort: 10,
},
{
productId: 9623,
price: 15900,
quantity: 2,
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.set',
[
'ownerType' => 'D',
'ownerId' => 13143,
'productRows' => [
[
'productId' => 9621,
'price' => 99999.99,
'quantity' => 1,
'sort' => 10,
],
[
'productId' => 9623,
'price' => 15900,
'quantity' => 2,
'sort' => 10,
]
]
]
);
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.item.productrow.set", b24.Params{
"ownerType": "D",
"ownerId": 13143,
"productRows": []b24.Params{
{
"productId": 9621,
"price": 99999.99,
"quantity": 1,
"sort": 10,
},
{
"productId": 9623,
"price": 15900,
"quantity": 2,
"sort": 10,
},
},
})
if err != nil {
return fmt.Errorf("crm.item.productrow.set: %w", err)
}
// The method wraps the response in an object with the "productRows" key.
raw, ok := b24.Unwrap(res.Result, "productRows")
if !ok {
return fmt.Errorf("no productRows key in the response")
}
var items []struct {
ID b24.ID `json:"id"`
OwnerID b24.ID `json:"ownerId"`
OwnerType string `json:"ownerType"`
ProductID b24.ID `json:"productId"`
ProductName string `json:"productName"`
Price float64 `json:"price"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID)
}
Response on Success
HTTP status: 200
{
"result":{
"productRows":[
{
"id":17654,
"ownerId":13143,
"ownerType":"D",
"productId":9621,
"productName":"iphone 14",
"price":99999.99,
"priceAccount":99999.99,
"priceExclusive":99999.99,
"priceNetto":99999.99,
"priceBrutto":99999.99,
"quantity":1,
"discountTypeId":2,
"discountRate":0,
"discountSum":0,
"taxRate":null,
"taxIncluded":"N",
"taxName":"No VAT",
"customized":"Y",
"measureCode":796,
"measureName":"pcs",
"sort":10,
"xmlId":"",
"type":4
},
{
"id":17655,
"ownerId":13143,
"ownerType":"D",
"productId":9623,
"productName":"iphone 10xs",
"price":15900,
"priceAccount":15900,
"priceExclusive":15900,
"priceNetto":15900,
"priceBrutto":15900,
"quantity":2,
"discountTypeId":2,
"discountRate":0,
"discountSum":0,
"taxRate":null,
"taxIncluded":"N",
"taxName":"No VAT",
"customized":"Y",
"measureCode":796,
"measureName":"pcs",
"sort":10,
"xmlId":"",
"type":4
}
]
},
"time":{
"start":1716895718.887229,
"finish":1716895719.316293,
"duration":0.4290640354156494,
"processing":0.20114707946777344,
"date_start":"2024-05-28T14:28:38+03:00",
"date_finish":"2024-05-28T14:28:39+03:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response (detailed description) |
|
time |
Information about the request execution time |
The result Object
|
Name |
Description |
|
productRows |
Array of objects with information about all product rows of the CRM object after saving. The method returns them all at once, with no pagination |
Error Handling
HTTP status: 400
{
"error":"OWNER_NOT_FOUND",
"error_description":"Owner was not found"
}
|
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
|
Code |
Description |
|
|
This type of CRM object does not support product rows |
|
|
The user has no permission to modify the CRM object |
|
|
The provided CRM object was not found |
|
|
The product with the provided |
|
|
Required parameters not provided |
|
|
Other errors (e.g., fatal errors) |
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 |
Continue Learning
- Product Items in CRM Objects: Overview of Methods
- Add Product Row to CRM Object crm.item.productrow.add
- Update the Product Row of a CRM Object crm.item.productrow.update
- Get Information About a Product Item by Id crm.item.productrow.get
- Get Product Rows of the CRM Object crm.item.productrow.list
- Delete Product Row from CRM Object crm.item.productrow.delete
- Get Unpaid Product Rows of CRM Object crm.item.productrow.getAvailableForPayment
- Get the List of Fields for Product Rows crm.item.productrow.fields