Change the position of the basket in an existing order sale.basketitem.update
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.basketitem.update modifies the position of the basket in an existing order.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
Identifier of the order item |
|
|
fields* |
Values of the fields to be modified |
Parameter fields
|
Name |
Description |
|
sort |
Position in the list of order items |
|
price |
Price including markups and discounts |
|
basePrice |
Original price excluding markups and discounts |
|
discountPrice |
Amount of the final discount or markup |
|
quantity |
Quantity of the product |
|
xmlId |
External code of the basket item |
|
name |
Name of the product |
|
weight |
Weight of the product |
|
dimensions |
Dimensions of the product (serialized array) |
|
measureCode |
Code of the product's unit of measure |
|
measureName |
Name of the unit of measure |
|
canBuy |
Availability flag of the product. Possible values:
|
|
vatRate |
Tax rate as a fraction of one: |
|
vatIncluded |
Flag indicating whether VAT or tax is included in the product price. Possible values:
|
|
catalogXmlId |
External code of the product catalog |
|
productXmlId |
External code of the product |
Code Examples
How to Use Examples in Documentation
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: {
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
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 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.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 and ctx are already created — see the Go SDK section
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)
}
// The method wraps the response in an object with the "basketItem" key.
raw, ok := b24.Unwrap(res.Result, "basketItem")
if !ok {
return fmt.Errorf("no basketItem key in the response")
}
var item struct {
BasePrice int `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("parse response: %w", err)
}
fmt.Println(item.BasePrice, item.CanBuy)
Response Handling
HTTP status: 200
{
"result": {
"basketItem": {
"basePrice": 1000,
"canBuy": "Y",
"catalogXmlId": "",
"currency": "USD",
"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": "pcs",
"name": "Sample Product",
"orderId": 5147,
"price": 10,
"productId": 0,
"productXmlId": "ProductKey",
"properties": [],
"quantity": 7,
"reservations": [],
"sort": 400,
"type": null,
"vatIncluded": "Y",
"vatRate": 10,
"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
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
basketItem |
Object containing data of the updated basket item |
|
total |
Number of processed records |
|
time |
Information about the execution time of the request |
Error Handling
HTTP status: 400
{
"error":0,
"error_description":"error"
}
|
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 |
|
|
Basket item not found |
|
|
Order ID not specified |
|
|
Order not found |
|
|
Item currency does not match the order's currency |
|
|
Insufficient permissions to modify |
|
|
Required parameters not specified |
|
|
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 |
Continue Learning
- Add Item (Position) to the Cart of an Existing Order sale.basketitem.add
- Get Information About a Basket Item (Position) sale.basketitem.get
- Get a List of Items (Positions) in the Cart sale.basketitem.list
- Remove item (position) from the cart using sale.basketitem.delete
- Get Available Fields of the Basket Item (sale.basketitem.getFields)
- Add a position with a product or service from the catalog module to the cart of an existing order sale.basketitem.addCatalogProduct
- Change the basket item position (catalog product) of an existing order sale.basketitem.updateCatalogProduct
- Get Available Fields of a Basket Item (Product from Catalog) sale.basketitem.getFieldsCatalogProduct