Update Product in Inventory Document v 3.0 catalog.document.element.update
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 warehouses of the product item
The method belongs to REST 3.0. The call specifics and response format of the new API version are described in the REST 3.0 overview.
The catalog.document.element.update method updates a product item in an unprocessed inventory document and returns its fields.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
id* |
Identifier of the product item. The identifier can be retrieved using the catalog.document.element.list method or from the catalog.document.element.add response |
|
fields* |
Object with the product item fields to update. Pass only the fields being changed. Field description An empty object |
Parameter fields
|
Name |
Description |
|
storeFrom |
Identifier of the source warehouse the product is written off from. Used in write-off, sale, and transfer documents. The identifier can be retrieved using the catalog.store.list method |
|
storeTo |
Identifier of the receiving warehouse. Used in receipt, stock adjustment, and transfer documents. The identifier can be retrieved using the catalog.store.list method |
|
amount |
Product quantity |
|
purchasingPrice |
Purchase price in the document currency |
According to the field description, docId and elementId are set only when adding. Currently the method also accepts them in fields and moves the item to another document or changes the product. To change the document or the product, remove the item and add a new one.
Code Examples
How to Use Examples in Documentation
The new API call differs by adding the /api/ segment to the request URL:
https://{installation_address}/rest/api/{user_id}/{webhook_token}/catalog.document.element.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":67,"fields":{"amount":4,"purchasingPrice":110}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.element.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":67,"fields":{"amount":4,"purchasingPrice":110},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.document.element.update
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type DocumentElementUpdateResult = {
item: {
id: number
docId: number
storeFrom: number
storeTo: number
elementId: number
amount: number
purchasingPrice: number
}
}
try {
const response = await $b24.actions.v3.call.make<DocumentElementUpdateResult>({
method: 'catalog.document.element.update',
params: {
id: 67,
fields: {
amount: 4,
purchasingPrice: 110,
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Element updated:', result.item.amount)
}
} 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 documentElementUpdate() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.document.element.update',
params: {
id: 67,
fields: {
amount: 4,
purchasingPrice: 110,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Element updated:', result.item.amount)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', documentElementUpdate)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.document.element.update(
bitrix_id=67,
fields={
"amount": 4,
"purchasingPrice": 110,
},
).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}")
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
try {
$response = $b24Service
->core
->call(
'catalog.document.element.update',
[
'id' => 67,
'fields' => [
'amount' => 4,
'purchasingPrice' => 110,
],
]
);
$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();
}
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
BX24.callMethod(
'catalog.document.element.update',
{
id: 67,
fields: {
amount: 4,
purchasingPrice: 110,
},
},
result => {
if (result.error())
console.error(result.error());
else
console.dir(result.data());
}
);
SDKs do not yet support the /rest/api/ address in calls. Use direct HTTP requests, for example, via cURL or fetch.
require_once('crest.php');
$result = CRest::call(
'catalog.document.element.update',
[
'id' => 67,
'fields' => [
'amount' => 4,
'purchasingPrice' => 110,
],
]
);
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.update", b24.Params{
"id": 67,
"fields": b24.Params{
"amount": 4,
"purchasingPrice": 110,
},
})
if err != nil {
return fmt.Errorf("catalog.document.element.update: %w", err)
}
// The method wraps the response in an object with the "item" key.
raw, ok := b24.Unwrap(res.Result, "item")
if !ok {
return fmt.Errorf("no item key in the response")
}
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("parse response: %w", err)
}
fmt.Println(item.ID, item.Amount)
Response Handling
HTTP status: 200
{
"result": {
"item": {
"id": 67,
"docId": 325,
"storeFrom": 0,
"storeTo": 17,
"elementId": 7573,
"amount": 4,
"purchasingPrice": 110
}
},
"time": {
"start": 1792665370,
"finish": 1792665370.918465,
"duration": 0.9184648990631104,
"processing": 0,
"date_start": "2026-10-22T13:36:10+02:00",
"date_finish": "2026-10-22T13:36:10+02:00",
"operating_reset_at": 1792665960,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Response data object |
|
result.item |
Fields of the product item after the update. Field description |
|
time |
Information about the request execution time |
Item Object
|
Name |
Description |
|
id |
Identifier of the document product item |
|
docId |
Identifier of the inventory document |
|
storeFrom |
Identifier of the source warehouse. |
|
storeTo |
Identifier of the receiving warehouse. |
|
elementId |
Product identifier |
|
amount |
Product quantity |
|
purchasingPrice |
Purchase price in the document currency |
Error Handling
HTTP status: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION",
"message": "Entity with ID 999999 was not found."
}
}
|
Name |
Description |
|
error.code |
String error code. Use it to identify the type of exception |
|
error.message |
Text description of the error |
|
error.validation |
Array with error details. Present only in data validation errors |
|
error.validation[].field |
Name of the field where the validation error occurred |
|
error.validation[].message |
Description of the error related to the specified field |
Possible Error Codes
Request Validation Errors
Error Code: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
At least one of the required fields must be not empty: id, filter |
Pass the |
|
|
Required field |
Pass the |
|
|
This request requires data type |
Pass a number |
|
|
Conducted document |
The document is processed. Cancel processing using the catalog.document.cancel method and repeat the request |
|
|
Error of modifying new document |
Pass at least one field in |
Filter Format Error
Error Code: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Invalid filter |
The method does not support |
Object Not Found Error
Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Entity with ID |
There is no product item with this identifier. Check the identifier using the catalog.document.element.list method |
Unknown Field Error
Error Code: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Unknown field |
Pass in |
Access Error
Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
|
Field |
Error description |
How to Fix |
|
|
Access denied |
Check the permissions for documents of this type and for the warehouses of the product 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 |
Continue Learning
- Add Product to Inventory Document v 3.0 catalog.document.element.add
- Get List of Products in Inventory Documents v 3.0 catalog.document.element.list
- Remove Product from Inventory Document v 3.0 catalog.document.element.delete
- Get List of Inventory Document Product Fields v 3.0 catalog.document.element.field.list
- Get Inventory Document Product Field catalog.document.element.field.get
- Get List of Inventory Documents v 3.0 catalog.document.list