метод REST scope: sale

sale.paymentitembasket.list

Получить список привязок элементов корзины к оплатам

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

Описание

Метод sale.paymentitembasket.list получает список привязок элементов корзины к оплатам.

Параметры

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

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

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

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

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

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

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

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

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

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

Возможные значения для 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","paymentId","basketId","quantity","xmlId","dateInsert"],"filter":{"paymentId":1025,">quantity":2},"order":{"quantity":"desc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/sale.paymentitembasket.list

Ответ

HTTP-статус: 200

{
    "result":{
        "paymentItemsBasket":[
            {
                "basketId":2722,
                "dateInsert":"2024-04-17T10:51:03+03:00",
                "id":1186,
                "paymentId":1025,
                "quantity":3,
                "xmlId":"myXmlId"
            }
        ]
    },
    "total":1,
    "time":{
        "start":1713344692.788531,
        "finish":1713344693.055679,
        "duration":0.2671480178833008,
        "processing":0.017076969146728516,
        "date_start":"2024-04-17T12:04:52+03:00",
        "date_finish":"2024-04-17T12:04:53+03:00"
    }
}

Возвращаемые данные

result object

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

paymentItemBasket sale_payment_item_basket[]

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

total integer

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

time time

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

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

HTTP-статус: 400

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

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

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