Изменить документ складского учета catalog.document.update

Scope: catalog

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

Метод catalog.document.update изменяет поля существующего документа складского учета.

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

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

Название `тип`	Описание
id* `catalog_document.id`	Идентификатор документа, можно получить методом catalog.document.list
fields* `object`	Поля документа (подробное описание)

Параметр fields

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

Название `тип`	Описание
responsibleId `user.id`	Идентификатор ответственного
dateModify `datetime`	Можно передать собственную дату изменения. По умолчанию — текущая дата
dateDocument `datetime`	Дата проведения документа
total `double`	Общая сумма по товарам документа. Пересчитывается автоматически после изменения товарных позиций
commentary `char`	Комментарий к документу
title `string`	Название документа
docNumber `string`	Внутренний номер документа
modifiedBy `user.id`	Идентификатор пользователя, изменившего документ. Администратор может указать любое значение, по умолчанию заполняется текущим пользователем

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":142,"fields":{"title":"Поступление от Поставщик-1 (корректировка)","commentary":"Обновили ответсвенного","responsibleId":21}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.document.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":142,"fields":{"title":"Поступление от Поставщик-1 (корректировка)","commentary":"Обновили ответсвенного","responsibleId":21},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/catalog.document.update

try
        {
            const response = await $b24.callMethod(
                'catalog.document.update',
                {
                    id: 142,
                    fields: {
                        title: 'Поступление от Поставщик-1 (корректировка)',
                        commentary: 'Обновили ответсвенного',
                        responsibleId: 21,
                    }
                }
            );
            
            const result = response.getData().result;
            console.log('Updated document with ID:', result);
            
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'catalog.document.update',
                    [
                        'id' => 142,
                        'fields' => [
                            'title' => 'Поступление от Поставщик-1 (корректировка)',
                            'commentary' => 'Обновили ответсвенного',
                            'responsibleId' => 21
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating document: ' . $e->getMessage();
        }

BX24.callMethod(
            'catalog.document.update',
            {
                id: 142,
                fields: {
                    title: 'Поступление от Поставщик-1 (корректировка)',
                    commentary: 'Обновили ответсвенного',
                    responsibleId: 21
                }
            },
            function(result)
            {
                if (result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'catalog.document.update',
            [
                'id' => 142,
                'fields' => [
                    'title' => 'Поступление от Поставщик-1 (корректировка)',
                    'commentary' => 'Обновили ответсвенного',
                    'responsibleId' => 21
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-код: 200

{
            "result": {
                "document": {
                    "commentary": "Обновили ответсвенного",
                    "createdBy": 29,
                    "currency": "RUB",
                    "dateCreate": "2025-10-30T11:19:38+03:00",
                    "dateDocument": null,
                    "dateModify": "2025-10-30T11:33:42+03:00",
                    "dateStatus": "2025-10-30T11:19:38+03:00",
                    "docNumber": "IN-00042",
                    "docType": "A",
                    "id": 11,
                    "modifiedBy": 29,
                    "responsibleId": 21,
                    "siteId": "s1",
                    "status": "N",
                    "statusBy": null,
                    "title": "Поступление от Поставщик-1 (корректировка)",
                    "total": null
                }
            },
            "time": {
                "start": 1761806022,
                "finish": 1761806022.36133,
                "duration": 0.3613300323486328,
                "processing": 0,
                "date_start": "2025-10-30T09:33:42+03:00",
                "date_finish": "2025-10-30T09:33:42+03:00",
                "operating_reset_at": 1761806622,
                "operating": 0.17665815353393555
            }
        }

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

Название `тип`	Описание
result `object`	Корневой элемент ответа
document `catalog_document`	Объект с обновленными данными документа
time `time`	Информация о времени выполнения запроса

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

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

HTTP-код: 400

{
            "error": "0",
            "error_description": "Документ не найден."
        }

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

Код	Описание	Значение
`0`	Недостаточно прав для сохранения документа	У пользователя нет права на редактирование документа нужного типа или документ с таким идентификатором не существует
`0`	Складской учет недоступен на вашем тарифе	Складской учет недоступен на вашем тарифе

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`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	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Получить информацию о режиме складского учета

Обзор методов

Изменить документ складского учета catalog.document.update

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

Параметр fieldsПараметр fields

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

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

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

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

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

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

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