Add a Catalog Product Item to an Order Cart sale.basketitem.addCatalogProduct
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.addCatalogProduct adds a position (item) with a product or service from the catalog module to the cart of an existing order.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
Field values for creating a cart item in the order (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
orderId* |
Order identifier. It cannot be changed after the item is created. Retrieve the identifier using the sale.order.add or sale.order.list method |
|
productId* |
Identifier of a product, service, or variation from the catalog. It cannot be changed after the item is created. Retrieve the identifier using the catalog.product.list method |
|
quantity* |
Quantity of the product. Pass a value greater than |
|
currency* |
Currency of the price, for example |
|
price |
Unit price including discounts and markups. If the parameter is not passed, Bitrix24 calculates the price from the catalog data. If the parameter is passed, the item gets If the product has no price in the catalog, pass |
|
sort |
Position in the order item list. Default is |
|
xmlId |
External code of the cart item. If not passed, Bitrix24 generates the code itself, for example |
The method takes the name, unit of measure, base price basePrice, discount discountPrice, weight, and VAT from the product card in the catalog. If you pass them in fields, the values are ignored. To set the item name and price manually, use the sale.basketitem.add method.
The full list of fields, with required and read-only flags, is returned by the sale.basketitem.getFieldsCatalogProduct method.
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":1,"productId":4347,"currency":"USD"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.basketitem.addCatalogProduct
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"orderId":5147,"quantity":1,"productId":4347,"currency":"USD"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.basketitem.addCatalogProduct
// 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 AddCatalogProductResult = {
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: object[]
quantity: number
reservations: object[]
sort: number
type: number
vatIncluded: string
vatRate: number | null
weight: number
xmlId: string
}
}
try {
const response = await $b24.actions.v2.call.make<AddCatalogProductResult>({
method: 'sale.basketitem.addCatalogProduct',
params: {
fields: {
orderId: 5147,
quantity: 1,
productId: 4347,
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 addCatalogProduct() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'sale.basketitem.addCatalogProduct',
params: {
fields: {
orderId: 5147,
quantity: 1,
productId: 4347,
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', addCatalogProduct)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
fields = {
"orderId": 5147,
"quantity": 1,
"productId": 4347,
"currency": "USD",
}
try:
bitrix_response = client.sale.basketitem.add_catalog_product(
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.addCatalogProduct',
[
'fields' => [
'orderId' => 5147,
'quantity' => 1,
'productId' => 4347,
'currency' => 'USD',
],
]
);
$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 adding catalog product: ' . $e->getMessage();
}
BX24.callMethod(
"sale.basketitem.addCatalogProduct",
{
fields: {
orderId: 5147,
quantity: 1,
productId: 4347,
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.addCatalogProduct',
[
'fields' => [
'orderId' => 5147,
'quantity' => 1,
'productId' => 4347,
'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.addCatalogProduct", b24.Params{
"fields": b24.Params{
"orderId": 5147,
"quantity": 1,
"productId": 4347,
"currency": "EUR",
},
})
if err != nil {
return fmt.Errorf("sale.basketitem.addCatalogProduct: %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 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("parse response: %w", err)
}
fmt.Println(item.BasePrice, item.CanBuy)
Response Handling
HTTP status: 200
{
"result": {
"basketItem": {
"barcodeMulti": "N",
"basePrice": 1234,
"canBuy": "Y",
"catalogXmlId": "FUTURE-QUICKBOOKS-CATALOG",
"currency": "USD",
"customPrice": "N",
"dateInsert": "2024-04-22T16:36:43+02:00",
"dateUpdate": "2024-04-22T16:36:43+02:00",
"dimensions": "a:3:{s:5:\"WIDTH\";N;s:6:\"HEIGHT\";N;s:6:\"LENGTH\";N;}",
"discountPrice": 124,
"id": 6784,
"measureCode": "796",
"measureName": "pcs",
"name": "Service2",
"orderId": 5147,
"price": 1110,
"productId": 4347,
"productXmlId": "4347",
"properties": [],
"quantity": 1,
"reservations": [],
"sort": 100,
"type": 2,
"vatIncluded": "N",
"vatRate": null,
"weight": 0,
"xmlId": "bx_662675fba6516"
}
},
"total": 1,
"time": {
"start": 1713796602.830767,
"finish": 1713796604.315251,
"duration": 1.4844841957092285,
"processing": 0.6749260425567627,
"date_start": "2024-04-22T16:36:42+02:00",
"date_finish": "2024-04-22T16:36:44+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
basketItem |
The created cart item. Key fields:
For the description of all fields, see the sale_basket_item type |
|
total |
Number of processed records |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "200140400011",
"error_description": "Currency must be the currency of the order"
}
|
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 |
|
|
Required fields are not passed. The error text lists all missing fields out of |
|
|
The Trade Catalog module is not installed |
|
|
The item was not created: there is no product with this In this case, an empty item with no product and no price may remain in the order. Find it using the sale.basketitem.list method and delete it using the sale.basketitem.delete method |
|
|
The order with this |
|
|
The |
|
|
Insufficient rights to add the item |
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
- Shopping Cart in Online Store: Overview of Methods
- Add a Custom Item to an Order Cart sale.basketitem.add
- Update an Order Cart Item sale.basketitem.update
- Get a Cart Item sale.basketitem.get
- Get a List of Cart Items sale.basketitem.list
- Remove an Item from an Order Cart sale.basketitem.delete
- Update a Catalog Product Item sale.basketitem.updateCatalogProduct
- Get Cart Item Fields sale.basketitem.getFields
- Get Catalog Product Item Fields sale.basketitem.getFieldsCatalogProduct