Изменить позицию корзины заказа sale.basketitem.update

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

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

Scope: sale

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

Метод sale.basketitem.update изменяет позицию корзины существующего заказа. После изменения количества или цены Битрикс24 пересчитывает сумму заказа.

Для позиции с товаром из каталога есть метод sale.basketitem.updateCatalogProduct: он берет название и валюту позиции из каталога.

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

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

Название
тип

Описание

id*
sale_basket_item.id

Идентификатор позиции корзины. Получить идентификаторы позиций можно методом sale.basketitem.list

fields*
object

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

Параметр fields

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

Название
тип

Описание

quantity*
double

Количество товара. Передавайте в каждом вызове, даже если количество не меняется, иначе метод вернет ошибку Required fields: quantity.

Нулевое, отрицательное или нечисловое значение метод игнорирует без ошибки

sort
integer

Положение в списке позиций корзины

price
double

Цена с учетом наценок и скидок. Если передать цену, Битрикс24 установит позиции customPrice = Y — цена считается указанной вручную и больше не берется из каталога

basePrice
double

Исходная цена без учета наценок и скидок. Передавайте вместе с price и discountPrice так, чтобы выполнялось условие basePrice = price + discountPrice

discountPrice
double

Величина итоговой скидки или наценки. Для наценки значение отрицательное

xmlId
string

Внешний код позиции корзины

name
string

Название товара

weight
double

Вес товара. Позиция из каталога получает значение поля weight товара без пересчета, поэтому передавайте вес в тех же единицах, что в каталоге

dimensions
string

Размеры товара — строка с PHP-сериализованным массивом с ключами WIDTH, HEIGHT и LENGTH, например a:3:{s:5:"WIDTH";i:244;s:6:"HEIGHT";i:100;s:6:"LENGTH";i:31;}. В таком виде размеры хранятся у позиций, добавленных из каталога.

Метод не проверяет формат и сохраняет любую строку как есть. Если передать объект вместо строки, сохранится значение Array

measureCode
catalog_measure.code

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

measureName
catalog_measure.symbol

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

canBuy
string

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

  • Y — да
  • N — нет

vatRate
double

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

vatIncluded
string

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

  • Y — да
  • N — нет

Поля orderId, productId, currency, customPrice, catalogXmlId и productXmlId через sale.basketitem.update изменить нельзя. Метод игнорирует их без ошибки и возвращает прежние значения. Валюта позиции currency всегда совпадает с валютой заказа, ее задают при добавлении позиции.

Чтобы перенести товар в другой заказ или заменить товар, удалите позицию методом sale.basketitem.delete и добавьте новую методом sale.basketitem.add.

Неизвестные поля метод тоже пропускает без ошибки. Проверяйте результат по объекту basketItem в ответе.

Примеры кода

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

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":6791,"fields":{"quantity":7,"price":10,"discountPrice":990}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.basketitem.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":6791,"fields":{"quantity":7,"price":10,"discountPrice":990},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.basketitem.update
// 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 BasketItemUpdateResult = {
  basketItem: {
    barcodeMulti: string
    basePrice: number
    canBuy: string
    catalogXmlId: string
    currency: string
    customPrice: string
    dateInsert: ISODate | null
    dateUpdate: ISODate | null
    dimensions: string
    discountPrice: number
    id: number
    measureCode: string
    measureName: string
    name: string
    orderId: number
    price: number
    productId: number
    productXmlId: string
    properties: unknown[]
    quantity: number
    reservations: unknown[]
    sort: number
    type: string | null
    vatIncluded: string
    vatRate: number | null
    weight: number
    xmlId: string
  }
}

try {
  const response = await $b24.actions.v2.call.make<BasketItemUpdateResult>({
    method: 'sale.basketitem.update',
    params: {
      id: 6791,
      fields: {
        quantity: 7,
        price: 10,
        discountPrice: 990,
      },
    },
    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.quantity, 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 updateBasketItem() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'sale.basketitem.update',
        params: {
          id: 6791,
          fields: {
            quantity: 7,
            price: 10,
            discountPrice: 990,
          },
        },
        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.quantity, result.basketItem.price)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateBasketItem)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

fields = {
    "quantity": 7,
    "price": 10,
    "discountPrice": 990,
}

try:
    bitrix_response = client.sale.basketitem.update(
        bitrix_id=6791,
        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.update',
            [
                'id' => 6791,
                'fields' => [
                    'quantity'      => 7,
                    'price'         => 10,
                    'discountPrice' => 990,
                ],
            ]
        );

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

    echo 'Success: ' . print_r($result, true);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error updating basket item: ' . $e->getMessage();
}
BX24.callMethod(
    "sale.basketitem.update",
    {
        id: 6791,
        fields: {
            quantity: 7,
            price: 10,
            discountPrice: 990,
        }
    },
)
    .then(
        function(result)
        {
            if (result.error())
            {
                console.error(result.error());
            }
            else
            {
                console.log(result);
            }
        },
        function(error)
        {
            console.info(error);
        }
    );
