Получить список позиций корзины sale.basketitem.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
saleКто может выполнять метод: менеджер магазина
Метод sale.basketitem.list возвращает список позиций корзины, отобранных по фильтру.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
select |
Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_basket_item). Имена полей передавайте в camelCase, как в ответе: Если массив не передан, передан пустой массив или в нем нет ни одного известного поля, то будут выбраны все поля позиции. Неизвестные поля метод пропускает без ошибки. Свойства и резервы позиции ( |
|
filter |
Объект для фильтрации выбранных записей в формате Возможные значения для В выборку попадают и позиции, которые не входят в заказ: у них Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных записей в формате Возможные значения для Возможные значения для
По умолчанию позиции сортируются по возрастанию |
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов, передайте значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
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",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {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);
// Нужная вам логика обработки данных
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 и ctx уже созданы — см. раздел «SDK для Go»
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)
}
// Метод заворачивает ответ в объект с ключом "basketItems".
raw, ok := b24.Unwrap(res.Result, "basketItems")
if !ok {
return fmt.Errorf("в ответе нет ключа basketItems")
}
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("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.Currency)
}
Обработка ответа
HTTP-статус: 200
{
"result": {
"basketItems": [
{
"currency": "RUB",
"id": 6802,
"name": "Стул офисный",
"orderId": 5147,
"price": 1100,
"productId": 4343
},
{
"currency": "RUB",
"id": 6791,
"name": "Подарочная упаковка",
"orderId": 5146,
"price": 900,
"productId": 0
},
{
"currency": "RUB",
"id": 6770,
"name": "Сборка",
"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
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
basketItems |
Массив объектов с информацией о выбранных позициях корзины. Набор полей в каждом объекте задает параметр |
|
next |
Значение |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "100",
"error_description": "Invalid value {x} to match with parameter {filter}. Should be value of type array."
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только |
|
error_description |
Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для чтения |
|
|
В |
|
|
В |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Корзина в Интернет-магазине: обзор методов
- Добавить произвольную позицию в корзину заказа sale.basketitem.add
- Изменить позицию корзины заказа sale.basketitem.update
- Получить позицию корзины sale.basketitem.get
- Удалить позицию из корзины заказа sale.basketitem.delete
- Добавить позицию с товаром из каталога в корзину заказа sale.basketitem.addCatalogProduct
- Изменить позицию с товаром из каталога sale.basketitem.updateCatalogProduct
- Получить поля позиции корзины sale.basketitem.getFields
- Получить поля позиции с товаром из каталога sale.basketitem.getFieldsCatalogProduct