Получить список элементов (позиций) корзины sale.basketitem.list
Scope:
saleКто может выполнять метод: менеджер магазина
Метод возвращает набор элементов (позиций) корзины, отобранных по фильтру.
Параметры метода
|
Название |
Описание |
|
select |
Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_basket_item). Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля торговых каталогов |
|
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
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
const parameters = {
select: [
'id',
'orderId',
'productId',
'name',
'price',
'currency',
],
filter: {
'@orderId': [5147, 5146],
},
order: {
id: 'desc',
},
start: 0,
};
try {
const response = await $b24.callListMethod(
'sale.basketitem.list',
parameters,
(progress) => { console.log('Progress:', progress) }
);
const items = response.getData() || [];
for (const entity of items) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', error);
}
// fetchListMethod: Выбирает данные по частям с помощью итератора. Используйте для больших объемов данных для эффективного потребления памяти.
try {
const generator = $b24.fetchListMethod('sale.basketitem.list', parameters, 'id');
for await (const page of generator) {
for (const entity of page) { console.log('Entity:', entity); }
}
} catch (error) {
console.error('Request failed', error);
}
// callMethod: Ручное управление постраничной навигацией через параметр start. Используйте для точного контроля над пакетами запросов. Для больших данных менее эффективен, чем fetchListMethod.
try {
const response = await $b24.callMethod('sale.basketitem.list', parameters, 0);
const result = response.getData().result || [];
for (const entity of result) { console.log('Entity:', entity); }
} catch (error) {
console.error('Request failed', 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);
}
},
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>';
Обработка ответа
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 |
Массив объектов с информацией о выбранных элементах (позициях) корзины заказов |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"error"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для чтения |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить элемент (позицию) в корзину существующего заказа sale.basketitem.add
- Изменить позицию корзины существующего заказа sale.basketitem.update
- Получить информацию об элементе (позиции) корзины заказа sale.basketitem.get
- Удалить элемент (позицию) корзины из заказа sale.basketitem.delete
- Получить доступные поля элемента (позиции) корзины sale.basketitem.getFields
- Добавить позицию с товаром или услугой из модуля catalog в корзину существующего заказа sale.basketitem.addCatalogProduct
- Изменить позицию корзины (товар из каталога) существующего заказа sale.basketitem.updateCatalogProduct
- Получить доступные поля элемента корзины (товар из каталога) sale.basketitem.getFieldsCatalogProduct