require_once('crest.php');

$result = CRest::call(
    'sale.basketitem.update',
    [
        'id' => 6791,
        'fields' =>
        [
            'quantity' => 7,
            'price' => 10,
            'discountPrice' => 990,
        ]
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "sale.basketitem.update", b24.Params{
	"id": 6791,
	"fields": b24.Params{
		"quantity":      7,
		"price":         10,
		"discountPrice": 990,
	},
})
if err != nil {
	return fmt.Errorf("sale.basketitem.update: %w", err)
}

// Метод заворачивает ответ в объект с ключом "basketItem".
raw, ok := b24.Unwrap(res.Result, "basketItem")
if !ok {
	return fmt.Errorf("в ответе нет ключа basketItem")
}

var item struct {
	BasePrice    float64 `json:"basePrice"`
	CanBuy       string  `json:"canBuy"`
	CatalogXmlID string  `json:"catalogXmlId"`
	Currency     string  `json:"currency"`
	CustomPrice  string  `json:"customPrice"`
	DateInsert   string  `json:"dateInsert"`
}
if err := json.Unmarshal(raw, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.BasePrice, item.CanBuy)

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "basketItem": {
            "barcodeMulti": "N",
            "basePrice": 1000,
            "canBuy": "Y",
            "catalogXmlId": "",
            "currency": "RUB",
            "customPrice": "Y",
            "dateInsert": "2024-04-23T18:51:28+02:00",
            "dateUpdate": "2024-04-24T14:02:25+02:00",
            "dimensions": "a:3:{s:5:\"WIDTH\";i:244;s:6:\"HEIGHT\";i:100;s:6:\"LENGTH\";i:31;}",
            "discountPrice": 990,
            "id": 6791,
            "measureCode": "768",
            "measureName": "шт",
            "name": "Пробный товар",
            "orderId": 5147,
            "price": 10,
            "productId": 0,
            "productXmlId": "ProductKey",
            "properties": [],
            "quantity": 7,
            "reservations": [],
            "sort": 400,
            "type": null,
            "vatIncluded": "Y",
            "vatRate": 0.1,
            "weight": 40,
            "xmlId": "BasketPositionId"
        }
    },
    "total": 1,
    "time": {
        "start": 1713960144.842687,
        "finish": 1713960146.089664,
        "duration": 1.2469770908355713,
        "processing": 0.5501749515533447,
        "date_start": "2024-04-24T14:02:24+02:00",
        "date_finish": "2024-04-24T14:02:26+02:00",
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

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

basketItem
sale_basket_item

Обновленная позиция корзины. Содержит все поля позиции, а не только измененные. Ключевые поля:

  • id, orderId, productId — идентификаторы позиции, заказа и товара
  • name, quantity, currency — название товара, количество и валюта позиции
  • price, basePrice, discountPrice — цена за единицу, цена без скидок и размер скидки
  • customPrice — Y, если цена задана вручную, N, если рассчитана по каталогу
  • weight, dimensions — вес и размеры в том виде, в котором они сохранены
  • properties — массив свойств позиции
  • reservations — массив резервов позиции на складах

Описание всех полей — в типе sale_basket_item

total
integer

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

time
time

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

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

HTTP-статус: 400

{
    "error": "0",
    "error_description": "Required fields: quantity"
}

Название
тип

Описание

error
string

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

error_description
string

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

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

Код

Описание

0

Required fields: quantity

В fields не передано обязательное поле quantity

200140400001

basket item is not exists

Позиции корзины с таким id нет

200040300010

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

100

Could not find value for parameter {fields}

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

100

Bitrix\Sale\BasketItem constructor must be is public

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

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

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

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