Добавить товар в документ складского учета v 3.0 catalog.document.element.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: пользователь с правом «Создание и редактирование» для документов этого типа и правом «Просмотр и выбор склада» для складов товарной позиции
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод catalog.document.element.add добавляет товарную позицию в документ складского учета и возвращает ее поля.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Объект с полями новой товарной позиции. Описание полей |
Параметр fields
|
Название |
Описание |
|
docId* |
Идентификатор документа складского учета. Документ не должен быть проведен. Идентификатор можно получить методом catalog.document.list или из ответа catalog.document.add |
|
elementId* |
Идентификатор товара. Идентификатор можно получить методом catalog.product.list |
|
storeFrom |
Идентификатор склада, с которого списывается товар. Используется в документах списания, реализации и перемещения. Идентификатор можно получить методом catalog.store.list |
|
storeTo |
Идентификатор склада, на который поступает товар. Используется в документах прихода, оприходования и перемещения. Идентификатор можно получить методом catalog.store.list |
|
amount |
Количество товара |
|
purchasingPrice |
Закупочная цена в валюте документа |
Поле id заполняется автоматически. Если передать его в fields, метод вернет ошибку.
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/catalog.document.element.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"docId":325,"storeTo":17,"elementId":7573,"amount":3,"purchasingPrice":115}}' \
https://**put_your_bitrix24_address**/rest/api/**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":325,"storeTo":17,"elementId":7573,"amount":3,"purchasingPrice":115},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.document.element.add
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type DocumentElementAddResult = {
item: {
id: number
docId: number
storeFrom: number
storeTo: number
elementId: number
amount: number
purchasingPrice: number
}
}
try {
const response = await $b24.actions.v3.call.make<DocumentElementAddResult>({
method: 'catalog.document.element.add',
params: {
fields: {
docId: 325,
storeTo: 17,
elementId: 7573,
amount: 3,
purchasingPrice: 115,
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Element added:', result.item.id)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function documentElementAdd() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.document.element.add',
params: {
fields: {
docId: 325,
storeTo: 17,
elementId: 7573,
amount: 3,
purchasingPrice: 115,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Element added:', result.item.id)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', documentElementAdd)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.document.element.add(
fields={
"docId": 325,
"storeTo": 17,
"elementId": 7573,
"amount": 3,
"purchasingPrice": 115,
},
).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}")
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
try {
$response = $b24Service
->core
->call(
'catalog.document.element.add',
[
'fields' => [
'docId' => 325,
'storeTo' => 17,
'elementId' => 7573,
'amount' => 3,
'purchasingPrice' => 115,
],
]
);
$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: ' . $e->getMessage();
}
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
BX24.callMethod(
'catalog.document.element.add',
{
fields: {
docId: 325,
storeTo: 17,
elementId: 7573,
amount: 3,
purchasingPrice: 115,
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.
require_once('crest.php');
$result = CRest::call(
'catalog.document.element.add',
[
'fields' => [
'docId' => 325,
'storeTo' => 17,
'elementId' => 7573,
'amount' => 3,
'purchasingPrice' => 115,
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.document.element.add", b24.Params{
"fields": b24.Params{
"docId": 325,
"storeTo": 17,
"elementId": 7573,
"amount": 3,
"purchasingPrice": 115,
},
})
if err != nil {
return fmt.Errorf("catalog.document.element.add: %w", err)
}
// Метод заворачивает ответ в объект с ключом "item".
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("в ответе нет ключа item")
}
var item struct {
ID int `json:"id"`
DocID int `json:"docId"`
ElementID int `json:"elementId"`
Amount float64 `json:"amount"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Amount)
Обработка ответа
HTTP-статус: 200
{
"result": {
"item": {
"id": 67,
"docId": 325,
"storeFrom": 0,
"storeTo": 17,
"elementId": 7573,
"amount": 3,
"purchasingPrice": 115
}
},
"time": {
"start": 1792665369,
"finish": 1792665369.641646,
"duration": 0.6416459083557129,
"processing": 0,
"date_start": "2026-10-22T13:36:09+03:00",
"date_finish": "2026-10-22T13:36:09+03:00",
"operating_reset_at": 1792665960,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект с данными ответа |
|
result.item |
Поля добавленной товарной позиции. Описание полей |
|
time |
Информация о времени выполнения запроса |
Объект item
|
Название |
Описание |
|
id |
Идентификатор товарной позиции документа |
|
docId |
Идентификатор документа складского учета |
|
storeFrom |
Идентификатор склада, с которого списывается товар. |
|
storeTo |
Идентификатор склада, на который поступает товар. |
|
elementId |
Идентификатор товара |
|
amount |
Количество товара |
|
purchasingPrice |
Закупочная цена в валюте документа |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
"message": "Ошибка при валидации объекта запроса",
"validation": [
{
"message": "Conducted document",
"field": "ERROR_DOCUMENT_STATUS"
}
]
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибки валидации объекта
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не заполнено обязательное поле "docId" |
Передайте |
|
|
Не заполнено обязательное поле "elementId" |
Передайте |
|
|
Поле "id" не доступно к заполнению |
Уберите |
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Обязательное поле |
Передайте объект |
|
|
В поле |
Передайте целое число |
|
|
В поле |
Передайте число |
|
|
Conducted document |
Документ проведен. Отмените проведение методом catalog.document.cancel и повторите запрос |
|
|
Error of adding new document element |
Товарная позиция не сохранена. Проверьте значения полей и повторите запрос |
Ошибка отсутствия объекта
Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Запись с ID = |
Документа с идентификатором |
Ошибка неизвестного поля
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Передайте в |
Ошибка доступа
Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Доступ запрещен |
Проверьте права на документы этого типа и на склады товарной позиции |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Обновить товар в документе складского учета v 3.0 catalog.document.element.update
- Получить список товаров в документах складского учета v 3.0 catalog.document.element.list
- Удалить товар из документа складского учета v 3.0 catalog.document.element.delete
- Получить список полей товаров для документа складского учета v 3.0 catalog.document.element.field.list
- Получить поле товара в документе складского учета catalog.document.element.field.get
- Получить список документов складского учета v 3.0 catalog.document.list