метод REST scope: crm

crm.item.payment.product.list

Получить список товарных позиций оплаты

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

Описание

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

Параметры

paymentId sale_order_payment.id обязательный

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

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

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

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

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

  • = — равно, точное совпадение (используется по умолчанию)
  • % — LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки
  • > — больше
  • < — меньше
  • != — не равно
  • !% — NOT LIKE, поиск по подстроке. Символ % в значении фильтра передавать не нужно. Поиск идет с обоих сторон.
  • >= — больше либо равно
  • <= — меньше либо равно
  • @ — IN, в качестве значения передается массив
  • !@ — NOT IN, в качестве значения передается массив
  • =% — 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

Ответ

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

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

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

HTTP-статус: 400

{
   "error":0,
   "error_description":"Payment has not been found"
}
Код Описание Значение
0 Оплата не найдена
0 Доступ запрещен
100 Не переданы обязательные поля
0 Другие ошибки (например, фатальные ошибки)

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

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