Получить список товаров в документах складского учета catalog.document.element.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: пользователи с правом «Просмотр каталога товаров»
Метод catalog.document.element.list возвращает позиции товаров, связанные с документами складского учета. Записи автоматически ограничиваются доступными типами документов и правами пользователя на склады.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
select |
Массив со списком полей catalog_document_element, которые необходимо выбрать |
|
filter |
Объект для фильтрации выбранных записей товаров в формате Возможные значения для Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных записей товаров в формате Возможные значения для Возможные значения для
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
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
// 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
type DocumentElement = {
id: number
docId: number
elementId: number
amount: number
purchasingPrice: number
storeFrom: number | null
storeTo: number | null
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type DocumentElementListResult = {
documentElements: DocumentElement[]
}
try {
// catalog.document.element.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<DocumentElementListResult>({
method: 'catalog.document.element.list',
params: {
select: [
'id',
'docId',
'elementId',
'amount',
'storeFrom',
'storeTo',
],
filter: {
docId: 64,
},
order: {
id: 'ASC',
},
start: 0,
},
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(result.documentElements.length, result.documentElements)
}
} 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 listDocumentElements() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// catalog.document.element.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'catalog.document.element.list',
params: {
select: [
'id',
'docId',
'elementId',
'amount',
'storeFrom',
'storeTo',
],
filter: {
docId: 64,
},
order: {
id: 'ASC',
},
start: 0,
},
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(result.documentElements.length, result.documentElements)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listDocumentElements)
</script>
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>';
Обработка ответа
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
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
documentElement |
Объект с информацией о товарах документа, структура ответа зависит от параметра |
|
total |
Общее количество записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_DOCUMENT_RIGHTS",
"error_description": "Access denied"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Access denied |
Недостаточно прав на чтение |
|
|
Прочие ошибки обработки |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Получить список полей товаров для документа складского учета catalog.document.element.getFields
- Добавить товар в документ складского учета catalog.document.element.add
- Обновить товар в документе складского учета catalog.document.element.update
- Удалить товар из документа складского учета catalog.document.element.delete