метод REST scope: catalog

catalog.document.list

Получить список документов складского учета

Кто может выполнять: пользователь с правом «Просмотр каталога товаров»

Описание

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

Параметры

select array необязательный

Массив со списком полей catalog_document, которые необходимо выбрать.

Если массив не передан или передан пустой массив, то будут выбраны все доступные поля документа

filter object необязательный

Объект для фильтрации выбранных документов в формате {"field_1": "value_1", ..., "field_N": "value_N"}.

Возможные значения для field соответствуют полям объекта catalog_document.

Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- = — точное совпадение
- !=, ! — не равно
- @ — IN, в качестве значения передается массив
- !@ — NOT IN, в качестве значения передается массив
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, начинающиеся с «мол»
- "%мол" — ищет значения, заканчивающиеся на «мол»
- "%мол%" — ищет значения, где «мол» может быть в любой позиции
- !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обеих сторон
- !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, не начинающиеся с «мол»
- "%мол" — ищет значения, не заканчивающиеся на «мол»
- "%мол%" — ищет значения, где подстроки «мол» нет в любой позиции
- = — равно, точное совпадение, используется по умолчанию
- != — не равно
- ! — не равно

order object необязательный

Объект для сортировки выбранных документов в формате {"field_1": "order_1", ... "field_N": "order_N"}.

Возможные значения для field соответствуют полям объекта catalog_document.

Возможные значения для order:

  • asc — в порядке возрастания
  • desc — в порядке убывания

По умолчанию документы упорядочены по возрастанию id

start integer необязательный

Параметр используется для управления постраничной навигацией.

Размер страницы — 50 записей.

Чтобы выбрать вторую страницу результатов, передайте значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы.
Или передавайте значение из ключа next ответа

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

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

Ответ

{
    "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

Информация о времени выполнения запроса

Обработка ошибок

{
    "error": "0",
    "error_description": "Недостаточно прав для сохранения документа"
}
Код Описание Значение
0 Недостаточно прав для сохранения документа У пользователя нет права на просмотр

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.