Delete Multiple Inventory Documents catalog.document.deleteList
Scope:
catalogWho can execute the method:
- a user with the "Delete document" access permission for the document type in the request,
- and "View and select warehouse" for the incoming or outgoing warehouse.
The method catalog.document.deleteList removes multiple inventory documents. Access permissions are checked for each document in the request.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
documentIds* |
List of document identifiers, which can be obtained using the catalog.document.list method |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"documentIds":[142,143,144]}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.deleteList
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"documentIds":[142,143,144],"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/catalog.document.deleteList
try
{
const response = await $b24.callMethod(
'catalog.document.deleteList',
{ documentIds: [142, 143, 144] }
);
const result = response.getData().result;
console.log(result);
}
catch (error)
{
console.error(error);
}
try {
$response = $b24Service
->core
->call(
'catalog.document.deleteList',
[
'documentIds' => [142, 143, 144],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result === true) {
echo 'Documents deleted';
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error deleting documents: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.document.deleteList',
{ documentIds: [142, 143, 144] },
function(result)
{
if (result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.document.deleteList',
[
'documentIds' => [142, 143, 144],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Code: 200
{
"result": true,
"time": {
"start": 1761909885,
"finish": 1761909885.557104,
"duration": 0.5571041107177734,
"processing": 0,
"date_start": "2025-10-31T14:24:45+02:00",
"date_finish": "2025-10-31T14:24:45+02:00",
"operating_reset_at": 1761910485,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response, contains |
|
time |
Information about the request execution time |
Error Handling
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
HTTP Code: 400
{
"error": "0",
"error_description": "Cannot delete document #143 because it is processed"
}
Possible Error Codes
|
Code |
Description |
Value |
|
|
Insufficient permissions to delete document "Name" |
No permission to delete the document type or no access to the document's warehouses |
|
|
An error occurred while deleting document "#ID": Document not found |
A non-existent identifier is specified in the list |
|
|
You cannot delete document "Name" as it is processed |
Cancel the processing of the document using the catalog.document.cancelList method |
|
|
Inventory management is not available on your plan |
Inventory management is not available on your plan |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
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 |
|
|
|
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
- Delete Inventory Document catalog.document.delete
- Canceling Multiple Documents catalog.document.cancelList
- Get the list of warehouse accounting documents catalog.document.list