Canceling Multiple Documents catalog.document.cancelList
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 "Canceling" access permission on the document type in the request,
- and "View and select warehouse" on the incoming or outgoing warehouse.
The method catalog.document.cancelList cancels the processing of a group of inventory documents:
- the status of the documents is changed to
C— canceled, - the inventory balances of the goods are updated according to the positions of the documents.
Access permissions are checked for each document in the request.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
documentIds* |
A 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.cancelList
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.cancelList
// 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
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'catalog.document.cancelList',
params: {
documentIds: [142, 143, 144],
},
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('Documents cancelled successfully:', result)
}
} 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 cancelDocumentList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.document.cancelList',
params: {
documentIds: [142, 143, 144],
},
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('Documents cancelled successfully:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', cancelDocumentList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.document.cancel_list(
document_ids=[
142,
143,
144,
],
).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.cancelList',
[
'documentIds' => [142, 143, 144],
]
);
$result = $response
->getResponseData()
->getResult();
if ($result === true) {
echo 'Documents unconfirmed';
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error cancelling documents: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.document.cancelList',
{ 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.cancelList',
[
'documentIds' => [142, 143, 144],
]
);
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.cancelList", b24.Params{
"documentIds": []int{142, 143, 144},
})
if err != nil {
return fmt.Errorf("catalog.document.cancelList: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("parse response: %w", err)
}
fmt.Println("done:", ok)
Response Handling
HTTP Code: 200
{
"result": true,
"time": {
"start": 1762411998,
"finish": 1762411998.634683,
"duration": 0.6346828937530518,
"processing": 0,
"date_start": "2025-11-06T09:53:18+01:00",
"date_finish": "2025-11-06T09:53:18+01:00",
"operating_reset_at": 1762412598,
"operating": 0.30604004859924316
}
}
Returned Data
|
Name |
Description |
|
result |
The root element of the response, contains |
|
time |
Information about the execution time of the request |
Error Handling
|
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 |
HTTP Code: 400
{
"error": "0",
"error_description": "An error occurred while canceling the document "Receipt 35": The document has not been processed yet"
}
Possible Error Codes
|
Code |
Description |
Value |
|
|
An error occurred while canceling the document "document name": Insufficient permissions to save the document |
No access permission to the product catalog, inventory accounting, or no permission to process the document |
|
|
Error canceling the document: Document not found |
A non-existent identifier was specified |
|
|
An error occurred while canceling the document "document name": The document has not been processed yet |
Cannot cancel the processing of a document if it is not in the processed status |
|
|
Inventory accounting is not available on your plan |
Inventory accounting is not available on your plan |
|
|
To process the document, inventory accounting must be enabled |
Inventory accounting is disabled |
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 |