# sale.status.update

URL: https://chugunov.pro/api-bitrix24/sale/status/sale-status-update/
Проверено на Битрикс24 REST API, обновлено 11.09.2026 (ревизия источника fb39d6c).
Источник: официальная документация Битрикс24 (bitrix-tools/b24-rest-docs, лицензия MIT, © Bitrix). Справочник независимый, официальной документацией не является.

Обновить статус
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` — необязательный. Внешний код статуса.
  Может использоваться для синхронизации со статусом заказа или доставки по идентификатору во внешней системе

## Ответ

HTTP-статус: 200

```json
{
    "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

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

- `201340400001` — Статус с переданным идентификатором не найден
- `200040300020` — Недостаточно прав для обновления статуса
- `201350000003` — Не передано значение типа статуса или переданное значение некорректно
- `201350000006` — Ошибка возникает при попытке сменить тип некоторых [системных статусов](https://chugunov.pro/api-bitrix24/sale/status/):
  - статусы `F` и `N` всегда должны иметь тип `O` (заказ)
  - статусы `DF` и `DN` всегда должны иметь тип `D` (доставка)
- `201350000007` — Ошибка возникает при попытке сменить тип статуса заказа в том случае, если к данному статусу уже прикреплены заказы
- `201350000008` — Ошибка возникает при попытке сменить тип статуса отгрузки в том случае, если к данному статусу уже прикреплены отгрузки
- `100` — Не указан параметр `id`
- `100` — Не указан или пустой параметр `fields`
- `0` — Не переданы обязательные поля структуры `fields`
- `0` — Другие ошибки (например, фатальные ошибки)

## Примеры запроса

### cURL (Webhook)

```http
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 (OAuth)

```http
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
```

### JS (TS)

```ts
// 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)
}
```

### JS (UMD)

```html
<!-- 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>
```

### Python

```python
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}")
```

### PHP

```php
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.js

```js
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());
        }
    }
);
```

### PHP CRest

```php
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>';
```

### Go

```go
// 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)
```

Оригинал в официальной документации: https://apidocs.bitrix24.ru/api-reference/sale/status/sale-status-update.html