Get a list of products in inventory documents catalog.document.element.list

Scope: catalog

Who can execute the method: users with the "View product catalog" access permission

The method catalog.document.element.list returns product positions associated with inventory documents. Records are automatically limited by available document types and the user's permissions on warehouses.

Method Parameters

Required parameters are marked with *

Name
type

Description

select
array

An array of fields from catalog_document_element that need to be selected

filter
object

An object for filtering selected product records in the format {"field_1": "value_1", ..., "field_N": "value_N"}.

Possible values for field correspond to the fields of the catalog_document_element object.

An additional prefix can be set for the key to specify the filter behavior. Possible prefix values:

  • >= — greater than or equal to,
  • > — greater than,
  • <= — less than or equal to,
  • < — less than,
  • @ — IN, an array is passed as the value,
  • !@ — NOT IN, an array is passed as the value,
  • = — equal, exact match, used by default,
  • != — not equal,
  • ! — not equal

order
object

An object for sorting selected product records in the format {"field_1": "order_1", ... "field_N": "order_N"}.

Possible values for field correspond to the fields of the catalog_document_element object.

Possible values for order:

  • asc — in ascending order,
  • desc — in descending order

start
integer

This parameter is used for managing pagination.

The page size of results is always static — 50 records.

To select the second page of results, pass the value 50. To select the third page of results — the value 100, and so on.

The formula for calculating the start parameter value:

start = (N-1) * 50, where N — the desired page number

Code Examples

How to Use Examples in Documentation

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","docId","elementId","amount","storeFrom","storeTo"],"filter":{"docId":64},"order":{"id":"ASC"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.element.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"select":["id","docId","elementId","amount","storeFrom","storeTo"],"filter":{"docId":64},"order":{"id":"ASC"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.document.element.list
        
// callListMethod: Retrieves all data at once.
        // Use only for small selections (< 1000 items) due to high
        // memory load.
        
        try {
        const response = await $b24.callListMethod(
            'catalog.document.element.list',
            {
            select: [
                'id',
                'docId',
                'elementId',
                'amount',
                'storeFrom',
                'storeTo'
            ],
            filter: {
                docId: 64
            },
            order: {
                id: 'ASC'
            }
            },
            (progress) => { console.log('Progress:', progress) }
        );
        const items = response.getData() || [];
        for (const entity of items) { console.log('Entity:', entity) }
        } catch (error) {
        console.error('Request failed', error)
        }
        
        // fetchListMethod: Retrieves data in parts using an iterator.
        // Use for large volumes of data for efficient memory consumption.
        
        try {
        const generator = $b24.fetchListMethod('catalog.document.element.list', {
            select: [
            'id',
            'docId',
            'elementId',
            'amount',
            'storeFrom',
            'storeTo'
            ],
            filter: {
            docId: 64
            },
            order: {
            id: 'ASC'
            }
        }, 'ID');
        for await (const page of generator) {
            for (const entity of page) { console.log('Entity:', entity) }
        }
        } catch (error) {
        console.error('Request failed', error)
        }
        
        // callMethod: Manual control of pagination through the start parameter.
        // Use for precise control over request batches.
        // Less efficient for large data than fetchListMethod.
        
        try {
        const response = await $b24.callMethod('catalog.document.element.list', {
            select: [
            'id',
            'docId',
            'elementId',
            'amount',
            'storeFrom',
            'storeTo'
            ],
            filter: {
            docId: 64
            },
            order: {
            id: 'ASC'
            }
        }, 0);
        const result = response.getData().result || [];
        for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
        console.error('Request failed', error)
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.document.element.list',
                    [
                        'select' => [
                            'id',
                            'docId',
                            'elementId',
                            'amount',
                            'storeFrom',
                            'storeTo',
                            'purchasingPrice'
                        ],
                        'filter' => [
                            'docId' => 64
                        ],
                        'order' => [
                            'id' => 'ASC'
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            $result->next();
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching document elements: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'catalog.document.element.list',
            {
                select: [
                    'id',
                    'docId',
                    'elementId',
                    'amount',
                    'storeFrom',
                    'storeTo'
                ],
                filter: {
                    docId: 64
                },
                order: {
                    id: 'ASC'
                }
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
        
                result.next();
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'catalog.document.element.list',
            [
                'select' => [
                    'id',
                    'docId',
                    'elementId',
                    'amount',
                    'storeFrom',
                    'storeTo'
                ],
                'filter' => [
                    'docId' => 64
                ],
                'order' => [
                    'id' => 'ASC'
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';
        

Response Handling

HTTP status: 200

{
            "result": {
                "documentElements": [
                    {
                        "amount": 5,
                        "docId": 64,
                        "elementId": 312,
                        "id": 148,
                        "purchasingPrice": 1180,
                        "storeFrom": null,
                        "storeTo": 2
                    },
                    {
                        "amount": 12,
                        "docId": 64,
                        "elementId": 420,
                        "id": 149,
                        "purchasingPrice": 560,
                        "storeFrom": null,
                        "storeTo": 2
                    }
                ]
            },
            "total": 2,
            "time": {
                "start": 1759482402.511337,
                "finish": 1759482402.642843,
                "duration": 0.13150620460510254,
                "processing": 0.02694106101989746,
                "date_start": "2025-11-02T12:26:42+02:00",
                "date_finish": "2025-11-02T12:26:42+02:00",
                "operating": 0
            }
        }
        

Returned Data

Name
type

Description

result
object

Root element of the response

documentElement
catalog_document_element[]

Object with information about the document products, the response structure depends on the select parameter

total
integer

Total number of records

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": "ERROR_DOCUMENT_RIGHTS",
            "error_description": "Access denied"
        }
        

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

Code

Description

Value

ERROR_DOCUMENT_RIGHTS

Access denied

Insufficient rights to read

0

Other processing errors

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