При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Получить список товаров в документах складского учета catalog.document.elemen…», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.
Получить список товаров в документах складского учета catalog.document.element.list
> Scope: catalog
>
> Кто может выполнять метод: пользователи с правом «Просмотр каталога товаров»
Метод catalog.document.element.list возвращает позиции товаров, связанные с документами складского учета. Записи автоматически ограничиваются доступными типами документов и правами пользователя на склады.
Параметры метода
Названиетип | Описание |
|---|---|
selectarray | Массив со списком полей catalog_document_element, которые необходимо выбрать |
filterobject | Объект для фильтрации выбранных записей товаров в формате {"field_1": "value_1", ..., "field_N": "value_N"}.Возможные значения для Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса: |
orderobject | Объект для сортировки выбранных записей товаров в формате {"field_1": "order_1", ... "field_N": "order_N"}.Возможные значения для Возможные значения для |
startinteger | Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
|
Примеры кода
- cURL (Webhook)
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_webbhook_here**/catalog.document.element.list- cURL (OAuth)
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- JS
// callListMethod: Получает все данные сразу.
// Используйте только для небольших выборок (< 1000 элементов) из-за высокой
// нагрузки на память.
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: Выбирает данные по частям с помощью итератора.
// Используйте для больших объемов данных для эффективного потребления памяти.
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: Ручное управление постраничной навигацией через параметр start.
// Используйте для точного контроля над пакетами запросов.
// Для больших данных менее эффективен, чем 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)
}- PHP
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.js
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();
}
);- PHP CRest
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>';Обработка ответа
HTTP-статус: 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+03:00",
"date_finish": "2025-11-02T12:26:42+03:00",
"operating": 0
}
}Возвращаемые данные
Названиетип | Описание |
|---|---|
resultobject | Корневой элемент ответа |
documentElementcatalog_document_element[] | Объект с информацией о товарах документа, структура ответа зависит от параметра select |
totalinteger | Общее количество записей |
timetime | Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_DOCUMENT_RIGHTS",
"error_description": "Access denied"
}Возможные коды ошибок
| Код | Описание | Значение |
|---|---|---|
ERROR_DOCUMENT_RIGHTS | Access denied | Недостаточно прав на чтение |
0 | Прочие ошибки обработки |
- [](./catalog-document-element-get-fields)
- [](./catalog-document-element-add)
- [](./catalog-document-element-update)
- [](./catalog-document-element-delete)
💡 Экспертное мнение и рекомендации
Практические рекомендации:
- При написании кастомных компонентов для «Получить список товаров в документах складского учета catalog.document.elemen…» всегда разделяйте бизнес-логику и представление (шаблон).
- Используйте отладку SQL-запросов через конструкцию
$wpdb->last_queryили стандартный трекер Битрикса, чтобы контролировать нагрузку.
Похожая задача в бизнесе?
Помогу автоматизировать процессы и внедрить ИИ
Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.
или на почту: gorandvas@yandex.ru