Get Lead Product Rows crm.lead.productrows.get
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 "read" access permission for leads
DEPRECATED
Development of this method has been halted. Please use crm.item.productrow.*.
The method crm.lead.productrows.get returns the product rows of a lead.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the lead. Can be obtained using the method to get the list of leads: |
Code Examples
Get product rows for the lead with id = 5
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":5}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.lead.productrows.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":5,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.lead.productrows.get
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each product row returned in result[]
type CrmLeadProductRow = {
ID: string
OWNER_ID: string
OWNER_TYPE: string
PRODUCT_ID: number
PRODUCT_NAME: string
PRICE: number
QUANTITY: number
DISCOUNT_TYPE_ID: number
DISCOUNT_RATE: number
DISCOUNT_SUM: number
TAX_RATE: number | null
TAX_INCLUDED: string
MEASURE_CODE: number
MEASURE_NAME: string
SORT: number
DATE_RESERVE_END: ISODate | null
}
try {
const response = await $b24.actions.v2.call.make<CrmLeadProductRow[]>({
method: 'crm.lead.productrows.get',
params: {
id: 5,
},
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:', result.length, 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 getLeadProductRows() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.lead.productrows.get',
params: {
id: 5,
},
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:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getLeadProductRows)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.lead.productrows.get(
bitrix_id=1201,
).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.lead.productrows.get',
[
'id' => 5,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
echo 'Error: ' . $result->error();
} else {
echo 'Data: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting lead product rows: ' . $e->getMessage();
}
BX24.callMethod(
'crm.lead.productrows.get',
{
id: 5,
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.lead.productrows.get',
[
'id' => 5
]
);
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.lead.productrows.get", b24.Params{
"id": 5,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.lead.productrows.get: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
OwnerID b24.ID `json:"OWNER_ID"`
OwnerType string `json:"OWNER_TYPE"`
ProductID b24.ID `json:"PRODUCT_ID"`
ProductName string `json:"PRODUCT_NAME"`
OriginalProductName string `json:"ORIGINAL_PRODUCT_NAME"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.OwnerID)
}
Response Handling
HTTP Status: 200
{
"result": [
{
"ID": "1425",
"OWNER_ID": "5",
"OWNER_TYPE": "L",
"PRODUCT_ID": 6935,
"PRODUCT_NAME": "Product Variation #1",
"ORIGINAL_PRODUCT_NAME": "Product Variation #1",
"PRODUCT_DESCRIPTION": null,
"PRICE": 10,
"PRICE_EXCLUSIVE": 10,
"PRICE_NETTO": 10,
"PRICE_BRUTTO": 10,
"PRICE_ACCOUNT": "10.00000000",
"QUANTITY": 1,
"DISCOUNT_TYPE_ID": 2,
"DISCOUNT_RATE": 0,
"DISCOUNT_SUM": 0,
"TAX_RATE": null,
"TAX_INCLUDED": "N",
"CUSTOMIZED": "Y",
"MEASURE_CODE": 796,
"MEASURE_NAME": "pcs",
"SORT": 10,
"XML_ID": "",
"TYPE": 4,
"STORE_ID": null,
"RESERVE_ID": null,
"DATE_RESERVE_END": null,
"RESERVE_QUANTITY": null
},
{
"ID": "1429",
"OWNER_ID": "5",
"OWNER_TYPE": "L",
"PRODUCT_ID": 6595,
"PRODUCT_NAME": "Product #2",
"ORIGINAL_PRODUCT_NAME": "Product #2",
"PRODUCT_DESCRIPTION": "Detailed description",
"PRICE": 22175.328,
"PRICE_EXCLUSIVE": 19799.4,
"PRICE_NETTO": 32999,
"PRICE_BRUTTO": 36958.88,
"PRICE_ACCOUNT": "22175.32800000",
"QUANTITY": 1,
"DISCOUNT_TYPE_ID": 2,
"DISCOUNT_RATE": 40,
"DISCOUNT_SUM": 13199.6,
"TAX_RATE": 12,
"TAX_INCLUDED": "N",
"CUSTOMIZED": "Y",
"MEASURE_CODE": 796,
"MEASURE_NAME": "pcs",
"SORT": 30,
"XML_ID": "",
"TYPE": 1,
"STORE_ID": null,
"RESERVE_ID": null,
"DATE_RESERVE_END": null,
"RESERVE_QUANTITY": null
}
],
"time": {
"start": 1772541576,
"finish": 1772541577.039689,
"duration": 1.039689064025879,
"processing": 0,
"date_start": "2026-03-03T15:39:36+01:00",
"date_finish": "2026-03-03T15:39:37+01:00",
"operating_reset_at": 1772542177,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response containing an array of lead product rows |
|
time |
Information about the execution time of the request |
Product Row Type
|
Name |
Description |
|
ID |
Identifier of the product row |
|
OWNER_ID |
Identifier of the element to which the product is linked. For this method, it will always equal the |
|
OWNER_TYPE |
String identifier of the type of object to which the product is linked. For this method, it will always equal |
|
PRODUCT_ID |
Identifier of the product in the catalog. For more detailed information about the product, use |
|
PRODUCT_NAME |
Name of the product row |
|
ORIGINAL_PRODUCT_NAME |
Name of the product row in the catalog |
|
PRODUCT_DESCRIPTION |
Description of the product row |
|
PRICE |
Final cost of the product per unit |
|
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 |
|
PRICE_ACCOUNT |
Cost of the product in "report currency" |
|
QUANTITY |
Quantity of product units |
|
DISCOUNT_TYPE_ID |
Type of discount
|
|
DISCOUNT_RATE |
Discount value in percentage (if using the percentage discount type) |
|
DISCOUNT_SUM |
Absolute discount value (if using the absolute discount type) |
|
TAX_RATE |
Tax rate in percentage |
|
TAX_INCLUDED |
Indicator of whether tax is included in the price
|
|
CUSTOMIZED |
Customized (Deprecated)
|
|
MEASURE_CODE |
Unit of measure code |
|
MEASURE_NAME |
Text representation of the unit of measure (e.g., pcs, kg, m, l, etc.) |
|
SORT |
Sorting |
|
XML_ID |
External code of the product |
|
TYPE |
Type of product
|
|
STORE_ID |
Identifier of the warehouse. For detailed information about the warehouse, use |
|
RESERVE_ID |
Identifier of the reserve |
|
DATE_RESERVE_END |
Date of reservation end |
|
RESERVE_QUANTITY |
Quantity of reserved product units |
Error Handling
HTTP Status: 400
{
"error": "",
"error_description": "The parameter id is invalid or not defined."
}
|
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 |
The |
|
Access denied |
The user does not have permission to "read" the lead |
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 |