Блог Горошко Андрея Bitrix24,PHP Получить товарные позиции объекта CRM crm.item.productrow.list

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

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Получить товарные позиции объекта CRM crm.item.productrow.list». Вы узнаете экспертные методики работы с crm.item.productrow.list и научитесь избегать типичных ошибок начинающих разработчиков.

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

> Scope: 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 (Webhook)
    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
  • cURL (OAuth)
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"filter":{"=ownerType":"D","=ownerId":13142,">price":5000},"order":{"price":"desc"},"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/crm.item.productrow.list
  • JS
    // callListMethod рекомендуется использовать, когда необходимо получить весь набор списочных данных и объём записей относительно невелик (до примерно 1000 элементов). Метод загружает все данные сразу, что может привести к высокой нагрузке на память при работе с большими объемами.
    
    try {
      const response = await $b24.callListMethod(
        'crm.item.productrow.list',
        {
          filter: {
            "=ownerType": 'D',
            "=ownerId": 13142,
            ">price": 5000,
          },
          order: {
            price: "desc"
          },
        },
        (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.productrow.list', {
        filter: {
          "=ownerType": 'D',
          "=ownerId": 13142,
          ">price": 5000,
        },
        order: {
          price: "desc"
        },
      }, '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.productrow.list', {
        filter: {
          "=ownerType": 'D',
          "=ownerId": 13142,
          ">price": 5000,
        },
        order: {
          price: "desc"
        },
      }, 0)
      const result = response.getData().result || []
      for (const entity of result) { console.log('Entity:', entity) }
    } catch (error) {
      console.error('Request failed', error)
    }
  • PHP
    try {
        $response = $b24Service
            ->core
            ->call(
                'crm.item.productrow.list',
                [
                    'filter' => [
                        "=ownerType" => 'D',
                        "=ownerId"   => 13142,
                        ">price"     => 5000,
                    ],
                    'order'  => [
                        'price' => "desc"
                    ],
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error listing product rows: ' . $e->getMessage();
    }
  • BX24.js
    BX24.callMethod(
        'crm.item.productrow.list', {
            filter: {
                "=ownerType": 'D',
                "=ownerId": 13142,
                ">price": 5000,
            },
            order: {
                price: "desc"
            },
        },
        function(result) {
            if (result.error()) {
                console.error(result.error());
            } else {
                console.log(result.data());
            }
        }
    );
  • PHP CRest
    require_once('crest.php');

    $result = CRest::call(
        'crm.item.productrow.list',
        [
            'filter' => [
                "=ownerType" => 'D',
                "=ownerId" => 13142,
                ">price" => 5000,
            ],
            'order' => [
                'price' => "desc"
            ]
        ]
    );

    echo '<PRE>';
    print_r($result);
    echo '</PRE>';

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

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Другие ошибки (например, фатальные ошибки)
  • [](./index)
  • [](./crm-item-productrow-add)
  • [](./crm-item-productrow-fields)
  • [](./crm-item-productrow-get)
  • [](./crm-item-productrow-set)
  • [](./crm-item-productrow-update)
  • [](./crm-item-productrow-get-available-for-payment)
  • [](./crm-item-productrow-delete)

💡 Экспертное мнение и рекомендации

Советы эксперта по интеграции:

  • Всегда используйте кэширование при частых запросах к crm.item.productrow.list, чтобы разгрузить базу данных.
  • Соблюдайте стандарты PSR при написании обработчиков для «Получить товарные позиции объекта CRM crm.item.productrow.list».
  • Регулярно проводите аудит производительности системы с помощью встроенного монитора 1С-Битрикс.

Похожая задача в бизнесе?

Помогу автоматизировать процессы и внедрить ИИ

Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.

Related Post

Как использовать метод SDK crm.duplicate.findbycomm в Битрикс24Как использовать метод SDK crm.duplicate.findbycomm в Битрикс24

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Как использовать метод SDK crm.duplicate.findbycomm в Битрикс24», разберем

Установить диапазон сетевых адресов timeman.networkrange.setУстановить диапазон сетевых адресов timeman.networkrange.set

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Установить диапазон сетевых адресов timeman.networkrange.set», проанализируем лучшие практики

Удалить задачу tasks.task.deleteУдалить задачу tasks.task.delete

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Удалить задачу tasks.task.delete», проанализируем лучшие практики и покажем,