Изменить заказ sale.order.update

Scope: sale

Кто может выполнять метод: администратор

Метод sale.order.update обновляет поля заказа.

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

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

Название `тип`	Описание
id* `sale_order.id`	Идентификатор заказа
fields* `object`	Значения полей для изменения заказа

Параметр fields

Название `тип`	Описание
price `double`	Цена
discountValue `double`	Значение скидки
statusId `sale_status.id`	Идентификатор статуса заказа
empStatusId `user.id`	Идентификатор пользователя, изменившего статус заказа
dateInsert `datetime`	Дата создания заказа
marked `string`	Флаг маркировки. Признак того, является ли отгрузка отмеченной как проблемная. Значение `Y` ставится автоматически, если при сохранении произошла ошибка. `Y` — да `N` — нет По умолчанию устанавливается `N`
empMarkedId `user.id`	Идентификатор пользователя, поставившего маркировку
reasonMarked `string`	Причина, по которой заказ был промаркирован
userDescription `string`	Комментарий покупателя к заказу
additionalInfo `string`	Устаревший. Дополнительная информация
comments `string`	Комментарий менеджера к заказу
responsibleId `user.id`	Идентификатор пользователя, ответственного за заказ
recurringId `integer`	Идентификатор продления подписки
lockedBy `user.id`	Актуально только для коробочной версии. Идентификатор пользователя, заблокировавшего заказ. Заказ блокируется в административной панели, когда пользователь открывает детальную карточку заказа
recountFlag `string`	Устаревший. Флаг пересчёта. `Y` — да `N` — нет По умолчанию устанавливается Y
affiliateId `integer`	Актуально только для коробочной версии. Идентификатор аффилиата
updated1c `string`	Обновлён ли через 1С. `Y` — да `N` — нет По умолчанию устанавливается `N`
orderTopic `string`	Устаревший. Тема заказа
xmlId `string`	Внешний идентификатор
id1c `string`	Идентификатор в 1С
version1c `string`	Версия в 1с
externalOrder `string`	Заказ из внешней системы или нет. `Y` — да `N` — нет По умолчанию устанавливается `N`
canceled `string`	Был ли отменен заказ. `Y` — да `N` — нет По умолчанию устанавливается `N`
empCanceledId `user.id`	Идентификатор пользователя, отменившего заказ
reasonCanceled `string`	Причина отмены

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":300,"fields":{"price":100,"discountValue":10,"statusId":"N","empStatusId":1,"dateInsert":"2024-03-01T14:00:00","marked":"Y","empMarkedId":1,"reasonMarked":"","userDescription":"","additionalInfo":"","comments":"","companyId":1,"responsibleId":1,"recurringId":1,"lockedBy":1,"recountFlag":"N","affiliateId":1,"updated1c":"N","orderTopic":"","xmlId":"","id1c":"","version1c":"","externalOrder":"N","canceled":"Y","empCanceledId":1,"reasonCanceled":""}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.order.update

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":300,"fields":{"price":100,"discountValue":10,"statusId":"N","empStatusId":1,"dateInsert":"2024-03-01T14:00:00","marked":"Y","empMarkedId":1,"reasonMarked":"","userDescription":"","additionalInfo":"","comments":"","companyId":1,"responsibleId":1,"recurringId":1,"lockedBy":1,"recountFlag":"N","affiliateId":1,"updated1c":"N","orderTopic":"","xmlId":"","id1c":"","version1c":"","externalOrder":"N","canceled":"Y","empCanceledId":1,"reasonCanceled":""},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.order.update

