Получить список документов складского учета catalog.document.list
Scope:
catalogКто может выполнять метод: пользователь с правом «Просмотр каталога товаров»
Метод catalog.document.list возвращает постраничный список документов складского учета. По умолчанию к запросу добавляются фильтры, ограничивающие выборку доступными типами документов и правами текущего пользователя.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
select |
Массив со списком полей catalog_document, которые необходимо выбрать. Если массив не передан или передан пустой массив, то будут выбраны все доступные поля документа |
|
filter |
Объект для фильтрации выбранных документов в формате Возможные значения для Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных документов в формате Возможные значения для Возможные значения для
По умолчанию документы упорядочены по возрастанию |
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы — 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"select": ["id","docType","docNumber","title","status","dateDocument","total"],
"filter": {">=dateCreate":"2025-10-01T00:00:00+03:00","<=dateCreate":"2025-10-15T23:59:59+03:00"},
"order": {"id":"ASC"},
"start": 50
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"select": ["id","docType","docNumber","title","status","dateDocument","total"],
"filter": {">=dateCreate":"2025-10-01T00:00:00+03:00","<=dateCreate":"2025-10-15T23:59:59+03:00"},
"order": {"id":"ASC"},
"start": 50,
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/catalog.document.list
// callListMethod: Получает все данные сразу.
// Используйте только для небольших выборок (< 1000 элементов) из-за высокой
// нагрузки на память.
try {
const response = await $b24.callListMethod(
'catalog.document.list',
{
select: ['id', 'docType', 'title', 'status'],
filter: { '>=dateCreate': '2025-10-01T00:00:00+03:00', '<=dateCreate': '2025-10-15T23:59:59+03:00' },
order: { id: 'ASC' }
},
(progress: number) => { console.log('Progress:', progress) }
);
const items = response.getData() || [];
for (const entity of items) { console.log('Entity:', entity) }
} catch (error: any) {
console.error('Request failed', error)
}
// fetchListMethod: Выбирает данные по частям с помощью итератора.
// Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('catalog.document.list', {
select: ['id', 'docType', 'title', 'status'],
filter: { '>=dateCreate': '2025-10-01T00:00:00+03:00', '<=dateCreate': '2025-10-15T23:59:59+03:00' },
order: { id: 'ASC' },
}, 'ID');
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity) }
}
} catch (error: any) {
console.error('Request failed', error)
}
// callMethod: Ручное управление постраничной навигацией через параметр start.
// Используйте для точного контроля над пакетами запросов.
// Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('catalog.document.list', {
select: ['id', 'docType', 'title', 'status'],
filter: { '>=dateCreate': '2025-10-01T00:00:00+03:00', '<=dateCreate': '2025-10-15T23:59:59+03:00' },
order: { id: 'ASC' },
}, 0);
const result = response.getData().result || [];
for (const entity of result) { console.log('Entity:', entity) }
} catch (error: any) {
console.error('Request failed', error)
}
try {
$response = $b24Service
->core
->call(
'catalog.document.list',
[
'select' => ['id', 'docType', 'docNumber', 'title', 'status', 'dateDocument', 'total'],
'filter' => [
'>=dateCreate' => '2025-10-01T00:00:00+03:00',
'<=dateCreate' => '2025-10-15T23:59:59+03:00',
],
'order' => ['ID' => 'ASC'],
'start' => 50, // значение next из предыдущего ответа
]
);
$payload = $response
->getResponseData()
->getResult();
print_r($payload['documents']);
$next = $response
->getResponseData()
->getNext();
echo PHP_EOL . 'next: ' . ($next ?? 'null');
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error loading documents: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.document.list',
{
select: ['id', 'docType', 'title', 'status'],
filter: { '>=dateCreate': '2025-10-01T00:00:00+03:00', '<=dateCreate': '2025-10-15T23:59:59+03:00' },
order: { id: 'ASC' },
start: '50'
},
function(result)
{
if (result.error())
{
console.error(result.error());
return;
}
console.table(result.data().documents);
if (result.more())
{
result.next(); // подставит значение из ответа в start и повторит запрос
}
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.document.list',
[
'select' => ['id', 'docType', 'docNumber', 'title', 'status', 'dateDocument', 'total'],
'filter' => [
'>=dateCreate' => '2025-10-01T00:00:00+03:00',
'<=dateCreate' => '2025-10-15T23:59:59+03:00',
],
'order' => ['ID' => 'ASC'],
'start' => 50,
]
);
echo '<PRE>';
print_r($result['result']['documents']);
echo PHP_EOL . 'next: ' . ($result['next'] ?? 'null');
echo '</PRE>';
Обработка ответа
HTTP-код: 200
{
"result": {
"documents": [
{
"docType": "S",
"id": 1,
"status": "Y",
"title": "Оприходование #2"
},
{
"docType": "A",
"id": 7,
"status": "N",
"title": "Тест рест"
},
// ...другие документы
{
"docType": "S",
"id": 105,
"status": "N",
"title": "оприходование 10"
}
]
},
"next": 50,
"total": 143,
"time": {
"start": 1761914886,
"finish": 1761914886.802491,
"duration": 0.8024909496307373,
"processing": 0,
"date_start": "2025-10-31T15:48:06+03:00",
"date_finish": "2025-10-31T15:48:06+03:00",
"operating_reset_at": 1761915486,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
documents |
Список документов, структура ответа зависит от параметра |
|
next |
Указатель смещения для следующей страницы. Передайте значение в параметр |
|
total |
Общее количество документов |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
HTTP-код: 400
{
"error": "0",
"error_description": "Недостаточно прав для сохранения документа"
}
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Недостаточно прав для сохранения документа |
У пользователя нет права на просмотр |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Изменить документ складского учета catalog.document.update
- Получить список товаров в документах складского учета catalog.document.element.list
- Получить список привязок поставщиков к документам catalog.documentcontractor.list