# sale.status.add

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

Создать статус
Scope: `sale`
Кто может выполнять метод: администратор

## Описание

Метод `sale.status.add` создает статус заказа или доставки.

## Параметры

- `fields` `object` — обязательный. Значения полей для создания статуса

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

- `id` `sale_status.id` — обязательный. Символьный идентификатор статуса.
  Идентификатор статуса должен быть уникальным независимо от его типа. То есть нельзя добавить два статуса с одинаковым идентификатором (один для заказа, а другой для доставки)
- `type` `string` — обязательный. Тип статуса:
  - `O` — статус заказа
  - `D` — статус доставки
- `notify` `string` — необязательный. Индикатор того, нужно ли отправлять почтовое уведомление пользователю, когда заказ или доставка переходят в этот статус.
  Возможные значения:
  - `Y` — оповещать
  - `N` — не оповещать
- `sort` `integer` — необязательный. Сортировка
- `color` `string` — необязательный. HEX-код цвета статуса (например, `#FF0000`)
- `xmlId` `string` — необязательный. Внешний код статуса.
  Может использоваться для синхронизации со статусом заказа или доставки по идентификатору во внешней системе

## Ответ

HTTP-статус: 200

```json
{
    "result":{
        "status":{
            "color":"#FF0000",
            "id":"MS",
            "notify":"Y",
            "sort":500,
            "type":"O",
            "xmlId":"myStatusXmlId"
        }
    },
    "time":{
        "start":1712137817.343984,
        "finish":1712137817.605804,
        "duration":0.26182007789611816,
        "processing":0.018325090408325195,
        "date_start":"2024-04-03T12:50:17+03:00",
        "date_finish":"2024-04-03T12:50:17+03:00"
    }
}
```

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

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

## Ошибки

HTTP-статус: 400

```json
{
    "error":201350000001,
    "error_description":"Duplicate entry for key [id]"
}
```

- `201350000001` — Статус с переданным идентификатором уже существует
- `201350000003` — Не передано значение типа статуса или переданное значение некорректно
- `201350000004` — Передано пустое значение идентификатора статуса
- `201350000005` — Превышено ограничение длины идентификатора статуса
- `200040300020` — Недостаточно прав для добавления статуса
- `100` — Не указан или пустой параметр `fields`
- `0` — Не переданы обязательные поля
- `0` — Другие ошибки (например, фатальные ошибки)

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

### cURL (Webhook)

```http
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"id":"MS","type":"O","notify":"Y","sort":500,"color":"#FF0000","xmlId":"myStatusXmlId"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.status.add
```

### cURL (OAuth)

```http
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"id":"MS","type":"O","notify":"Y","sort":500,"color":"#FF0000","xmlId":"myStatusXmlId"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.status.add
```

### 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 SaleStatusAddResult = {
  status: {
    color: string
    id: string
    notify: string
    sort: number
    type: string
    xmlId: string
  }
}

try {
  const response = await $b24.actions.v2.call.make<SaleStatusAddResult>({
    method: 'sale.status.add',
    params: {
      fields: {
        id: 'MS',
        type: 'O',
        notify: 'Y',
        sort: 500,
        color: '#FF0000',
        xmlId: 'myStatusXmlId',
      },
    },
    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 addSaleStatus() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.status.add',
        params: {
          fields: {
            id: 'MS',
            type: 'O',
            notify: 'Y',
            sort: 500,
            color: '#FF0000',
            xmlId: 'myStatusXmlId',
          },
        },
        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', addSaleStatus)
</script>
```

### Python

```python
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

fields = {
    "id": "MS",
    "type": "O",
    "notify": "Y",
    "sort": 500,
    "color": "#FF0000",
    "xmlId": "myStatusXmlId",
}

try:
    bitrix_response = client.sale.status.add(
        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.add',
            [
                'fields' => [
                    'id'     => 'MS',
                    'type'   => 'O',
                    'notify' => 'Y',
                    'sort'   => 500,
                    'color'  => '#FF0000',
                    'xmlId'  => 'myStatusXmlId',
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    // Нужная вам логика обработки данных
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error adding status: ' . $e->getMessage();
}
```

### BX24.js

```js
BX24.callMethod(
    'sale.status.add', {
        fields: {
            id: 'MS',
            type: 'O',
            notify: 'Y',
            sort: 500,
            color: '#FF0000',
            xmlId: 'myStatusXmlId',
        }
    },
    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.add', [
    'fields' => [
        'id' => 'MS',
        'type' => 'O',
        'notify' => 'Y',
        'sort' => 500,
        'color' => '#FF0000',
        'xmlId' => 'myStatusXmlId',
    ]
]);

echo '<PRE>';
print_r($result);
echo '</PRE>';
```

### Go

```go
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.status.add", b24.Params{
	"fields": b24.Params{
		"id":     "MS",
		"type":   "O",
		"notify": "Y",
		"sort":   500,
		"color":  "#FF0000",
		"xmlId":  "myStatusXmlId",
	},
})
if err != nil {
	return fmt.Errorf("sale.status.add: %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-add.html