Create status sale.status.add
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
saleWho can execute the method: administrator
The method sale.status.add creates a status for an order or delivery.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Field values for creating the status |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
id* |
Symbolic identifier of the status. The status identifier must be unique regardless of its type. This means you cannot add two statuses with the same identifier (one for an order and another for delivery). |
|
type* |
Type of status:
|
|
notify |
Indicator of whether to send an email notification to the user when the order or delivery transitions to this status. Possible values:
|
|
sort |
Sorting |
|
color |
HEX color code of the status (e.g., |
|
xmlId |
External code of the status. Can be used for synchronization with the order or delivery status by identifier in an external system. |
Code Examples
How to Use Examples in Documentation
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 -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
// 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)
}
<!-- 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>
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 error",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Bitrix SDK error: {error.message}")
except Exception as error:
print(f"Unexpected error: {error}")
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);
// Your data processing logic
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding status: ' . $e->getMessage();
}
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());
}
}
);
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>';
// client and ctx are already created — see the Go SDK section
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)
}
// The method wraps the response in an object with the "status" key.
raw, ok := b24.Unwrap(res.Result, "status")
if !ok {
return fmt.Errorf("no status key in the response")
}
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("parse response: %w", err)
}
fmt.Println(item.Color, item.ID)
Response Handling
HTTP status: 200
{
"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+02:00",
"date_finish": "2024-04-03T12:50:17+02:00"
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
status |
Object with information about the added status |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": 201350000001,
"error_description": "Duplicate entry for key [id]"
}
|
Name |
Description |
|
error |
String error code. It consists of digits, Latin letters, and underscores. It may arrive empty — in that case only |
|
error_description |
Error message for the developer. Do not show it to the end user without processing |
Possible Error Codes
|
Code |
Description |
|
|
Status with the provided identifier already exists |
|
|
Status type value not provided or the provided value is incorrect |
|
|
Empty status identifier value provided |
|
|
Status identifier length limit exceeded |
|
|
Insufficient permissions to add status |
|
|
Parameter |
|
|
Required fields not provided |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |