Get List of Products in Inventory Documents v 3.0 catalog.document.element.list
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:
catalogWho can execute the method: a user with the "View product catalog" or "View and select warehouses" permission
The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The catalog.document.element.list method returns a list of product items of inventory documents.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
select |
Array of product item fields to return in the response. Available fields:
The Default: all fields |
|
filter |
Filter in the REST 3.0 format: an array of conditions of the form You can filter by all fields from the The method returns items only of the documents and warehouses available to the user |
|
order |
Sorting in the format Possible direction values:
You can sort by the |
|
pagination |
Pagination. Object description |
Parameter pagination
|
Name |
Description |
|
limit |
Number of records per page. Values greater than Default: |
|
page |
Page number, starting from |
|
offset |
Number of records to skip |
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/catalog.document.element.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":[["docId","=",325]],"select":["id","elementId","storeTo","amount","purchasingPrice"],"order":{"id":"asc"},"pagination":{"limit":10}}' \
https://**put_your_bitrix24_address**/rest/api/**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 '{"filter":[["docId","=",325]],"select":["id","elementId","storeTo","amount","purchasingPrice"],"order":{"id":"asc"},"pagination":{"limit":10},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.document.element.list
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type DocumentElementListResult = {
items: Array<{
id: number
elementId?: number
storeTo?: number
amount?: number
purchasingPrice?: number
}>
}
try {
const response = await $b24.actions.v3.call.make<DocumentElementListResult>({
method: 'catalog.document.element.list',
params: {
filter: [
['docId', '=', 325],
],
select: ['id', 'elementId', 'storeTo', 'amount', 'purchasingPrice'],
order: {
id: 'asc',
},
pagination: {
limit: 10,
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Elements:', result.items.length)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function documentElementList() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.document.element.list',
params: {
filter: [
['docId', '=', 325],
],
select: ['id', 'elementId', 'storeTo', 'amount', 'purchasingPrice'],
order: {
id: 'asc',
},
pagination: {
limit: 10,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Elements:', result.items.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', documentElementList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.document.element.list(
filter=[
["docId", "=", 325],
],
select=["id", "elementId", "storeTo", "amount", "purchasingPrice"],
order={
"id": "asc",
},
pagination={
"limit": 10,
},
).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}")
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
try {
$response = $b24Service
->core
->call(
'catalog.document.element.list',
[
'filter' => [
['docId', '=', 325],
],
'select' => ['id', 'elementId', 'storeTo', 'amount', 'purchasingPrice'],
'order' => [
'id' => 'asc',
],
'pagination' => [
'limit' => 10,
],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
BX24.callMethod(
'catalog.document.element.list',
{
filter: [
['docId', '=', 325],
],
select: ['id', 'elementId', 'storeTo', 'amount', 'purchasingPrice'],
order: {
id: 'asc',
},
pagination: {
limit: 10,
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
require_once('crest.php');
$result = CRest::call(
'catalog.document.element.list',
[
'filter' => [
['docId', '=', 325],
],
'select' => ['id', 'elementId', 'storeTo', 'amount', 'purchasingPrice'],
'order' => [
'id' => 'asc',
],
'pagination' => [
'limit' => 10,
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "catalog.document.element.list", b24.Params{
"filter": []any{
[]any{"docId", "=", 325},
},
"select": []string{"id", "elementId", "storeTo", "amount", "purchasingPrice"},
"order": b24.Params{
"id": "asc",
},
"pagination": b24.Params{
"limit": 10,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.document.element.list: %w", err)
}
var result struct {
Items []struct {
ID int `json:"id"`
ElementID int `json:"elementId"`
Amount float64 `json:"amount"`
} `json:"items"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, item := range result.Items {
fmt.Println(item.ID, item.ElementID, item.Amount)
}
Response Handling
HTTP status: 200
{
"result": {
"items": [
{
"id": 59,
"storeTo": 17,
"elementId": 7573,
"amount": 5,
"purchasingPrice": 120
},
{
"id": 65,
"storeTo": 17,
"elementId": 7571,
"amount": 10,
"purchasingPrice": 450
}
]
},
"time": {
"start": 1792665368,
"finish": 1792665368.395274,
"duration": 0.39527392387390137,
"processing": 0,
"date_start": "2026-10-22T13:36:08+02:00",
"date_finish": "2026-10-22T13:36:08+02:00",
"operating_reset_at": 1792665960,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Response data object |
|
result.items |
Array of product items. The set of fields depends on |
|
time |
Information about the request execution time |
Items Element
|
Name |
Description |
|
id |
Identifier of the document product item |
|
docId |
Identifier of the inventory document |
|
storeFrom |
Identifier of the source warehouse. |
|
storeTo |
Identifier of the receiving warehouse. |
|
elementId |
Product identifier |
|
amount |
Product quantity |
|
purchasingPrice |
Purchase price in the document currency |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Error validating request object.",
"validation": [
{
"message": "DTO \"DocumentElementDto\" in field \"storeTo\" requires attribute \"Sortable\" to perform this request.",
"field": "storeTo"
}
]
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
DTO |
Remove |
Unknown Field Error
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Specify only the fields from the |
Filter Format Error
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Invalid filter |
Pass |
Sorting Format Error
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDORDEREXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Invalid sort order |
Pass the |
Pagination Error
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Incorrect |
Pass a number from |
Access Error
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Access denied |
Make sure the user has the "View product catalog" or "View and select warehouses" permission |
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 |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
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 |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
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 — |
|
|
|
No active webhook with the specified user identifier and secret code was 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 |
|
|
|
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 |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
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
- Add Product to Inventory Document v 3.0 catalog.document.element.add
- Update Product in Inventory Document v 3.0 catalog.document.element.update
- Remove Product from Inventory Document v 3.0 catalog.document.element.delete
- Get List of Inventory Document Product Fields v 3.0 catalog.document.element.field.list
- Get Inventory Document Product Field catalog.document.element.field.get
- Get List of Inventory Documents v 3.0 catalog.document.list