Добавить заказ sale.order.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
saleКто может выполнять метод: администратор
Метод sale.order.add создает заказ без позиций корзины, оплат и отгрузок и возвращает его поля. Позиции корзины, оплаты и отгрузки добавляют после создания методами sale.basketitem.*, sale.payment.* и sale.shipment.*.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Значения полей для создания заказа (подробное описание) |
Параметр fields
|
Название |
Описание |
|
lid* |
Идентификатор сайта, к которому относится заказ. В облачном Битрикс24 передавайте |
|
personTypeId* |
Идентификатор типа плательщика, например физического или юридического лица. Получите его методом sale.persontype.list. Метод не проверяет, что такой тип плательщика существует. После создания заказа поле изменить нельзя |
|
currency* |
Код валюты, например |
|
price |
Сумма заказа с учетом доставки |
|
discountValue |
Значение скидки |
|
statusId |
Идентификатор статуса заказа. Получите список статусов методом sale.status.list. Если не передать поле, заказ получит начальный статус |
|
empStatusId |
Идентификатор пользователя, изменившего статус заказа |
|
dateInsert |
Дата создания заказа |
|
marked |
Признак того, что заказ отмечен как проблемный. Битрикс24 ставит
По умолчанию устанавливается |
|
empMarkedId |
Идентификатор пользователя, поставившего маркировку |
|
reasonMarked |
Причина, по которой заказ отмечен как проблемный |
|
userDescription |
Комментарий покупателя к заказу |
|
additionalInfo |
Устаревший. Дополнительная информация |
|
comments |
Комментарий менеджера к заказу |
|
companyId |
Идентификатор компании из модуля «Интернет-магазин» |
|
responsibleId |
Идентификатор пользователя, ответственного за заказ |
|
recurringId |
Идентификатор продления подписки |
|
lockedBy |
Актуально только для коробочной версии. Идентификатор пользователя, заблокировавшего заказ. Заказ блокируется в административной панели, когда пользователь открывает детальную карточку заказа |
|
recountFlag |
Устаревший. Флаг пересчета.
По умолчанию устанавливается |
|
affiliateId |
Актуально только для коробочной версии. Идентификатор аффилиата |
|
updated1c |
Обновлен ли заказ через 1С.
По умолчанию устанавливается |
|
orderTopic |
Устаревший. Тема заказа |
|
xmlId |
Внешний идентификатор |
|
id1c |
Идентификатор в 1С |
|
version1c |
Версия в 1С |
|
externalOrder |
Заказ из внешней системы или нет.
По умолчанию устанавливается |
|
canceled |
Был ли отменен заказ.
По умолчанию устанавливается |
|
empCanceledId |
Идентификатор пользователя, отменившего заказ |
|
reasonCanceled |
Причина отмены |
|
userId |
Идентификатор покупателя. После создания заказа поле изменить нельзя |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"lid":"s1","personTypeId":1,"currency":"RUB","statusId":"N","userId":1,"responsibleId":1,"userDescription":"Позвоните перед доставкой","comments":"Заказ из интеграции с сайтом"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.order.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"lid":"s1","personTypeId":1,"currency":"RUB","statusId":"N","userId":1,"responsibleId":1,"userDescription":"Позвоните перед доставкой","comments":"Заказ из интеграции с сайтом"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.order.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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type OrderResult = {
order: {
accountNumber: string
canceled: string
clients: Record<string, unknown>[]
comments: string
currency: string
dateInsert: ISODate | null
dateStatus: ISODate | null
dateUpdate: ISODate | null
deducted: string
empStatusId: number
id: number
lid: string
payed: string
personTypeId: number
personTypeXmlId: string
propertyValues: Record<string, unknown>[]
requisiteLink: Record<string, number>
responsibleId: number
statusId: string
statusXmlId: string
updated1c: string
userDescription: string
userId: number
xmlId: string
}
}
try {
const response = await $b24.actions.v2.call.make<OrderResult>({
method: 'sale.order.add',
params: {
fields: {
lid: 's1',
personTypeId: 1,
currency: 'RUB',
statusId: 'N',
userId: 1,
responsibleId: 1,
userDescription: 'Позвоните перед доставкой',
comments: 'Заказ из интеграции с сайтом',
},
},
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.order.id, result.order.accountNumber)
}
} 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 addOrder() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.order.add',
params: {
fields: {
lid: 's1',
personTypeId: 1,
currency: 'RUB',
statusId: 'N',
userId: 1,
responsibleId: 1,
userDescription: 'Позвоните перед доставкой',
comments: 'Заказ из интеграции с сайтом',
},
},
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.order.id, result.order.accountNumber)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addOrder)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"lid": "s1",
"personTypeId": 1,
"currency": "RUB",
"statusId": "N",
"userId": 1,
"responsibleId": 1,
"userDescription": "Позвоните перед доставкой",
"comments": "Заказ из интеграции с сайтом",
}
try:
bitrix_response = client.sale.order.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}")
try {
$response = $b24Service
->core
->call(
'sale.order.add',
[
'fields' => [
'lid' => 's1',
'personTypeId' => 1,
'currency' => 'RUB',
'statusId' => 'N',
'userId' => 1,
'responsibleId' => 1,
'userDescription' => 'Позвоните перед доставкой',
'comments' => 'Заказ из интеграции с сайтом',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding order: ' . $e->getMessage();
}
BX24.callMethod(
'sale.order.add',
{
fields: {
lid: 's1',
personTypeId: 1,
currency: 'RUB',
statusId: 'N',
userId: 1,
responsibleId: 1,
userDescription: 'Позвоните перед доставкой',
comments: 'Заказ из интеграции с сайтом',
}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'sale.order.add',
[
'fields' => [
'lid' => 's1',
'personTypeId' => 1,
'currency' => 'RUB',
'statusId' => 'N',
'userId' => 1,
'responsibleId' => 1,
'userDescription' => 'Позвоните перед доставкой',
'comments' => 'Заказ из интеграции с сайтом',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.order.add", b24.Params{
"fields": b24.Params{
"lid": "s1",
"personTypeId": 1,
"currency": "RUB",
"statusId": "N",
"userId": 1,
"responsibleId": 1,
"userDescription": "Позвоните перед доставкой",
"comments": "Заказ из интеграции с сайтом",
},
})
if err != nil {
return fmt.Errorf("sale.order.add: %w", err)
}
// Метод заворачивает ответ в объект с ключом "order".
raw, ok := b24.Unwrap(res.Result, "order")
if !ok {
return fmt.Errorf("в ответе нет ключа order")
}
var item struct {
ID b24.ID `json:"id"`
AccountNumber string `json:"accountNumber"`
StatusID string `json:"statusId"`
Comments string `json:"comments"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.AccountNumber, item.StatusID, item.Comments)
Обработка ответа
HTTP-статус: 200
{
"result": {
"order": {
"accountNumber": "971",
"canceled": "N",
"clients": [
{
"entityId": 2819,
"entityTypeId": 3,
"id": 1717,
"isPrimary": "Y",
"orderId": 971
}
],
"comments": "Заказ из интеграции с сайтом",
"currency": "RUB",
"dateInsert": "2026-09-28T08:02:16+03:00",
"dateStatus": "2026-09-28T08:02:15+03:00",
"dateUpdate": "2026-09-28T08:02:16+03:00",
"deducted": "N",
"empStatusId": 1,
"id": 971,
"lid": "s1",
"payed": "N",
"personTypeId": 1,
"personTypeXmlId": "",
"propertyValues": [
{
"code": "EMAIL",
"id": 11287,
"name": "E-Mail",
"orderPropsId": 41,
"orderPropsXmlId": "bx_60b605ba1d082"
},
{
"code": "FIO",
"id": 11289,
"name": "Ф.И.О.",
"orderPropsId": 39,
"orderPropsXmlId": "bx_609bec7cc794c"
}
],
"requisiteLink": {
"mcBankDetailId": 0,
"mcRequisiteId": 0,
"requisiteId": 467
},
"responsibleId": 1,
"statusId": "N",
"statusXmlId": "",
"updated1c": "N",
"userDescription": "Позвоните перед доставкой",
"userId": 1,
"xmlId": "bx_6aba02e7a86af"
}
},
"time": {
"start": 1790575335,
"finish": 1790575336.454058,
"duration": 1.4540579319000244,
"processing": 1,
"date_start": "2026-09-28T09:02:15+03:00",
"date_finish": "2026-09-28T09:02:16+03:00",
"operating_reset_at": 1790575935,
"operating": 0.7697091102600098
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа (подробное описание) |
|
time |
Информация о времени выполнения запроса |
Объект result
|
Название |
Описание |
|
order |
Созданный заказ. Идентификатор заказа для других методов — в поле |
Обработка ошибок
HTTP-статус: 400
{
"error": "0",
"error_description": "Required fields: personTypeId, currency, lid"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Статус |
Код |
Описание |
Значение |
|
|
|
|
Не переданы обязательные поля, их имена перечислены в тексте ошибки |
|
|
|
|
Не передан параметр |
|
|
|
|
Недостаточно прав для добавления заказа |
|
|
|
Текст ошибки сохранения |
Заказ не сохранен по другой причине, она указана в |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |