Get a list of products in inventory documents catalog.document.element.list
Scope:
catalogWho 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 |
Description |
|
select |
An array of fields from catalog_document_element that need to be selected |
|
filter |
An object for filtering selected product records in the format Possible values for An additional prefix can be set for the key to specify the filter behavior. Possible prefix values:
|
|
order |
An object for sorting selected product records in the format Possible values for Possible values for
|
|
start |
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 The formula for calculating the
|
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 |
Description |
|
result |
Root element of the response |
|
documentElement |
Object with information about the document products, the response structure depends on the |
|
total |
Total number of records |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "ERROR_DOCUMENT_RIGHTS",
"error_description": "Access denied"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
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 |
|
|
Access denied |
Insufficient rights to read |
|
|
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 |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- Get the list of product fields for the inventory document catalog.document.element.getFields
- Add Product to Inventory Document catalog.document.element.add
- Update Product in Inventory Document catalog.document.element.update
- Delete Item from Inventory Document catalog.document.element.delete