Change the basket item position (catalog product) of an existing order sale.basketitem.updateCatalogProduct
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
saleWho can execute the method: administrator
The method sale.basketitem.updateCatalogProduct changes the basket item position (catalog product) of an existing order.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
Identifier of the basket item. Can be obtained using the methods sale.basketitem.addCatalogProduct and sale.basketitem.list |
|
|
fields* |
Object with modifiable fields |
fields Parameter
Required parameters are marked with *
|
Name |
Description |
|
sort |
Position in the order item list |
|
quantity* |
Quantity of the product |
|
xmlId |
External code of the basket item |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":6783,"fields":{"quantity":4}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.basketitem.updateCatalogProduct
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":6783,"fields":{"quantity":4},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.basketitem.updateCatalogProduct
// 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,
productXmlId: string,
quantity: number,
sort: number,
type: number,
vatIncluded: string,
vatRate: number | null,
weight: number,
xmlId: string,
},
}
try {
const response = await $b24.actions.v2.call.make<BasketItemUpdateResult>({
method: 'sale.basketitem.updateCatalogProduct',
params: {
id: 6783,
fields: {
quantity: 4,
},
},
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)
}
} 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 updateCatalogProduct() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.basketitem.updateCatalogProduct',
params: {
id: 6783,
fields: {
quantity: 4,
},
},
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)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateCatalogProduct)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"quantity": 4,
}
try:
bitrix_response = client.sale.basketitem.update_catalog_product(
bitrix_id=6783,
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.updateCatalogProduct',
[
'id' => 6783,
'fields' => [
'quantity' => 4,
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your required data processing logic
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating catalog product: ' . $e->getMessage();
}
BX24.callMethod(
"sale.basketitem.updateCatalogProduct",
{
id: 6783,
fields: {
quantity: 4,
}
},
)
.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.updateCatalogProduct',
[
'id' => 6783,
'fields' => [
'quantity' => 4,
]
]
);
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.updateCatalogProduct", b24.Params{
"id": 6783,
"fields": b24.Params{
"quantity": 4,
},
})
if err != nil {
return fmt.Errorf("sale.basketitem.updateCatalogProduct: %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": 1234,
"canBuy": "Y",
"catalogXmlId": "FUTURE-QUICKBOOKS-CATALOG",
"currency": "USD",
"customPrice": "N",
"dateInsert": "2024-04-22T16:23:43+02:00",
"dateUpdate": "2024-04-22T16:32:26+02:00",
"dimensions": "a:3:{s:5:\"WIDTH\";N;s:6:\"HEIGHT\";N;s:6:\"LENGTH\";N;}",
"discountPrice": 124,
"id": 6783,
"measureCode": "796",
"measureName": "pcs",
"name": " Design Development ",
"orderId": 5147,
"price": 1110,
"productid": 4347,
"productXmlId": "4347",
"properties": [],
"quantity": 4,
"reservations": [],
"sort": 100,
"type": 2,
"vatIncluded": "N",
"vatRate": null,
"weight": 0,
"xmlId": "bx_662672ef370c6"
}
},
"total": 1,
"time": {
"start": 1713796344.951712,
"finish": 1713796346.586924,
"duration": 1.6352121829986572,
"processing": 0.6428370475769043,
"date_start": "2024-04-22T16:32:24+02:00",
"date_finish": "2024-04-22T16:32:26+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
basketItem |
Object with data of the created basket item |
|
total |
Number of processed records |
|
time |
Information about the request execution time |
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 |
|
|
The Trade Catalog module is missing |
|
|
Basket item not found |
|
|
Order ID is not specified |
|
|
Order not found |
|
|
The item's currency does not match the order's currency |
|
|
Insufficient permissions to modify |
|
|
Required parameters are 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 |
|
|
|
The REST API is available only on commercial plans. 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
- Change the position of the basket in an existing order sale.basketitem.update
- 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
- Get Available Fields of a Basket Item (Product from Catalog) sale.basketitem.getFieldsCatalogProduct