Retrieve Lead Product Rows crm.lead.productrows.get

Scope: crm

Who can execute the method: user with "read" access permission for leads

Method Development Halted

The method crm.lead.productrows.get is still operational, but there is a more current equivalent: crm.item.productrow.*.

The method crm.lead.productrows.get returns the product rows associated with a lead.

Method Parameters

Required parameters are marked with *

Name `type`	Description
id^* `integer`	Identifier of the lead. Can be obtained using the method to retrieve the list of leads: `crm.lead.list` or when creating a lead: `crm.lead.add`

Code Examples

Retrieve product rows for a lead with id = 5

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 '{"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

try
        {
        	const response = await $b24.callMethod(
        		'crm.lead.productrows.get',
        		{
        			id: 5,
        		}
        	);
        	
        	const result = response.getData().result;
        	result.error()
        		? console.error(result.error())
        		: console.info(result)
        	;
        }
        catch( error )
        {
        	console.error('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>';

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 `type`	Description
result `productrow[]`	Root element of the response containing an array of lead product rows
time `time`	Information about the execution time of the request

Product Row Type

Name `type`	Description
ID `integer`	Identifier of the product row
OWNER_ID `integer`	Identifier of the element to which the product is linked. For this method, it will always equal the lead `id`
OWNER_TYPE `string`	String identifier of the object type to which the product is linked. For this method, it will always equal `L`
PRODUCT_ID `integer`	Identifier of the product in the catalog. `0` if not from the catalog For more detailed information about the product, use `catalog.product.get`
PRODUCT_NAME `string`	Name of the product row
ORIGINAL_PRODUCT_NAME `string`	Name of the product row in the catalog
PRODUCT_DESCRIPTION `string`	Description of the product row
PRICE `double`	Final cost of the product per unit
PRICE_EXCLUSIVE `double`	Cost per unit considering discounts, excluding taxes
PRICE_NETTO `double`	Cost per unit excluding discounts and taxes
PRICE_BRUTTO `double`	Cost per unit excluding discounts but including taxes
PRICE_ACCOUNT `string`	Cost of the product in "report currency"
QUANTITY `double`	Quantity of product units
DISCOUNT_TYPE_ID `integer`	Type of discount Possible types: `1` - Absolute `2` - Percentage
DISCOUNT_RATE `double`	Discount value in percentage (if using the percentage discount type)
DISCOUNT_SUM `double`	Absolute value of the discount (if using the absolute discount type)
TAX_RATE `double`	Tax rate in percentage
TAX_INCLUDED `char`	Indicator of whether the tax is included in the price Possible values: `Y` – tax included `N` – tax not included
CUSTOMIZED `char`	Customized (Deprecated) Possible values: `Y` - Yes `N` - No
MEASURE_CODE `catalog_measure.code`	Unit of measure code
MEASURE_NAME `string`	Text representation of the unit of measure (e.g., pcs, kg, m, l, etc.)
SORT `integer`	Sorting
XML_ID `string`	External code of the product
TYPE `integer`	Type of product Possible values: `1` - Simple product `4` - Trade offer/variation `7` - Service
STORE_ID `integer`	Identifier of the warehouse. For detailed information about the warehouse, use `catalog.store.get`
RESERVE_ID `integer`	Identifier of the reserve
DATE_RESERVE_END `date`	Date of reservation end
RESERVE_QUANTITY `double`	Quantity of reserved product units

Error Handling

HTTP Status: 400

{
          "error": "",
          "error_description": "The parameter id is invalid or not defined."
        }

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

Description	Value
The parameter id is invalid or not defined	The `id` parameter has an incorrect value
Access denied	The user does not have "read" access permission for leads

Statuses and System Error Codes

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

Set Products in Lead crm.lead.productrows.set

Set Products in Lead

Overview of methods

Retrieve Lead Product Rows crm.lead.productrows.get

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Product Row TypeProduct Row Type

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning