Add Product to Inventory Document catalog.document.element.add

Scope: catalog

Who can execute the method:

a user with "Create and Edit" permission on the document type in the request,

and "View and Select Warehouse" permission on the incoming or outgoing warehouse.

The method catalog.document.element.add adds a product item to the inventory document.

Method Parameters

Required parameters are marked with *

Name `type`	Description
fields* `object`	Fields of the added product (detailed description)

Parameter fields

Required parameters are marked with *

Name `type`	Description
docId* `catalog_document.id`	Identifier of the inventory document, can be obtained using the catalog.document.list method. The document must have a status of `N` — not processed
elementId* `catalog_product.id`	Identifier of the catalog product. The value can be obtained using the catalog.product.* methods
storeFrom `catalog_store.id`	Identifier of the source warehouse, can be obtained using the catalog.store.list method. Used for outgoing documents
storeTo `catalog_store.id`	Identifier of the receiving warehouse, can be obtained using the catalog.store.list method. Used for incoming and transfer documents
amount `double`	Quantity of the product. The value is specified in the units of the document
purchasingPrice `double`	Purchase price in the document's currency

Code Examples

How to Use Examples in Documentation

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>';

Response Handling

HTTP Code: 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+01:00",
                "date_finish": "2025-11-02T12:20:01+01:00",
                "operating": 0
            }
        }

Returned Data

Name `type`	Description
result `object`	Root element of the response
documentElement `catalog_document_element`	Object with information about the added product
time `time`	Information about the request execution time

Error Handling

HTTP Code: 400

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

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `error_description`	Textual description of the error. The description is not intended to be shown to the end user in its raw form

Possible Error Codes

Code	Description	Value
`ERROR_DOCUMENT_RIGHTS`	Access denied	Insufficient rights on the document or one of the specified warehouses
`ERROR_DOCUMENT_STATUS`	Document not found / Conducted document	Document not found, unavailable, or already processed
`0`	Error of adding new document element	Internal error while saving the item

Statuses and System Error Codes

HTTP Status: 20x, 40x, 50x

The errors described below may occur when calling any method.

Status	Code Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Overview of methods

Modify product in document

Add Product to Inventory Document catalog.document.element.add

Method ParametersMethod Parameters

Parameter fieldsParameter fields

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning