Get a List of Cart Items sale.basketitem.list
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: store manager
The method sale.basketitem.list retrieves a list of cart items that match the filter.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
select |
An array of fields to be selected (see fields of the sale_basket_item object). Pass field names in camelCase, as in the response: If the array is not provided, is empty, or contains no known fields, all fields of the cart item are selected. The method skips unknown fields without an error. The method does not return the cart item properties and reservations ( |
|
filter |
An object for filtering the selected records in the format Possible values for The selection also includes cart items that do not belong to any order: their An additional prefix can be specified for the key to clarify the filter's behavior. Possible prefix values:
|
|
order |
An object for sorting the selected records in the format Possible values for Possible values for
By default, cart items are sorted by |
|
start |
This parameter is used to manage pagination. The page size of results is always static — 50 records. To select the second page of results, pass the value The formula for calculating the
|
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","orderId","productId","name","price","currency"],"filter":{"@orderId":[5147,5146]},"order":{"id":"desc"},"start":0}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.basketitem.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","orderId","productId","name","price","currency"],"filter":{"@orderId":[5147,5146]},"order":{"id":"desc"},"start":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/sale.basketitem.list
// 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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type BasketItemListResult = {
basketItems: {
id: number
orderId: number
productId: number
name: string
price: number
currency: string
}[]
}
try {
// sale.basketitem.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<BasketItemListResult>({
method: 'sale.basketitem.list',
params: {
select: [
'id',
'orderId',
'productId',
'name',
'price',
'currency',
],
filter: {
'@orderId': [5147, 5146],
},
order: {
id: 'desc',
},
start: 0,
},
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('Basket items:', result.basketItems, 'Count:', result.basketItems.length)
}
} 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 listBasketItems() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// sale.basketitem.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make({
method: 'sale.basketitem.list',
params: {
select: [
'id',
'orderId',
'productId',
'name',
'price',
'currency',
],
filter: {
'@orderId': [5147, 5146],
},
order: {
id: 'desc',
},
start: 0,
},
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('Basket items:', result.basketItems, 'Count:', result.basketItems.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listBasketItems)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.sale.basketitem.list(
select=[
"id",
"orderId",
"productId",
"name",
"price",
"currency",
],
filter={
"@orderId": [
5147,
5146,
],
},
order={
"id": "desc",
},
start=0,
).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.list',
[
'select' => [
'id',
'orderId',
'productId',
'name',
'price',
'currency',
],
'filter' => [
'@orderId' => [5147, 5146],
],
'order' => [
'id' => 'desc',
],
'start' => 0,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your data processing logic
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error: ' . $e->getMessage();
}
BX24.callMethod(
"sale.basketitem.list",
{
select: [
'id',
'orderId',
'productId',
'name',
'price',
'currency',
],
filter: {
'@orderId': [5147, 5146],
},
order: {
id: 'desc',
},
start: 0,
},
)
.then(
function(result)
{
if (result.error())
{
console.error(result.error());
}
else
{
console.log(result.data);
if (result.more())
{
result.next();
}
}
},
function(error)
{
console.info(error);
}
);
require_once('crest.php');
$result = CRest::call(
'sale.basketitem.list',
[
'select' => [
'id',
'orderId',
'productId',
'name',
'price',
'currency',
],
'filter' => [
'@orderId' => [5147, 5146],
],
'order' => [
'id' => 'desc',
],
'start' => 0,
]
);
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.list", b24.Params{
"select": []string{"id", "orderId", "productId", "name", "price", "currency"},
"filter": b24.Params{
"@orderId": []int{5147, 5146},
},
"order": b24.Params{
"id": "desc",
},
"start": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("sale.basketitem.list: %w", err)
}
// The method wraps the response in an object with the "basketItems" key.
raw, ok := b24.Unwrap(res.Result, "basketItems")
if !ok {
return fmt.Errorf("no basketItems key in the response")
}
var items []struct {
Currency string `json:"currency"`
ID b24.ID `json:"id"`
Name string `json:"name"`
OrderID b24.ID `json:"orderId"`
Price float64 `json:"price"`
ProductID b24.ID `json:"productId"`
}
if err := json.Unmarshal(raw, &items); err != nil {
return fmt.Errorf("parse response: %w", err)
}
for _, it := range items {
fmt.Println(it.Currency)
}
Response Handling
HTTP Status: 200
{
"result": {
"basketItems": [
{
"currency": "USD",
"id": 6802,
"name": "Office Chair",
"orderId": 5147,
"price": 1100,
"productId": 4343
},
{
"currency": "USD",
"id": 6791,
"name": "Gift Wrapping",
"orderId": 5146,
"price": 900,
"productId": 0
},
{
"currency": "USD",
"id": 6770,
"name": "Assembly",
"orderId": 5146,
"price": 1110,
"productId": 4342
}
]
},
"total": 3,
"time": {
"start": 1713958546.058793,
"finish": 1713958548.507179,
"duration": 2.4483859539031982,
"processing": 0.2580289840698242,
"date_start": "2024-04-24T13:35:46+02:00",
"date_finish": "2024-04-24T13:35:48+02:00",
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response |
|
basketItems |
An array of objects containing information about the selected cart items. The set of fields in each object is defined by the |
|
next |
The |
|
total |
Total number of records found |
|
time |
Information about the request execution time |
Error Handling
HTTP Status: 400
{
"error": "100",
"error_description": "Invalid value {x} to match with parameter {filter}. Should be value of type array."
}
|
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 |
|
|
Insufficient permissions to read |
|
|
A value that is not an array or object is passed in |
|
|
The sort direction in |
|
|
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
- 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
- Remove an Item from an Order Cart sale.basketitem.delete
- Add a Catalog Product Item to an Order Cart sale.basketitem.addCatalogProduct
- Update a Catalog Product Item sale.basketitem.updateCatalogProduct
- Get Cart Item Fields sale.basketitem.getFields
- Get Catalog Product Item Fields sale.basketitem.getFieldsCatalogProduct