Получить список товарных позиций оплаты crm.item.payment.product.list

Scope: crm

Кто может выполнять метод: требуется право на чтение заказа оплаты

Метод получает список товарных позиций (товары или услуги) по конкретной оплате.

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

Обязательные параметры отмечены *

Название
тип

Описание

paymentId*
sale_order_payment.id

Идентификатор оплаты.
Можно получить с помощью метода sale.payment.list

filter*
object

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

Возможные значения для field:

  • id
  • quantity

Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:

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

order
object

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

Возможные значения для field:

  • id
  • quantity

Возможные значения для order:

  • asc — в порядке возрастания
  • desc — в порядке убывания

Примеры кода

Как использовать примеры в документации

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"paymentId":1039,"filter":{"\u003E=quantity":2,"@id":[1195,1196]}}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.payment.product.list
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"paymentId":1039,"filter":{"\u003E=quantity":2,"@id":[1195,1196]},"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.item.payment.product.list
        
// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        try {
          const response = await $b24.callListMethod(
            'crm.item.payment.product.list',
            {
              paymentId: 1039,
              filter: {
                ">=quantity": 2,
                "@id": [1195, 1196],
              },
            },
            (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('crm.item.payment.product.list', {
            paymentId: 1039,
            filter: {
              ">=quantity": 2,
              "@id": [1195, 1196],
            },
          }, '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('crm.item.payment.product.list', {
            paymentId: 1039,
            filter: {
              ">=quantity": 2,
              "@id": [1195, 1196],
            },
          }, 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(
                    'crm.item.payment.product.list',
                    [
                        'paymentId' => 1039,
                        'filter'    => [
                            '>=quantity' => 2,
                            '@id'        => [1195, 1196],
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching payment product list: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.item.payment.product.list', {
                paymentId: 1039,
                filter: {
                    ">=quantity": 2,
                    "@id": [1195, 1196],
                },
            },
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.log(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.item.payment.product.list',
            [
                'paymentId' => 1039,
                'filter' => [
                    ">=quantity" => 2,
                    "@id" => [1195, 1196],
                ]
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Ответ в случае успеха

HTTP-статус: 200

{
           "result":[
              {
                 "id":1195,
                 "paymentId":1039,
                 "quantity":2,
                 "rowId":17587
              },
              {
                 "id":1196,
                 "paymentId":1039,
                 "quantity":3,
                 "rowId":17588
              }
           ],
           "time":{
              "start":1716286140.489916,
              "finish":1716286140.802505,
              "duration":0.3125889301300049,
              "processing":0.053195953369140625,
              "date_start":"2024-05-21T13:09:00+03:00",
              "date_finish":"2024-05-21T13:09:00+03:00"
           }
        }

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

Название
тип

Описание

result
crm_item_payment_product[]

Массив объектов, содержащий информацию о выбранных товарных позициях оплаты

time
time

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

Ключ result. Объект типа crm_item_payment_product

Название
тип

Описание

id
integer

Идентификатор товарной позиции в оплате

paymentId
sale_order_payment.id

Идентификатор оплаты

quantity
double

Количество товара

rowId
integer

Идентификатор товарной позиции в сущности CRM

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

HTTP-статус: 400

{
           "error":0,
           "error_description":"Payment has not been found"
        }

Название
тип

Описание

error
string

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

error_description
error_description

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

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

Код

Описание

0

Оплатая не найдена

0

Доступ запрещен

100

Не переданы обязательные поля

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

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

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

Предыдущая
Добавить товарную позицию
Следующая
Удалить товарную позицию