Add a position with a product or service from the catalog module to the cart of an existing order sale.basketitem.addCatalogProduct
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
This method 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 an item (position) in the order cart |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
orderId* |
Order identifier. Can only be specified when creating a cart position. Must be obtained earlier using the methods sale.order.add or sale.order.list |
|
sort |
Position in the order item list |
|
productid* |
Identifier of the product/variation |
|
price |
Price considering markups and discounts (see the The field will be automatically filled if |
|
basePrice |
Original price without considering markups and discounts (see the The field will be automatically filled if |
|
discountPrice |
Amount of the final discount or markup (see the The field will be automatically filled if |
|
currency* |
Currency of the price. Must match the currency of the order |
|
customPrice |
Is the price specified manually:
Default value is If |
|
quantity* |
Quantity of the product |
|
xmlId |
External code of the cart position |
|
name* |
Name 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":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: {
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>
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>';
Response Handling
HTTP status: 200
{
"result": {
"basketItem": {
"basePrice": 1234,
"canBuy": "Y",
"catalogXmlId": "FUTURE-1C-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 |
Object with data of the created item (position) in the cart |
|
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 may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
|
|
The Trade Catalog module (catalog) is missing |
|
|
The item was not created. The error occurs if an incorrect product identifier is passed or if the product is inactive |
|
|
Order identifier is not specified |
|
|
Order not found |
|
|
The position currency does not match the order currency |
|
|
Insufficient rights to add |
|
|
Required parameters are not specified |
|
|
Other errors (e.g., fatal errors) |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site 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)
- 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