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

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

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

Scope: sale

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

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

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

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

Название
тип

Описание

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
// 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

// Shape of the payload returned in result (match the "response handling" section of the page)
type StatusUpdateResult = {
  status: {
    color: string
    id: string
    notify: string
    sort: number
    type: string
    xmlId: string
  }
}

try {
  const response = await $b24.actions.v2.call.make<StatusUpdateResult>({
    method: 'sale.status.update',
    params: {
      id: 'MS',
      fields: {
        type: 'D',
        notify: 'N',
        sort: 100,
        color: '#00FF00',
        xmlId: 'updatedXmlId',
      },
    },
    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(result.status)
  }
} 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 updateStatus() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.status.update',
        params: {
          id: 'MS',
          fields: {
            type: 'D',
            notify: 'N',
            sort: 100,
            color: '#00FF00',
            xmlId: 'updatedXmlId',
          },
        },
        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(result.status)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateStatus)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

fields = {
    "type": "D",
    "notify": "N",
    "sort": 100,
    "color": "#00FF00",
    "xmlId": "updatedXmlId",
}

try:
    bitrix_response = client.sale.status.update(
        bitrix_id='MS',
        fields=fields,
    ).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(
            '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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.status.update", b24.Params{
	"id": "MS",
	"fields": b24.Params{
		"type":   "D",
		"notify": "N",
		"sort":   100,
		"color":  "#00FF00",
		"xmlId":  "updatedXmlId",
	},
})
if err != nil {
	return fmt.Errorf("sale.status.update: %w", err)
}

// Метод заворачивает ответ в объект с ключом "status".
raw, ok := b24.Unwrap(res.Result, "status")
if !ok {
	return fmt.Errorf("в ответе нет ключа status")
}

var item struct {
	Color  string `json:"color"`
	ID     string `json:"id"`
	Notify string `json:"notify"`
	Sort   int    `json:"sort"`
	Type   string `json:"type"`
	XmlID  string `json:"xmlId"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.Color, item.ID)

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

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
string

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

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

Код

Описание

201340400001

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

200040300020

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

201350000003

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

201350000006

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

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

201350000007

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

201350000008

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

100

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

100

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

0

Не переданы обязательные поля структуры fields

0

Другие ошибки (например, фатальные ошибки)

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

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

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

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