Canceling Multiple Documents catalog.document.cancelList

Scope: catalog

Who 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 `type`	Description
documentIds* `catalog_document.id[]`	A list of document identifiers, which can be obtained using the catalog.document.list method

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 '{"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

try
        {
        	const response = await $b24.callMethod(
        		'catalog.document.cancelList',
        		{ documentIds: [142, 143, 144] }
        	);
        
        	const result = response.getData().result;
        	console.log(result);
        }
        catch (error)
        {
        	console.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 canceling 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>';

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 `type`	Description
result `boolean`	The root element of the response, contains `true` if all documents were canceled without errors. If at least one document could not be canceled, the method will return an error in the `error` / `error_description` response. Documents that were successfully processed will remain in the "Canceled" status
time `time`	Information about the execution time of the request

Error Handling

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

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
`0`	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
`0`	Error canceling the document: Document not found	A non-existent identifier was specified
`0`	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
`0`	Inventory accounting is not available on your plan	Inventory accounting 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 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

Cancel document processing

Process document

Canceling Multiple Documents catalog.document.cancelList

Method ParametersMethod Parameters

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