try
        {
        	const response = await $b24.callMethod(
        		'sale.order.update',
        		{
        			id: 300,
        			fields: {
        				price: 100,
        				discountValue: 10,
        				statusId: 'N',
        				empStatusId: 1,
        				dateInsert: '2024-03-01T14:00:00',
        				marked: 'Y',
        				empMarkedId: 1,
        				reasonMarked: '',
        				userDescription: '',
        				additionalInfo: '',
        				comments: '',
        				companyId: 1,
        				responsibleId: 1,
        				recurringId: 1,
        				lockedBy: 1,
        				recountFlag: 'N',
        				affiliateId: 1,
        				updated1c: 'N',
        				orderTopic: '',
        				xmlId: '',
        				id1c: '',
        				version1c: '',
        				externalOrder: 'N',
        				canceled: 'Y',
        				empCanceledId: 1,
        				reasonCanceled: '',
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch(error)
        {
        	console.error(error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.order.update',
                    [
                        'id' => 300,
                        'fields' => [
                            'price'           => 100,
                            'discountValue'   => 10,
                            'statusId'        => 'N',
                            'empStatusId'     => 1,
                            'dateInsert'      => '2024-03-01T14:00:00',
                            'marked'          => 'Y',
                            'empMarkedId'     => 1,
                            'reasonMarked'    => '',
                            'userDescription' => '',
                            'additionalInfo'  => '',
                            'comments'        => '',
                            'companyId'       => 1,
                            'responsibleId'   => 1,
                            'recurringId'     => 1,
                            'lockedBy'        => 1,
                            'recountFlag'     => 'N',
                            'affiliateId'     => 1,
                            'updated1c'       => 'N',
                            'orderTopic'      => '',
                            'xmlId'           => '',
                            'id1c'            => '',
                            'version1c'       => '',
                            'externalOrder'   => 'N',
                            'canceled'        => 'Y',
                            'empCanceledId'   => 1,
                            'reasonCanceled'  => '',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating sale order: ' . $e->getMessage();
        }

BX24.callMethod(
            'sale.order.update',
            {
                id: 300,
                fields: {
                    price: 100,
                    discountValue: 10,
                    statusId: 'N',
                    empStatusId: 1,
                    dateInsert: '2024-03-01T14:00:00',
                    marked: 'Y',
                    empMarkedId: 1,
                    reasonMarked: '',
                    userDescription: '',
                    additionalInfo: '',
                    comments: '',
                    companyId: 1,
                    responsibleId: 1,
                    recurringId: 1,
                    lockedBy: 1,
                    recountFlag: 'N',
                    affiliateId: 1,
                    updated1c: 'N',
                    orderTopic: '',
                    xmlId: '',
                    id1c: '',
                    version1c: '',
                    externalOrder: 'N',
                    canceled: 'Y',
                    empCanceledId: 1,
                    reasonCanceled: '',
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.log(result.data());
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'sale.order.update',
            [
                'id' => 300,
                'fields' => [
                    'price' => 100,
                    'discountValue' => 10,
                    'statusId' => 'N',
                    'empStatusId' => 1,
                    'dateInsert' => '2024-03-01T14:00:00',
                    'marked' => 'Y',
                    'empMarkedId' => 1,
                    'reasonMarked' => '',
                    'userDescription' => '',
                    'additionalInfo' => '',
                    'comments' => '',
                    'companyId' => 1,
                    'responsibleId' => 1,
                    'recurringId' => 1,
                    'lockedBy' => 1,
                    'recountFlag' => 'N',
                    'affiliateId' => 1,
                    'updated1c' => 'N',
                    'orderTopic' => '',
                    'xmlId' => '',
                    'id1c' => '',
                    'version1c' => '',
                    'externalOrder' => 'N',
                    'canceled' => 'Y',
                    'empCanceledId' => 1,
                    'reasonCanceled' => '',
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": {
                "order": {
                    "accountNumber": "456",
                    "additionalInfo": "",
                    "affiliateId": 1,
                    "canceled": "Y",
                    "clients": [],
                    "comments": "",
                    "companyId": 1,
                    "currency": "RUB",
                    "dateCanceled": "2024-04-12T14:06:05+03:00",
                    "dateInsert": "2024-03-01T13:00:00+03:00",
                    "dateLock": null,
                    "dateMarked": "2024-04-15T10:21:14+03:00",
                    "dateStatus": "2024-04-12T14:06:04+03:00",
                    "dateUpdate": "2024-04-15T10:21:15+03:00",
                    "deducted": "N",
                    "discountValue": 10,
                    "empCanceledId": 1,
                    "empMarkedId": 1,
                    "empStatusId": 1,
                    "externalOrder": "N",
                    "id": 300,
                    "id1c": "",
                    "lid": "s1",
                    "lockedBy": "1",
                    "marked": "N",
                    "orderTopic": "",
                    "payed": "N",
                    "personTypeId": 1,
                    "personTypeXmlId": "",
                    "price": 100,
                    "reasonCanceled": "",
                    "reasonMarked": "",
                    "recountFlag": "N",
                    "recurringId": "1",
                    "requisiteLink": [],
                    "responsibleId": 1,
                    "statusId": "N",
                    "statusXmlId": "",
                    "taxValue": null,
                    "updated1c": "N",
                    "userDescription": "",
                    "userId": 1,
                    "version": 3,
                    "version1c": "",
                    "xmlId": ""
                }
            },
            "time": {
                "start": 1713169274.29568,
                "finish": 1713169275.698528,
                "duration": 1.4028480052947998,
                "processing": 0.9852678775787354,
                "date_start": "2024-04-15T11:21:14+03:00",
                "date_finish": "2024-04-15T11:21:15+03:00"
            }
        }

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

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

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

HTTP-статус: 400

{
            "error":200540400001
            "error_description":"order is not exists"
        }

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

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

Код	Описание
`200540400001`	Обновляемый заказ не найден
`200040300020`	Недостаточно прав для обновления заказа
`100`	Не указан параметр `id`
`100`	Не указан или пустой параметр `fields`
`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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Добавить заказ

Получить значения полей заказа и связанных объектов

Изменить заказ sale.order.update

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

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

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

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

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

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

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

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

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