Добавить товар в документ складского учета catalog.document.element.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: пользователь с правом «Создание и редактирование» на документы этого типа и правом «Просмотр и выбор склада» на склады позиции
Метод catalog.document.element.add добавляет товарную позицию в непроведенный документ складского учета.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Поля товарной позиции (подробное описание) |
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
docId* |
Идентификатор документа складского учета. Документ должен быть не проведен, то есть иметь статус Идентификатор можно получить методом catalog.document.list |
|
elementId |
Идентификатор простого товара или вариации. Идентификатор можно получить методами catalog.product.list и catalog.product.offer.list. Метод не проверяет, что товар существует. Если поле не передано, метод создаст позицию без товара |
|
storeFrom |
Идентификатор склада списания. Заполняется в документах перемещения и списания. Идентификатор можно получить методом catalog.store.list |
|
storeTo |
Идентификатор склада поступления. Заполняется в документах прихода, оприходования, перемещения и возврата. Идентификатор можно получить методом catalog.store.list |
|
amount |
Количество товара. Значение, которое не является числом, метод сохраняет как |
|
purchasingPrice |
Закупочная цена за единицу в валюте документа. Значение, которое не является числом, метод сохраняет как |
Непереданные поля elementId, storeFrom, storeTo, amount и purchasingPrice в ответе равны null. Поле id метод заполняет сам: переданное значение и неизвестные поля метод пропускает без ошибки.
Метод не проверяет, что склады существуют и подходят к типу документа. Идентификаторы складов передавайте числом: массив, например [43], метод сохраняет как склад с идентификатором 1.
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"docId":371,"elementId":6595,"storeTo":43,"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":371,"elementId":6595,"storeTo":43,"amount":15,"purchasingPrice":1250.5},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.document.element.add
// 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 DocumentElementResult = {
documentElement: {
amount: number | null
docId: number
elementId: number | null
id: number
purchasingPrice: number | null
storeFrom: number | null
storeTo: number | null
}
}
try {
const response = await $b24.actions.v2.call.make<DocumentElementResult>({
method: 'catalog.document.element.add',
params: {
fields: {
docId: 371,
elementId: 6595,
storeTo: 43,
amount: 15,
purchasingPrice: 1250.5,
},
},
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(result.documentElement)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- 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 addDocumentElement() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.document.element.add',
params: {
fields: {
docId: 371,
elementId: 6595,
storeTo: 43,
amount: 15,
purchasingPrice: 1250.5,
},
},
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(result.documentElement)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addDocumentElement)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.document.element.add(
fields={
"docId": 371,
"elementId": 6595,
"storeTo": 43,
"amount": 15,
"purchasingPrice": 1250.5,
},
).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}")
try {
$response = $b24Service
->core
->call(
'catalog.document.element.add',
[
'fields' => [
'docId' => 371,
'elementId' => 6595,
'storeTo' => 43,
'amount' => 15,
'purchasingPrice' => 1250.5,
],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $e->getMessage();
}
BX24.callMethod(
'catalog.document.element.add',
{
fields: {
docId: 371,
elementId: 6595,
storeTo: 43,
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' => 371,
'elementId' => 6595,
'storeTo' => 43,
'amount' => 15,
'purchasingPrice' => 1250.5,
],
]
);
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": 371,
"elementId": 6595,
"storeTo": 43,
"amount": 15,
"purchasingPrice": 1250.5,
},
})
if err != nil {
return fmt.Errorf("catalog.document.element.add: %w", err)
}
// Метод заворачивает ответ в объект с ключом "documentElement".
raw, ok := b24.Unwrap(res.Result, "documentElement")
if !ok {
return fmt.Errorf("в ответе нет ключа documentElement")
}
var item struct {
Amount int `json:"amount"`
DocID b24.ID `json:"docId"`
ElementID b24.ID `json:"elementId"`
ID b24.ID `json:"id"`
PurchasingPrice float64 `json:"purchasingPrice"`
StoreTo int `json:"storeTo"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.DocID)
Обработка ответа
HTTP-статус: 200
{
"result": {
"documentElement": {
"amount": 15,
"docId": 371,
"elementId": 6595,
"id": 101,
"purchasingPrice": 1250.5,
"storeFrom": null,
"storeTo": 43
}
},
"time": {
"start": 1793883862,
"finish": 1793883862.684503,
"duration": 0.6845030784606934,
"processing": 0,
"date_start": "2026-11-05T16:04:22+03:00",
"date_finish": "2026-11-05T16:04:22+03:00",
"operating_reset_at": 1793884440,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
result.documentElement |
Объект с полями добавленной позиции. Незаполненные поля приходят со значением |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_DOCUMENT_STATUS",
"error_description": "Document not found"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Access denied |
У пользователя нет права «Создание и редактирование» на документы этого типа или права «Просмотр и выбор склада» на склад позиции |
|
|
|
Document not found |
Документ с указанным |
|
|
|
Conducted document |
Документ проведен. Чтобы изменить его позиции, отмените проведение методом catalog.document.cancel |
|
|
|
Could not find value for parameter |
Не передан параметр |
|
|
|
Invalid value {abc} to match with parameter {fields}. Should be value of type array. |
В |
|
|
|
Error of adding new document element |
Не удалось сохранить позицию |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Обновить товар в документе складского учета catalog.document.element.update
- Получить список товаров в документах складского учета catalog.document.element.list
- Удалить товар из документа складского учета catalog.document.element.delete
- Получить список полей товаров для документа складского учета catalog.document.element.getFields