метод REST scope: sale

sale.basketitem.list

Получить список элементов (позиций) корзины

Кто может выполнять: менеджер магазина

Описание

Метод sale.basketitem.list возвращает набор элементов корзины, отобранных по фильтру.

Параметры

select array необязательный

Массив со списком полей, которые необходимо выбрать (смотрите поля объекта sale_basket_item).

Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля торговых каталогов

filter object необязательный

Объект для фильтрации выбранных записей в формате {"field_1": "value_1", ... "field_N": "value_N"}.

Возможные значения для field соответствуют полям объекта sale_basket_item.

Ключу можно задать дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
- >= — больше либо равно
- > — больше
- <= — меньше либо равно
- < — меньше
- @ — IN, в качестве значения передается массив
- !@ — NOT IN, в качестве значения передается массив
- % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
- =% — LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, начинающиеся с «мол»
- "%мол" — ищет значения, заканчивающиеся на «мол»
- "%мол%" — ищет значения, где «мол» может быть в любой позиции
- %= — LIKE (аналогично =%)
- !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обеих сторон
- !=% — NOT LIKE, поиск по подстроке. Символ % нужно передавать в значении. Примеры:
- "мол%" — ищет значения, не начинающиеся с «мол»
- "%мол" — ищет значения, не заканчивающиеся на «мол»
- "%мол%" — ищет значения, где подстроки «мол» нет в любой позиции
- !%= — NOT LIKE (аналогично !=%)
- = — равно, точное совпадение (используется по умолчанию)
- != — не равно
- ! — не равно

order object необязательный

Объект для сортировки выбранных записей в формате {"field_1": "order_1", ... "field_N": "order_N"}.

Возможные значения для field соответствуют полям объекта sale_basket_item.

Возможные значения для order:
- asc — в порядке возрастания
- desc — в порядке убывания

start integer необязательный

Параметр используется для управления постраничной навигацией.

Размер страницы результатов всегда статичный — 50 записей.

Чтобы выбрать вторую страницу результатов, передайте значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.

Формула расчета значения параметра start:

start = (N-1) * 50, где N — номер нужной страницы

Примеры запроса

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

Ответ

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 object

Корневой элемент ответа

basketItems sale_basket_item[]

Массив объектов с информацией о выбранных элементах (позициях) корзины заказов

total integer

Общее количество найденных записей

time time

Информация о времени выполнения запроса

Обработка ошибок

HTTP-статус: 400

{
    "error":0,
    "error_description":"error"
}
Код Описание Значение
200040300010 Недостаточно прав для чтения
0 Другие ошибки (например, фатальные ошибки)

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.