метод REST scope: catalog

catalog.document.element.list

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

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

Описание

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

Параметры

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

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

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

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

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

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

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

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

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

Возможные значения для order:
- asc — в порядке возрастания,
- desc — в порядке убывания

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

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

Размер страницы результатов всегда статичный — 50 записей.

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

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

start = (N-1) * 50, где N — номер нужной страницы

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

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

Ответ

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 object

Корневой элемент ответа

documentElements catalog_document_element[]

Массив объектов с информацией о товарах документа, структура ответа зависит от параметра select

next integer

Значение для получения следующей страницы

total integer

Общее количество записей

time time

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

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

HTTP-статус: 400

{
    "error": "ERROR_DOCUMENT_RIGHTS",
    "error_description": "Access denied"
}
Код Описание Значение
ERROR_DOCUMENT_RIGHTS Access denied Недостаточно прав на чтение
0 Прочие ошибки обработки

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

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