Cancel Inventory Document Processing v 3.0 catalog.document.cancel

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: catalog

Who can execute the method: a user with the "Cancel processing" permission for the document type and the "View product catalog" and "View Inventory Management area" permissions

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.cancel method cancels the processing of one inventory document by id or of several documents by documentIds.

Method Parameters

Required parameters are marked with *

Name
type

Description

id
integer

Inventory document identifier.

The identifier can be retrieved using the catalog.document.list method.

Required if documentIds is not passed

documentIds
array

Array of inventory document identifiers, for example [321, 323].

The identifiers can be retrieved using the catalog.document.list method.

Pass it instead of id to cancel the processing of several documents. If both parameters are passed, the method uses documentIds

Documents are handled one by one, and there is no overall rollback on error. If at least one document cannot be canceled, the method returns an error, but the other documents in the list are canceled. Check the document states in the status field using the catalog.document.list method.

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.cancel

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":321}' \
        https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.cancel

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":321,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/api/catalog.document.cancel

import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type DocumentCancelResult = {
          result: boolean
        }
        
        try {
          const response = await $b24.actions.v3.call.make<DocumentCancelResult>({
            method: 'catalog.document.cancel',
            params: {
              id: 321,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Document cancelled:', result.result)
          }
        } 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 cancelDocument() {
            try {
              const $b24 = await B24Js.initializeB24Frame()
        
              const response = await $b24.actions.v3.call.make({
                method: 'catalog.document.cancel',
                params: {
                  id: 321,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Document cancelled:', result.result)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', cancelDocument)
        </script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException
        
        try:
            bitrix_response = client.catalog.document.cancel(
                bitrix_id=321,
            ).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.cancel',
                    [
                        'id' => 321,
                    ]
                );
        
            $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.cancel',
            {
                id: 321,
            },
            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.cancel',
            [
                'id' => 321,
            ]
        );
        
        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.cancel", b24.Params{
        	"id": 321,
        })
        if err != nil {
        	return fmt.Errorf("catalog.document.cancel: %w", err)
        }
        
        var result struct {
        	Result bool `json:"result"`
        }
        if err := json.Unmarshal(res.Result, &result); err != nil {
        	return fmt.Errorf("parse response: %w", err)
        }
        fmt.Println(result.Result)

Response Handling

HTTP status: 200

{
            "result": {
                "result": true
            },
            "time": {
                "start": 1792665205,
                "finish": 1792665205.320535,
                "duration": 0.32053494453430176,
                "processing": 0,
                "date_start": "2026-10-22T13:33:25+02:00",
                "date_finish": "2026-10-22T13:33:25+02:00",
                "operating_reset_at": 1792665660,
                "operating": 0.6613998413085938
            }
        }

Returned Data

Name
type

Description

result
object

Root element of the response.

Contains an object with the result key set to true if the document processing is canceled

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": {
                "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
                "message": "Error validating request object.",
                "validation": [
                    {
                        "message": "Error canceling inventory object processing: The transaction is still pending."
                    }
                ]
            }
        }

Name `type`	Description
error.code `string`	String error code. Use it to identify the type of exception
error.message `string`	Text description of the error
error.validation `array`	Array with error details. Present only in data validation errors `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Name of the field where the validation error occurred
error.validation[].message `string`	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
`id`	Required field `id` is missing	Pass `id` as a positive integer
`id`	This request requires data type `int` in field `id`	Pass `id` as a number, not a string
`documentIds`	Required field `documentIds` is missing	Pass a non-empty array of positive identifiers. Zero and negative values are ignored
`documentIds`	This request requires data type `array` in field `documentIds`	Pass `documentIds` as an array, for example `[321, 323]`
`-`	Error canceling inventory object processing: The transaction is still pending	The document is not processed, so there is nothing to cancel. Check the document state in the `status` field using the catalog.document.list method
`-`	Error canceling inventory object processing: #ERROR#	Fix the document according to the error text after the colon
`-`	Error canceling inventory object "#DOC_TITLE#": #ERROR#	Fix the specified document according to the error text. The other documents in the list have been canceled
`-`	Error canceling inventory object processing: Inventory object was not found	The document does not exist or is not available to the user. Check the identifiers using the catalog.document.list method
`-`	Error canceling inventory object processing: Insufficient permissions to save the inventory object	The user does not have the "Cancel processing" permission for this document type
`-`	Inventory Management is not available on your plan	Inventory management is not included in your Bitrix24 plan. The document methods are unavailable
`-`	Inventory management must be enabled to process the document	Enable inventory management. Without it, canceling the processing of multiple documents is unavailable

Object Not Found Error

Error Code: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Field	Error description	How to Fix
`id`	Entity with ID `#ID#` was not found	There is no document with this identifier. Check the identifier using the catalog.document.list method

Access Error

Error Code: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

HTTP status: 403

Field	Error description	How to Fix
`-`	Access denied	Make sure the user has the "View product catalog", "View Inventory Management area", and "Cancel processing" permissions for the document type

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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	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
`401`	`NO_AUTH_FOUND` Wrong authorization data	The request contains no authorization data: neither an access token nor a webhook code was passed
`401`	`INVALID_REQUEST` Https required	Methods are called over the HTTPS protocol only
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support
`401`	`ACCESS_DENIED` REST is available only on commercial plans	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 — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	No active webhook with the specified user identifier and secret code was found
`404`	`ERROR_METHOD_NOT_FOUND` Method not 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
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	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 `provided by the access token`
`401`	`expired_token` The access token provided has expired	The access token has expired
`401`	`user_access_error` The user does not have access to the application	The application is installed, but the Bitrix24 administrator has granted access to it only to specific users
`403`	`PORTAL_DELETED` Portal was deleted	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

Was the article helpful?

Cancel document processing

Perform bulk cancellation of documents

Cancel Inventory Document Processing v 3.0 catalog.document.cancel

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Request Validation ErrorsRequest Validation Errors

Object Not Found ErrorObject Not Found Error

Access ErrorAccess Error

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning

Was the article helpful?

Method Parameters

Code Examples

Response Handling

Returned Data

Error Handling

Possible Error Codes

Request Validation Errors

Object Not Found Error

Access Error

Statuses and System Error Codes

Continue Learning