Add Product to Inventory Document catalog.document.element.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
catalogWho can execute the method: a user with the "Create and edit" permission for documents of this type and the "View and select warehouses" permission for the item warehouses
The method catalog.document.element.add adds a product item to an unprocessed inventory document.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Product item fields (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
docId* |
Identifier of the inventory document. The document must be unprocessed, that is, have the The identifier can be retrieved using the catalog.document.list method |
|
elementId |
Identifier of a simple product or variation. The identifier can be retrieved using the catalog.product.list and catalog.product.offer.list methods. The method does not check that the product exists. If the field is not passed, the method creates an item without a product |
|
storeFrom |
Identifier of the write-off warehouse. Filled in for transfer and write-off documents. The identifier can be retrieved using the catalog.store.list method |
|
storeTo |
Identifier of the receipt warehouse. Filled in for receipt, stock adjustment, transfer, and return documents. The identifier can be retrieved using the catalog.store.list method |
|
amount |
Product quantity. The method saves a non-numeric value as |
|
purchasingPrice |
Purchase price per unit in the document currency. The method saves a non-numeric value as |
The elementId, storeFrom, storeTo, amount, and purchasingPrice fields that are not passed equal null in the response. The method fills in the id field itself: it skips the passed value and unknown fields without an error.
The method does not check that the warehouses exist and match the document type. Pass warehouse identifiers as numbers: the method saves an array, for example [43], as the warehouse with the identifier 1.
Code Examples
How to Use Examples in Documentation
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 error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {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 and ctx are already created — see the Go SDK section
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)
}
// The method wraps the response in an object with the "documentElement" key.
raw, ok := b24.Unwrap(res.Result, "documentElement")
if !ok {
return fmt.Errorf("no documentElement key in the response")
}
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("parse response: %w", err)
}
fmt.Println(item.ID, item.DocID)
Response Handling
HTTP status: 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
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
result.documentElement |
Object with the fields of the added item. Fields that are not filled in are returned as |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "ERROR_DOCUMENT_STATUS",
"error_description": "Document not found"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Status |
Code |
Description |
Value |
|
|
|
Access denied |
The user does not have the "Create and edit" permission for documents of this type or the "View and select warehouses" permission for the item warehouse |
|
|
|
Document not found |
There is no document with the specified |
|
|
|
Conducted document |
The document is processed. To change its items, cancel processing using the catalog.document.cancel method |
|
|
|
Could not find value for parameter |
The |
|
|
|
Invalid value {abc} to match with parameter {fields}. Should be value of type array. |
|
|
|
|
Error of adding new document element |
Failed to save the item |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |