Обновить статус sale.status.update

Scope: sale

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

Метод обновляет статус заказа или доставки.

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

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

Название
тип

Описание

id*
sale_status.id

Символьный идентификатор статуса

fields*
object

Значения полей для обновления статуса

Параметр fields

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

Название
тип

Описание

type*
string

Тип статуса:

  • O — статус заказа
  • D — статус доставки

notify
string

Индикатор того, нужно ли отправлять почтовое уведомление пользователю, когда заказ или доставка переходят в этот статус.

Возможные значения:

  • Y — оповещать
  • N — не оповещать

sort
integer

Сортировка

color
string

HEX-код цвета статуса (например, #FF0000)

xmlId
string

Внешний код статуса.

Может использоваться для синхронизации со статусом заказа или доставки по идентификатору во внешней системе

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":"MS","fields":{"type":"D","notify":"N","sort":100,"color":"#00FF00","xmlId":"updatedXmlId"}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.status.update
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":"MS","fields":{"type":"D","notify":"N","sort":100,"color":"#00FF00","xmlId":"updatedXmlId"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.status.update
        
try
        {
        	const response = await $b24.callMethod(
        		'sale.status.update', {
        			id: 'MS',
        			fields: {
        				type: 'D',
        				notify: 'N',
        				sort: 100,
        				color: '#00FF00',
        				xmlId: 'updatedXmlId',
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.info(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'sale.status.update',
                    [
                        'id' => 'MS',
                        'fields' => [
                            'type'   => 'D',
                            'notify' => 'N',
                            'sort'   => 100,
                            'color'  => '#00FF00',
                            'xmlId'  => 'updatedXmlId',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating sale status: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'sale.status.update', {
                id: 'MS',
                fields: {
                    type: 'D',
                    notify: 'N',
                    sort: 100,
                    color: '#00FF00',
                    xmlId: 'updatedXmlId',
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call('sale.status.update', [
            'id' => 'MS',
            'fields' => [
                'type' => 'D',
                'notify' => 'N',
                'sort' => 100,
                'color' => '#00FF00',
                'xmlId' => 'updatedXmlId',
            ]
        ]);
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result":{
                "status":{
                    "color":"#00FF00",
                    "id":"MS",
                    "notify":"N",
                    "sort":100,
                    "type":"D",
                    "xmlId":"updatedXmlId"
                }
            },
            "time":{
                "start":1712142575.655577,
                "finish":1712142575.940234,
                "duration":0.28465700149536133,
                "processing":0.02240896224975586,
                "date_start":"2024-04-03T14:09:35+03:00",
                "date_finish":"2024-04-03T14:09:35+03:00"
            }
        }

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

Название
тип

Описание

result
object

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

status
sale_status

Объект с информацией об обновленном статусе

time
time

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

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

HTTP-статус: 400

{
            "error":0,
            "error_description":"Required fields: type"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

201340400001

Статус с переданным идентификатором не найден

200040300020

Недостаточно прав для обновления статуса

201350000003

Не передано значение типа статуса или переданное значение некорректно

201350000006

Ошибка возникает при попытке сменить тип некоторых системных статусов:

  • статусы F и N всегда должны иметь тип O (заказ)
  • статусы DF и DN всегда должны иметь тип D (доставка)

201350000007

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

201350000008

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

100

Не указан параметр id

100

Не указан или пустой параметр fields

0

Не переданы обязательные поля структуры 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

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Создать статус
Следующая
Получить значения всех полей статуса по id