# catalog.document.list

URL: https://chugunov.pro/api-bitrix24/catalog/document/catalog-document-list/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Получить список документов складского учета
Scope: `catalog`
Кто может выполнять метод: пользователь с правом «Просмотр каталога товаров»

## Описание

Метод `catalog.document.list` возвращает постраничный список документов складского учета. По умолчанию к запросу добавляются фильтры, ограничивающие выборку доступными типами документов и правами текущего пользователя.

## Параметры

- `select` `array` — необязательный. Массив со списком полей [catalog_document](https://apidocs.bitrix24.ru/api-reference/catalog/data-types.html#catalog_document), которые необходимо выбрать.
  Если массив не передан или передан пустой массив, то будут выбраны все доступные поля документа
- `filter` `object` — необязательный. Объект для фильтрации выбранных документов в формате `{"field_1": "value_1", ..., "field_N": "value_N"}`.
  Возможные значения для `field` соответствуют полям объекта [catalog_document](https://apidocs.bitrix24.ru/api-reference/catalog/data-types.html#catalog_document).
  Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
  - `>=` — больше либо равно
  - `>` — больше
  - `<=` — меньше либо равно
  - `<` — меньше
  - `=` — точное совпадение
  - `!=`, `!` — не равно
  - `@` — IN, в качестве значения передается массив
  - `!@` — NOT IN, в качестве значения передается массив
  - `%` — LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  - `=%` — LIKE, поиск по подстроке. Символ `%` нужно передавать в значении. Примеры:
      - `"мол%"` — ищет значения, начинающиеся с «мол»
      - `"%мол"` — ищет значения, заканчивающиеся на «мол»
      - `"%мол%"` — ищет значения, где «мол» может быть в любой позиции
  - `!%` — NOT LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно. Поиск идет с обеих сторон
  - `!=%` — NOT LIKE, поиск по подстроке. Символ `%` нужно передавать в значении. Примеры:
      - `"мол%"` — ищет значения, не начинающиеся с «мол»
      - `"%мол"` — ищет значения, не заканчивающиеся на «мол»
      - `"%мол%"` — ищет значения, где подстроки «мол» нет в любой позиции
  - `=` — равно, точное совпадение, используется по умолчанию
  - `!=` — не равно
  - `!` — не равно
- `order` `object` — необязательный. Объект для сортировки выбранных документов в формате `{"field_1": "order_1", ... "field_N": "order_N"}`.
  Возможные значения для `field` соответствуют полям объекта [catalog_document](https://apidocs.bitrix24.ru/api-reference/catalog/data-types.html#catalog_document).
  Возможные значения для `order`:
  - `asc` — в порядке возрастания
  - `desc` — в порядке убывания 
  По умолчанию документы упорядочены по возрастанию `id`
- `start` `integer` — необязательный. Параметр используется для управления постраничной навигацией.
  Размер страницы — 50 записей.
  Чтобы выбрать вторую страницу результатов, передайте значение `50`. Чтобы выбрать третью страницу результатов — значение `100` и так далее.
  Формула расчета значения параметра `start`:
  `start = (N-1) * 50`, где `N` — номер нужной страницы. 
  Или передавайте значение из ключа `next` ответа

## Ответ

```json
{
    "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` `object`. Корневой элемент ответа
- `documents` `catalog_document[]`. Список документов, структура ответа зависит от параметра `select`
- `next` `integer`. Указатель смещения для следующей страницы. Передайте значение в параметр `start`, чтобы получить следующие 50 записей
- `total` `integer`. Общее количество документов
- `time` `time`. Информация о времени выполнения запроса

## Ошибки

```json
{
    "error": "0",
    "error_description": "Недостаточно прав для сохранения документа"
}
```

- `0` — Недостаточно прав для сохранения документа. У пользователя нет права на просмотр

## Примеры запроса

### cURL (Webhook)

```bash
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 (OAuth)

```bash
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
```

### JS (TS)

```ts
// 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

// Shape of the payload returned in result (match the "response handling" section of the page)
type DocumentListResult = {
  documents: {
    docType: string
    id: number
    status: string
    title: string
  }[]
}

try {
  // catalog.document.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<DocumentListResult>({
    method: 'catalog.document.list',
    params: {
      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: 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('Documents on this page:', result.documents.length, result.documents)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
```

### JS (UMD)

```html
<!-- 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 fetchDocumentList() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // catalog.document.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.list',
        params: {
          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: 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('Documents on this page:', result.documents.length, result.documents)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', fetchDocumentList)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.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,
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")
```

### PHP

```php
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.js

```js
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' }
    },
    function(result)
    {
        if (result.error())
        {
            console.error(result.error());
            return;
        }

        console.table(result.data().documents);

        if (result.more())
        {
            result.next(); // подставит значение из ответа в start и повторит запрос
        }
    }
);
```

### PHP CRest

```php
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>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.document.list", b24.Params{
	"select": []string{"id", "docType", "docNumber", "title", "status", "dateDocument", "total"},
	"filter": b24.Params{
		">=dateCreate": "2025-10-01T00:00:00+03:00",
		"<=dateCreate": "2025-10-15T23:59:59+03:00",
	},
	"order": b24.Params{
		"id": "ASC",
	},
	"start": 50,
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("catalog.document.list: %w", err)
}

// Метод заворачивает ответ в объект с ключом "documents".
raw, ok := b24.Unwrap(res.Result, "documents")
if !ok {
	return fmt.Errorf("в ответе нет ключа documents")
}

var items []struct {
	DocType string `json:"docType"`
	ID      b24.ID `json:"id"`
	Status  string `json:"status"`
	Title   string `json:"title"`
}
if err := json.Unmarshal(raw, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.DocType)
}
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/catalog/document/catalog-document-list.html