Добавить произвольную позицию в корзину заказа sale.basketitem.add

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: sale

Кто может выполнять метод: администратор

Метод sale.basketitem.add добавляет позицию в корзину существующего заказа.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

fields*
object

Значения полей позиции корзины (подробное описание)

Параметр fields

Обязательные параметры отмечены *

Значения полей, отмеченных **, будут взяты из данных о товаре в каталоге, если в поле productId передан реальный идентификатор товара. Переданные значения этих полей для товара из каталога не сохраняются. Для произвольной позиции заполните эти поля самостоятельно.

Название
тип

Описание

orderId*
sale_order.id

Идентификатор заказа

sort
integer

Положение в списке позиций заказа. По умолчанию 100

productId*
catalog_product.id

Идентификатор товара или вариации из каталога.

Для произвольной позиции, которой нет в каталоге, передайте 0. Для товара из каталога удобнее метод sale.basketitem.addCatalogProduct

price
double

Цена за единицу с учетом наценок и скидок.

Если передать price, цена сохранится как указанная вручную: в ответе будет customPrice = Y, а пересчета из каталога не будет. Если не передать, для товара из каталога цена берется из каталога, для произвольной позиции — 0

basePrice
double

Исходная цена без учета наценок и скидок. Для товара из каталога по умолчанию берется из каталога. У произвольной позиции без basePrice поле равно 0, даже если передан price

discountPrice
double

Величина итоговой скидки или наценки. Если передаете price, basePrice и discountPrice сами, соблюдайте условие basePrice = price + discountPrice

currency*
crm_currency.CURRENCY

Валюта цены. Должна совпадать с валютой заказа, иначе метод вернет ошибку 200140400011. Валюту заказа возвращает метод sale.order.get

quantity*
double

Количество товара

xmlId
string

Внешний код позиции корзины. Если не передать, Битрикс24 создаст код вида bx_6ab9ff3cc2d0a

name**
string

Название товара. Для произвольной позиции передайте его явно: без name позиция создастся без названия

weight**
double

Вес товара. Сохраняется в том виде, в котором передан

dimensions**
string

Размеры товара — строка с сериализованным PHP-массивом с ключами WIDTH, HEIGHT, LENGTH, например a:3:{s:5:"WIDTH";i:100;s:6:"HEIGHT";i:200;s:6:"LENGTH";i:300;}. Если передать объект, вместо размеров сохранится строка Array

measureCode**
catalog_measure.code

Код единицы измерения товара

measureName**
catalog_measure.symbol

Название единицы измерения

canBuy**
string

Флаг доступности товара. Возможные значения:

  • Y — да
  • N — нет

У произвольной позиции по умолчанию Y

vatRate**
double

Ставка налога долей от единицы: 0.1 — это 10 %. Для ставки «Без НДС» передайте пустую строку

vatIncluded**
string

Флаг того, включен ли НДС или налог в цену товара. Возможные значения:

  • Y — да
  • N — нет

У произвольной позиции по умолчанию Y

catalogXmlId**
string

Внешний код каталога товаров

productXmlId**
string

Внешний код товара

Примеры кода

Как использовать примеры в документации

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
object

Корневой элемент ответа

basketItem
sale_basket_item

Объект с данными созданной позиции корзины. Основные поля:

  • id — идентификатор позиции, его передают в sale.basketitem.update, sale.basketitem.get и sale.basketitem.delete
  • orderId, productId, name, quantity, currency — данные позиции
  • price, basePrice, discountPrice — цена за единицу, исходная цена и скидка
  • customPrice — Y, если цена задана вручную, N — если взята из каталога
  • xmlId — внешний код позиции
  • properties — свойства позиции, массив sale_basket_item_property
  • reservations — резервы позиции, массив sale_basket_item_reservation

В ответе add для произвольной позиции нет полей, которые не переданы в запросе: в примере выше это discountPrice, weight, dimensions, vatIncluded, catalogXmlId, productXmlId, type, barcodeMulti. Их значения возвращает sale.basketitem.get. Полный список полей — в описании типа sale_basket_item

total
integer

Число обработанных записей

time
time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error": "200140400011",
    "error_description": "Currency must be the currency of the order"
}

Название
тип

Описание

error
string

Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только error_description

error_description
string

Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Код

Описание

200140400007

basket item is not saved - bad data

Позиция не создана. Ошибка возникает, если передан несуществующий идентификатор товара или товар неактивен

200140400009

Order not found

Заказ с переданным orderId не найден

200140400011

Currency must be the currency of the order

Валюта позиции не совпадает с валютой заказа

200040300010

Недостаточно прав для добавления

100

Could not find value for parameter {fields}

Не передан параметр fields

0

Required fields: orderId

В fields не передано обязательное поле. Вместо orderId в тексте будет имя пропущенного поля: productId, quantity или currency

0

Другие ошибки (например, фатальные ошибки)

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение