Get Deal Products crm.deal.productrows.get

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: crm

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

DEPRECATED

Development of this method has been halted. Please use crm.item.productrow.*.

The method crm.deal.productrows.get returns the product rows of a deal.

Name `type`	Description
id^* `integer`	The identifier of the deal. It can be obtained using the method for retrieving the list of deals: `crm.deal.list` or when creating a deal: `crm.deal.add`

Required parameters are marked with *

Code Examples

Retrieve the product rows of the deal 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.deal.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.deal.productrows.get

try
        {
        	const response = await $b24.callMethod(
        		'crm.deal.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.deal.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 deal product rows: ' . $e->getMessage();
        }

BX24.callMethod(
            'crm.deal.productrows.get',
            {
                id: 5,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );

require_once('crest.php');
        
        $result = CRest::call(
        	'crm.deal.productrows.get',
        	[
        		'id' => 5
        	]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Response Handling

HTTP Status: 200

{
        	"result": [
        		{
        			"ID": "5",
        			"OWNER_ID": "5",
        			"OWNER_TYPE": "D",
        			"PRODUCT_ID": 450,
        			"PRODUCT_NAME": "Product #2",
        			"ORIGINAL_PRODUCT_NAME": "Product #2",
        			"PRODUCT_DESCRIPTION": null,
        			"PRICE": 899.1,
        			"PRICE_EXCLUSIVE": 899.1,
        			"PRICE_NETTO": 999,
        			"PRICE_BRUTTO": 999,
        			"PRICE_ACCOUNT": "899.10",
        			"QUANTITY": 1,
        			"DISCOUNT_TYPE_ID": 2,
        			"DISCOUNT_RATE": 10,
        			"DISCOUNT_SUM": 99.9,
        			"TAX_RATE": null,
        			"TAX_INCLUDED": "Y",
        			"CUSTOMIZED": "Y",
        			"MEASURE_CODE": 796,
        			"MEASURE_NAME": "pcs",
        			"SORT": 10,
        			"XML_ID": "sale_basket_651",
        			"TYPE": 1,
        			"STORE_ID": 0,
        			"RESERVE_ID": 31,
        			"DATE_RESERVE_END": "2024-12-26",
        			"RESERVE_QUANTITY": 1
        		},
        		{
        			"ID": "4",
        			"OWNER_ID": "5",
        			"OWNER_TYPE": "D",
        			"PRODUCT_ID": 449,
        			"PRODUCT_NAME": "Product #1",
        			"ORIGINAL_PRODUCT_NAME": "Product #1",
        			"PRODUCT_DESCRIPTION": "Detailed description",
        			"PRICE": 100,
        			"PRICE_EXCLUSIVE": 100,
        			"PRICE_NETTO": 100,
        			"PRICE_BRUTTO": 100,
        			"PRICE_ACCOUNT": "100.00",
        			"QUANTITY": 1,
        			"DISCOUNT_TYPE_ID": 2,
        			"DISCOUNT_RATE": 0,
        			"DISCOUNT_SUM": 0,
        			"TAX_RATE": null,
        			"TAX_INCLUDED": "Y",
        			"CUSTOMIZED": "Y",
        			"MEASURE_CODE": 796,
        			"MEASURE_NAME": "pcs",
        			"SORT": 20,
        			"XML_ID": "sale_basket_650",
        			"TYPE": 1,
        			"STORE_ID": 1,
        			"RESERVE_ID": 30,
        			"DATE_RESERVE_END": "2024-12-26",
        			"RESERVE_QUANTITY": 1
        		}
        	],
        	"time": {
        		"start": 1734969122.936213,
        		"finish": 1734969123.586089,
        		"duration": 0.6498758792877197,
        		"processing": 0.14046597480773926,
        		"date_start": "2024-12-23T17:52:02+02:00",
        		"date_finish": "2024-12-23T17:52:03+02:00",
        		"operating": 0
        	}
        }

Returned Data

Name `type`	Description
result `productrow[]`	The root element of the response containing an array of product rows for the deal
time `time`	Information about the execution time of the request

Product Row Type

Name `type`	Description
ID `integer`	The identifier of the product row
OWNER_ID `integer`	The identifier of the entity to which the product is linked. For this method, it will always equal the `id` of the deal
OWNER_TYPE `string`	String identifier of the type of object to which the product is linked. For this method, it will always equal `D`
PRODUCT_ID `integer`	The 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`	The name of the product row
ORIGINAL_PRODUCT_NAME `string`	The name of the product row in the catalog
PRODUCT_DESCRIPTION `string`	The description of the product row
PRICE `double`	The total cost of the product per unit
PRICE_EXCLUSIVE `double`	The cost per unit considering discounts, excluding taxes
PRICE_NETTO `double`	The cost per unit excluding discounts and taxes
PRICE_BRUTTO `double`	The cost per unit excluding discounts but including taxes
PRICE_ACCOUNT `string`	The cost of the product in "report currency"
QUANTITY `integer`	The quantity of the product units
DISCOUNT_TYPE_ID `integer`	The type of discount Possible types: `1` - Absolute `2` - Percentage
DISCOUNT_RATE `double`	The discount value in percentage (if using the percentage discount type)
DISCOUNT_SUM `double`	The absolute value of the discount (if using the absolute discount type)
TAX_RATE `double`	The tax rate in percentage
TAX_INCLUDED `char`	Indicator of whether 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`	The code of the unit of measure
MEASURE_NAME `string`	The textual representation of the unit of measure (e.g., pcs, kg, m, l, etc.)
SORT `integer`	Sorting
XML_ID `string`	The external code of the product
TYPE `integer`	The type of product Possible values: `1` - Simple product `4` - Trade offer/variation `7` - Service
STORE_ID `integer`	The identifier of the warehouse. For more detailed information about the warehouse, use `catalog.store.get`
RESERVE_ID `integer`	The identifier of the reserve
DATE_RESERVE_END `date`	The date of the end of the reservation
RESERVE_QUANTITY `integer`	The 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	An incorrect value was passed in the `id` parameter
Access denied	The user does not have "read" access permission for the deal
Not found	The deal with the provided `id` was not found

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 permitted for calls 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 HTTPS protocol is required for method calls
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is only available on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user associated with the access token or webhook used to call the method lacks the necessary 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 portal administrator has restricted access to this application to specific users only
`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 "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

Set Products in Deal crm.deal.productrows.set

Set products in a deal

Overview of Events

Get Deal Products crm.deal.productrows.get

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