метод REST scope: crm

crm.item.productrow.list

Получить товарные позиции объекта CRM

Кто может выполнять: требуется право на чтение объекта CRM, товарные позиции которого выбираются

Описание

Метод получает товарные позиции объекта CRM.

Параметры

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

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

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

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

=ownerType
=ownerId

В =ownerType передавайте Краткий символьный код типа.

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

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

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

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

Возможные значения для 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 '{"filter":{"=ownerType":"D","=ownerId":13142,">price":5000},"order":{"price":"desc"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.item.productrow.list

Ответ

HTTP-статус: 200

{
   "result":{
      "productRows":[
         {
            "id":17649,
            "ownerId":13142,
            "ownerType":"D",
            "productId":9621,
            "productName":"iphone 14",
            "price":90000,
            "priceAccount":90000,
            "priceExclusive":81818.18,
            "priceNetto":90909.09,
            "priceBrutto":100000,
            "quantity":3,
            "discountTypeId":2,
            "discountRate":10,
            "discountSum":9090.91,
            "taxRate":10,
            "taxIncluded":"Y",
            "customized":"Y",
            "measureCode":796,
            "measureName":"шт",
            "sort":20,
            "xmlId":"sale_basket_8147",
            "type":4,
            "storeId": 19
         },
         {
            "id":17650,
            "ownerId":13142,
            "ownerType":"D",
            "productId":9623,
            "productName":"iphone 10xs",
            "price":5550,
            "priceAccount":5550,
            "priceExclusive":5550,
            "priceNetto":5550,
            "priceBrutto":5550,
            "quantity":1,
            "discountTypeId":2,
            "discountRate":0,
            "discountSum":0,
            "taxRate":null,
            "taxIncluded":"Y",
            "customized":"Y",
            "measureCode":6,
            "measureName":"м",
            "sort":10,
            "xmlId":"sale_basket_8148",
            "type":4,
            "storeId": 17
         }
      ]
   },
   "total":2,
   "time":{
      "start":1716905609.186602,
      "finish":1716905609.434087,
      "duration":0.24748492240905762,
      "processing":0.06894516944885254,
      "date_start":"2024-05-28T17:13:29+03:00",
      "date_finish":"2024-05-28T17:13:29+03:00"
   }
}

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

result object

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

productRows crm_item_product_row[]

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

total integer

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

time time

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

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

HTTP-статус: 400

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

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

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