Добавить товар в документ складского учета catalog.document.element.add

Scope: catalog

Кто может выполнять метод:

пользователь с правом «Cоздание и редактирование» на тип документа в запросе,

и «Просмотр и выбор склада» на склад прихода или списания.

Метод catalog.document.element.add добавляет товарную позицию в документ складского учета.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
fields* `object`	Поля добавляемого товара (подробное описание)

Параметр fields

Обязательные параметры отмечены *

Название `тип`	Описание
docId* `catalog_document.id`	Идентификатор документа складского учета, можно получить методом catalog.document.list. Документ должен иметь статус `N` — не проведен
elementId* `catalog_product.id`	Идентификатор товара каталога. Значение можно получить методами catalog.product.*
storeFrom `catalog_store.id`	Идентификатор склада-источника, можно получить методом catalog.store.list. Используется для документов списания
storeTo `catalog_store.id`	Идентификатор склада-получателя, можно получить методом catalog.store.list. Используется для документов поступления и перемещения
amount `double`	Количество товара. Значение указывается в единицах учета документа
purchasingPrice `double`	Закупочная цена в валюте документа

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"docId":64,"elementId":312,"storeTo":2,"amount":15,"purchasingPrice":1250.5}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.element.add

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"fields":{"docId":64,"elementId":312,"storeTo":2,"amount":15,"purchasingPrice":1250.5},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.document.element.add

try
        {
        	const response = await $b24.callMethod(
        		'catalog.document.element.add',
        		{
        			fields: {
        				docId: 64,
        				elementId: 312,
        				storeTo: 2,
        				amount: 15,
        				purchasingPrice: 1250.5
        			}
        		}
        	);
        
        	const result = response.getData().result;
        	console.log(result);
        }
        catch (error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.document.element.add',
                    [
                        'fields' => [
                            'docId' => 64,
                            'elementId' => 312,
                            'storeTo' => 2,
                            'amount' => 15,
                            'purchasingPrice' => 1250.5,
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error adding document element: ' . $e->getMessage();
        }

BX24.callMethod(
            'catalog.document.element.add',
            {
                fields: {
                    docId: 64,
                    elementId: 312,
                    storeTo: 2,
                    amount: 15,
                    purchasingPrice: 1250.5
                }
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.document.element.add',
            [
                'fields' => [
                    'docId' => 64,
                    'elementId' => 312,
                    'storeTo' => 2,
                    'amount' => 15,
                    'purchasingPrice' => 1250.5,
                ],
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-код: 200

{
            "result": {
                "documentElement": {
                    "amount": 15,
                    "docId": 64,
                    "elementId": 312,
                    "id": 148,
                    "purchasingPrice": 1250.5,
                    "storeFrom": null,
                    "storeTo": 2
                }
            },
            "time": {
                "start": 1759482001.102334,
                "finish": 1759482001.215487,
                "duration": 0.11315321922302246,
                "processing": 0.018451929092407227,
                "date_start": "2025-11-02T12:20:01+03:00",
                "date_finish": "2025-11-02T12:20:01+03:00",
                "operating": 0
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `object`	Корневой элемент ответа
documentElement `catalog_document_element`	Объект с информацией о добавленном товаре
time `time`	Информация о времени выполнения запроса

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

HTTP-код: 400

{
            "error": "ERROR_DOCUMENT_STATUS",
            "error_description": "Conducted document"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
`ERROR_DOCUMENT_RIGHTS`	Access denied	Недостаточно прав на документ или один из указанных складов
`ERROR_DOCUMENT_STATUS`	Document not found / Conducted document	Документ не найден, недоступен или уже проведен
`0`	Error of adding new document element	Внутренняя ошибка при сохранении позиции

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Обзор методов

Изменить товар в документе

Добавить товар в документ складского учета catalog.document.element.add

Параметры методаПараметры метода

Параметр fieldsПараметр fields

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

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

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение