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

Scope: sale

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

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

Параметры метода

Название
тип

Описание

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
        
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"},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/sale.paymentitembasket.list
        
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        const parameters = {
            select: [
                "id",
                "paymentId",
                "basketId",
                "quantity",
                "xmlId",
                "dateInsert",
            ],
            filter: {
                "paymentId": 1025,
                ">quantity": 2,
            },
            "order": {
                "quantity": "desc",
            }
        };
        
        try {
            const response = await $b24.callListMethod('sale.paymentitembasket.list', parameters);
            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.paymentitembasket.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.paymentitembasket.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.paymentitembasket.list',
                    [
                        'select' => [
                            "id",
                            "paymentId",
                            "basketId",
                            "quantity",
                            "xmlId",
                            "dateInsert",
                        ],
                        'filter' => [
                            "paymentId" => 1025,
                            ">quantity" => 2,
                        ],
                        'order' => [
                            "quantity" => "desc",
                        ]
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching payment items from basket: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'sale.paymentitembasket.list', {
                select: [
                    "id",
                    "paymentId",
                    "basketId",
                    "quantity",
                    "xmlId",
                    "dateInsert",
                ],
                filter: {
                    "paymentId": 1025,
                    ">quantity": 2,
                },
                "order": {
                    "quantity": "desc",
                }
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.info(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'sale.paymentitembasket.list',
            [
                'select' => [
                    "id",
                    "paymentId",
                    "basketId",
                    "quantity",
                    "xmlId",
                    "dateInsert",
                ],
                'filter' => [
                    "paymentId" => 1025,
                    ">quantity" => 2,
                ],
                'order' => [
                    "quantity" => "desc",
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

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"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

200040300010

Недостаточно прав для чтения привязок элементов корзины к оплатам

0

Другие ошибки (например, фатальные ошибки)

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

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

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Получить значения всех полей привязки элемента корзины к оплате
Следующая
Удалить привязку элемента корзины к оплате