Удалить несколько документов складского учета catalog.document.deleteList
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: пользователь с правом «Просмотр и выбор склада» и правом «Удаление документа» на документы нужного типа. Нужен доступ ко всем складам, указанным в товарах документов
Метод catalog.document.deleteList удаляет несколько документов складского учета, которые не проведены.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
documentIds* |
Массив идентификаторов документов, например Получить идентификаторы документов можно методом catalog.document.list. Пустой массив метод принимает без ошибки и возвращает |
Метод обрабатывает документы по очереди. Если документ не найден или проведен, метод пропускает его, удаляет остальные и в конце возвращает ошибку. Если на какой-то документ нет прав, метод останавливается на нем: документы до него уже удалены, после — нет.
Вместе с документами удаляются их товары.
Примеры кода
Как использовать примеры в документации
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
// 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.deleteList',
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 deleted:', 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 deleteDocumentList() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'catalog.document.deleteList',
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 deleted:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', deleteDocumentList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.document.delete_list(
document_ids=[
142,
143,
144,
],
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'catalog.document.deleteList',
[
'documentIds' => [142, 143, 144],
]
);
$result = $response
->getResponseData()
->getResult();
print_r($result);
} catch (Throwable $e) {
echo $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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.document.deleteList", b24.Params{
"documentIds": []int{142, 143, 144},
})
if err != nil {
return fmt.Errorf("catalog.document.deleteList: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Обработка ответа
HTTP-статус: 200
{
"result": true,
"time": {
"start": 1793883412,
"finish": 1793883412.462494,
"duration": 0.462493896484375,
"processing": 0,
"date_start": "2026-11-05T15:56:52+03:00",
"date_finish": "2026-11-05T15:56:52+03:00",
"operating_reset_at": 1793883900,
"operating": 0.1538081169128418
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа. Содержит |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Вы не можете удалить документ \"Оприходование излишков\", так как он проведен"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
Не удалось завершить действие, так как у вас недостаточно прав для просмотра и выбора складов |
У пользователя нет права «Просмотр и выбор склада» |
|
|
|
Недостаточно прав для удаления документа "Оприходование излишков" |
У пользователя нет права «Удаление документа» на документы этого типа или нет доступа к складу из товаров документа. В тексте — название документа или, если его нет, название типа документа |
|
|
|
Could not find value for parameter |
Не передан параметр |
|
|
|
Invalid value {abc} to match with parameter {documentIds}. Should be value of type array. |
В |
|
|
|
При удалении документа "#999999" произошла ошибка: Документ не найден. |
Документ с указанным идентификатором не найден. В тексте — идентификатор документа |
|
|
|
Вы не можете удалить документ "Оприходование излишков", так как он проведен |
Документ проведен. Сначала отмените проведение методом catalog.document.cancelList |
|
|
|
Складской учет недоступен на вашем тарифе |
Складской учет недоступен на тарифе портала |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |