Add Item (Position) to the Cart of an Existing Order sale.basketitem.add
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.add adds an item to the cart of an existing order.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Field values for creating an item (position) in the cart of the order |
Parameter fields
Required parameters are marked with *
Field values marked with ** will be taken from the product data on the site if a valid product identifier is passed in the productid field. If the product does not exist on the site, the field must be filled in manually.
|
Name |
Description |
|
orderId* |
Order identifier |
|
sort |
Position in the list of order items |
|
productid* |
Product/variation identifier. For products that are not on the site/account, it may be zero |
|
price |
Price including markups and discounts (see the The field will be filled automatically if |
|
basePrice |
Original price excluding markups and discounts (see the The field will be filled automatically if |
|
discountPrice |
Amount of the final discount or markup (see the The field will be filled automatically if |
|
currency* |
Currency of the price. Must match the currency of the order |
|
customPrice |
Is the price specified manually. Possible values:
If |
|
quantity* |
Quantity of the product |
|
xmlId |
External code of the cart item |
|
name*,** |
Product name |
|
weight** |
Weight of the product |
|
dimensions** |
Dimensions of the product (serialized array) |
|
measureCode** |
Unit code of the product |
|
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 '{"fields":{"orderId":5147,"quantity":2,"productId":6544,"currency":"USD"}}' \
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":5147,"quantity":2,"productId":6544,"currency":"USD"},"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: 5147,
quantity: 2,
productId: 6544,
currency: 'USD',
},
},
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: 5147,
quantity: 2,
productId: 6544,
currency: 'USD',
},
},
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": 5147,
"quantity": 2,
"productId": 6544,
"currency": "USD",
}
try:
bitrix_response = client.sale.basketitem.add(
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.add',
[
'fields' => [
'orderId' => 5147,
'quantity' => 2,
'productId' => 6544,
'currency' => 'USD',
],
]
);
$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: { // minimum set of required fields
orderId: 5147,
quantity: 2,
productId: 6544,
currency: 'USD',
}
},
)
.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' => 5147,
'quantity' => 2,
'productId' => 6544,
'currency' => 'USD',
]
]
);
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.add", b24.Params{
"fields": b24.Params{
"orderId": 5147,
"quantity": 2,
"productId": 6544,
"currency": "EUR",
},
})
if err != nil {
return fmt.Errorf("sale.basketitem.add: %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)
Typical use-cases and scenarios
Response Handling
HTTP status: 200
{
"result": {
"basketItem": {
"basePrice": 1000,
"canBuy": "Y",
"catalogXmlId": "FUTURE-QUICKBOOKS-CATALOG",
"currency": "USD",
"customPrice": "N",
"dateInsert": "2024-04-23T15:59:37+02:00",
"dateUpdate": "2024-04-23T15:59:37+02:00",
"dimensions": "a:3:{s:5:\"WIDTH\";N;s:6:\"HEIGHT\";N;s:6:\"LENGTH\";N;}",
"discountPrice": 100,
"id": 6790,
"measureCode": "163",
"measureName": "g",
"name": "Product",
"orderId": 5147,
"price": 900,
"productId": 1245,
"productXmlId": "1245",
"properties": [],
"quantity": 1,
"reservations": [],
"sort": 100,
"vatIncluded": "N",
"vatRate": null,
"weight": 0,
"xmlId": "bx_6627bec8c4fdc"
}
},
"total": 1,
"time": {
"start": 1713880776.108755,
"finish": 1713880777.704221,
"duration": 1.595465898513794,
"processing": 0.973701000213623,
"date_start": "2024-04-23T15:59:36+02:00",
"date_finish": "2024-04-23T15:59:37+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
basketItem |
Object with data of the created item (position) in the cart |
|
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 |
|
|
The item was not created. The error occurs if an invalid product identifier is passed or if the product is inactive |
|
|
Order identifier is not specified |
|
|
Order not found |
|
|
The currency of the item does not match the currency of the order |
|
|
Insufficient permissions to add |
|
|
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
- 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
- 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