Провести документ складского учета v 3.0 catalog.document.conduct

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: catalog

Кто может выполнять метод: пользователь с правом «Проведение документа» для типа документа и правами «Просмотр каталога товаров» и «Просмотр раздела Складской учет»

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод catalog.document.conduct проводит один документ складского учета по id или несколько документов по documentIds.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id
integer

Идентификатор документа складского учета.

Идентификатор можно получить методом catalog.document.list.

Обязателен, если не передан documentIds

documentIds
array

Массив идентификаторов документов складского учета, например [321, 323].

Идентификаторы можно получить методом catalog.document.list.

Передайте вместо id, чтобы провести несколько документов. Если переданы оба параметра, метод использует documentIds

Документы обрабатываются по очереди, общий откат при ошибке не выполняется. Если хотя бы один документ провести не удалось, метод вернет ошибку, но остальные документы из списка будут проведены. Проверьте состояние документов полем status методом catalog.document.list.

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/catalog.document.conduct

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

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

import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type DocumentConductResult = {
  result: boolean
}

try {
  const response = await $b24.actions.v3.call.make<DocumentConductResult>({
    method: 'catalog.document.conduct',
    params: {
      id: 321,
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Document conducted:', 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 conductDocument() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.document.conduct',
        params: {
          id: 321,
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Document conducted:', result.result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', conductDocument)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.document.conduct(
        bitrix_id=321,
    ).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}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'catalog.document.conduct',
            [
                '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();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'catalog.document.conduct',
    {
        id: 321,
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'catalog.document.conduct',
    [
        'id' => 321,
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.document.conduct", b24.Params{
	"id": 321,
})
if err != nil {
	return fmt.Errorf("catalog.document.conduct: %w", err)
}

var result struct {
	Result bool `json:"result"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(result.Result)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "result": true
    },
    "time": {
        "start": 1792665203,
        "finish": 1792665203.623872,
        "duration": 0.6238720417022705,
        "processing": 0,
        "date_start": "2026-10-22T13:33:23+03:00",
        "date_finish": "2026-10-22T13:33:23+03:00",
        "operating_reset_at": 1792665600,
        "operating": 1.1235198974609375
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Корневой элемент ответа.

Содержит объект с ключом result и значением true, если документ проведен

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Ошибка проведения документа: Документ уже проведен"
            }
        ]
    }
}

Название `тип`	Описание
error.code `string`	Строковый код ошибки. Используйте для идентификации типа исключения
error.message `string`	Текстовое описание ошибки
error.validation `array`	Массив c деталями ошибки. Присутствует только в ошибках валидации данных `BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION`
error.validation[].field `string`	Название поля, в котором возникла ошибка валидации
error.validation[].message `string`	Описание ошибки, связанной с указанным полем

Возможные коды ошибок

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле	Описание ошибки	Как исправить
`id`	Обязательное поле `id` не указано	Передайте `id` — положительное целое число
`id`	В поле `id` требуется тип данных `int` для такого запроса	Передайте `id` числом, а не строкой
`documentIds`	Обязательное поле `documentIds` не указано	Передайте непустой массив положительных идентификаторов. Нули и отрицательные значения не учитываются
`documentIds`	В поле `documentIds` требуется тип данных `array` для такого запроса	Передайте `documentIds` массивом, например `[321, 323]`
`-`	Ошибка проведения документа: Документ уже проведен	Документ уже проведен. Проверьте поле `status` методом catalog.document.list
`-`	Ошибка проведения документа: Не указан поставщик.	Для документа прихода укажите поставщика методом catalog.document.contractor.add
`-`	Ошибка проведения документа: #ERROR#	Исправьте документ по тексту ошибки после двоеточия, например заполните склад или количество в товарах документа
`-`	При проведении документа "#DOC_TITLE#" произошла ошибка: #ERROR#	Исправьте указанный документ по тексту ошибки. Остальные документы из списка проведены
`-`	При проведении документа "#DOC_TITLE#" произошла ошибка	Такого документа нет или он недоступен пользователю. Плейсхолдер `#DOC_TITLE#` в тексте не заменяется. Проверьте идентификаторы методом catalog.document.list
`-`	Ошибка проведения документа: Недостаточно прав для сохранения документа	У пользователя нет права «Проведение документа» для типа этого документа
`-`	Складской учет недоступен на вашем тарифе	Складской учет не входит в тариф Битрикс24. Методы работы с документами недоступны
`-`	Для проведения документа необходимо включить складской учет	Включите складской учет. Без него проведение нескольких документов недоступно

Ошибка отсутствия объекта

Код ошибки: BITRIX_REST_V3_EXCEPTION_ENTITYNOTFOUNDEXCEPTION

Поле	Описание ошибки	Как исправить
`id`	Запись с ID = `#ID#` не найдена	Документа с таким идентификатором нет. Проверьте идентификатор методом catalog.document.list

Ошибка доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

HTTP-статус: 403

Поле	Описание ошибки	Как исправить
`-`	Доступ запрещен	Проверьте, что у пользователя есть права «Просмотр каталога товаров», «Просмотр раздела Складской учет» и «Проведение документа» для типа документа

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

Провести документ

Выполнить групповое проведение документов

Провести документ складского учета v 3.0 catalog.document.conduct

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Ошибки валидации запросаОшибки валидации запроса

Ошибка отсутствия объектаОшибка отсутствия объекта

Ошибка доступаОшибка доступа

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение

Была ли статья полезна?

Параметры метода

Примеры кода

Обработка ответа

Возвращаемые данные

Обработка ошибок

Возможные коды ошибок

Ошибки валидации запроса

Ошибка отсутствия объекта

Ошибка доступа

Статусы и коды системных ошибок

Продолжите изучение