Добавить произвольную позицию в корзину заказа sale.basketitem.add
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
saleКто может выполнять метод: администратор
Метод sale.basketitem.add добавляет позицию в корзину существующего заказа.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
fields* |
Значения полей позиции корзины (подробное описание) |
Параметр fields
Обязательные параметры отмечены *
Значения полей, отмеченных **, будут взяты из данных о товаре в каталоге, если в поле productId передан реальный идентификатор товара. Переданные значения этих полей для товара из каталога не сохраняются. Для произвольной позиции заполните эти поля самостоятельно.
|
Название |
Описание |
|
orderId* |
Идентификатор заказа |
|
sort |
Положение в списке позиций заказа. По умолчанию |
|
productId* |
Идентификатор товара или вариации из каталога. Для произвольной позиции, которой нет в каталоге, передайте |
|
price |
Цена за единицу с учетом наценок и скидок. Если передать |
|
basePrice |
Исходная цена без учета наценок и скидок. Для товара из каталога по умолчанию берется из каталога. У произвольной позиции без |
|
discountPrice |
Величина итоговой скидки или наценки. Если передаете |
|
currency* |
Валюта цены. Должна совпадать с валютой заказа, иначе метод вернет ошибку |
|
quantity* |
Количество товара |
|
xmlId |
Внешний код позиции корзины. Если не передать, Битрикс24 создаст код вида |
|
name** |
Название товара. Для произвольной позиции передайте его явно: без |
|
weight** |
Вес товара. Сохраняется в том виде, в котором передан |
|
dimensions** |
Размеры товара — строка с сериализованным PHP-массивом с ключами |
|
measureCode** |
Код единицы измерения товара |
|
measureName** |
Название единицы измерения |
|
canBuy** |
Флаг доступности товара. Возможные значения:
У произвольной позиции по умолчанию |
|
vatRate** |
Ставка налога долей от единицы: |
|
vatIncluded** |
Флаг того, включен ли НДС или налог в цену товара. Возможные значения:
У произвольной позиции по умолчанию |
|
catalogXmlId** |
Внешний код каталога товаров |
|
productXmlId** |
Внешний код товара |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"orderId":923,"productId":0,"name":"Доставка крупногабаритного груза","price":1500,"currency":"RUB","quantity":1,"measureCode":"796","measureName":"шт"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.basketitem.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"orderId":923,"productId":0,"name":"Доставка крупногабаритного груза","price":1500,"currency":"RUB","quantity":1,"measureCode":"796","measureName":"шт"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.basketitem.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 BasketItemAddResult = {
basketItem: {
id: number
orderId: number
productId: number
name: string
sort: number
quantity: number
price?: number
basePrice: number
discountPrice?: number
currency: string
customPrice: string
vatRate: number | null
vatIncluded?: string
weight?: number
dimensions?: string
measureCode?: string
measureName?: string
canBuy: string
xmlId: string
catalogXmlId?: string
productXmlId?: string
dateInsert: ISODate | null
dateUpdate: ISODate | null
properties: unknown[]
reservations: unknown[]
}
}
try {
const response = await $b24.actions.v2.call.make<BasketItemAddResult>({
method: 'sale.basketitem.add',
params: {
fields: {
orderId: 923,
productId: 0,
name: 'Доставка крупногабаритного груза',
price: 1500,
currency: 'RUB',
quantity: 1,
measureCode: '796',
measureName: 'шт',
},
},
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.basketItem.id, result.basketItem.name, result.basketItem.price)
}
} 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 addBasketItem() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.basketitem.add',
params: {
fields: {
orderId: 923,
productId: 0,
name: 'Доставка крупногабаритного груза',
price: 1500,
currency: 'RUB',
quantity: 1,
measureCode: '796',
measureName: 'шт',
},
},
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.basketItem.id, result.basketItem.name, result.basketItem.price)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addBasketItem)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"orderId": 923,
"productId": 0,
"name": "Доставка крупногабаритного груза",
"price": 1500,
"currency": "RUB",
"quantity": 1,
"measureCode": "796",
"measureName": "шт",
}
try:
bitrix_response = client.sale.basketitem.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.basketitem.add',
[
'fields' => [
'orderId' => 923,
'productId' => 0,
'name' => 'Доставка крупногабаритного груза',
'price' => 1500,
'currency' => 'RUB',
'quantity' => 1,
'measureCode' => '796',
'measureName' => 'шт',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error adding basket item: ' . $e->getMessage();
}
BX24.callMethod(
"sale.basketitem.add",
{
fields: {
orderId: 923,
productId: 0,
name: 'Доставка крупногабаритного груза',
price: 1500,
currency: 'RUB',
quantity: 1,
measureCode: '796',
measureName: 'шт',
}
},
)
.then(
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data());
}
},
function(error)
{
console.info(error);
}
);
require_once('crest.php');
$result = CRest::call(
'sale.basketitem.add',
[
'fields' =>
[
'orderId' => 923,
'productId' => 0,
'name' => 'Доставка крупногабаритного груза',
'price' => 1500,
'currency' => 'RUB',
'quantity' => 1,
'measureCode' => '796',
'measureName' => 'шт',
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.basketitem.add", b24.Params{
"fields": b24.Params{
"orderId": 923,
"productId": 0,
"name": "Доставка крупногабаритного груза",
"price": 1500,
"currency": "RUB",
"quantity": 1,
"measureCode": "796",
"measureName": "шт",
},
})
if err != nil {
return fmt.Errorf("sale.basketitem.add: %w", err)
}
// Метод заворачивает ответ в объект с ключом "basketItem".
raw, ok := b24.Unwrap(res.Result, "basketItem")
if !ok {
return fmt.Errorf("в ответе нет ключа basketItem")
}
var item struct {
ID int `json:"id"`
OrderID int `json:"orderId"`
ProductID int `json:"productId"`
Name string `json:"name"`
Price float64 `json:"price"`
Currency string `json:"currency"`
Quantity float64 `json:"quantity"`
MeasureCode string `json:"measureCode"`
MeasureName string `json:"measureName"`
CustomPrice string `json:"customPrice"`
}
if err := json.Unmarshal(raw, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.Name, item.Price)
Частые кейсы и сценарии
Обработка ответа
HTTP-статус: 200
{
"result": {
"basketItem": {
"basePrice": 0,
"canBuy": "Y",
"currency": "RUB",
"customPrice": "Y",
"dateInsert": "2026-09-28T08:49:12+03:00",
"dateUpdate": "2026-09-28T08:49:12+03:00",
"id": 1313,
"measureCode": "796",
"measureName": "шт",
"name": "Доставка крупногабаритного груза",
"orderId": 923,
"price": 1500,
"productId": 0,
"properties": [],
"quantity": 1,
"reservations": [],
"sort": 100,
"vatRate": null,
"xmlId": "bx_6aba0de846c91"
}
},
"total": 1,
"time": {
"start": 1790578152,
"finish": 1790578153.972347,
"duration": 1.9723470211029053,
"processing": 1,
"date_start": "2026-09-28T09:49:12+03:00",
"date_finish": "2026-09-28T09:49:13+03:00",
"operating_reset_at": 1790578752,
"operating": 1.7863950729370117
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
basketItem |
Объект с данными созданной позиции корзины. Основные поля:
В ответе |
|
total |
Число обработанных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "200140400011",
"error_description": "Currency must be the currency of the order"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
|
|
Позиция не создана. Ошибка возникает, если передан несуществующий идентификатор товара или товар неактивен |
|
|
Заказ с переданным |
|
|
Валюта позиции не совпадает с валютой заказа |
|
|
Недостаточно прав для добавления |
|
|
Не передан параметр |
|
|
В |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Корзина в Интернет-магазине: обзор методов
- Изменить позицию корзины заказа sale.basketitem.update
- Получить позицию корзины sale.basketitem.get
- Получить список позиций корзины sale.basketitem.list
- Удалить позицию из корзины заказа sale.basketitem.delete
- Добавить позицию с товаром из каталога в корзину заказа sale.basketitem.addCatalogProduct
- Изменить позицию с товаром из каталога sale.basketitem.updateCatalogProduct
- Получить поля позиции корзины sale.basketitem.getFields
- Получить поля позиции с товаром из каталога sale.basketitem.getFieldsCatalogProduct