Get Deal Products crm.deal.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: 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 -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
        
// 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 each product row returned in result[]
        type CrmDealProductRow = {
          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
        }
        
        try {
          const response = await $b24.actions.v2.call.make<CrmDealProductRow[]>({
            method: 'crm.deal.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 getDealProductRows() {
            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.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', getDealProductRows)
        </script>
        

        from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.crm.deal.productrows.get(bitrix_id=123).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.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>';
        
// client and ctx are already created — see the Go SDK section
        res, err := client.Core().Call(ctx, "crm.deal.productrows.get", b24.Params{
        	"id": 5,
        }, b24.WithIdempotent())
        if err != nil {
        	return fmt.Errorf("crm.deal.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": "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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

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 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: 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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

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

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

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 — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not 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

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

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 provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

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