Блог Горошко Андрея 1C-Битрикс,Bitrix24 Получить список правил округления цен по фильтру catalog.roundingRule.list

Получить список правил округления цен по фильтру catalog.roundingRule.list

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Получить список правил округления цен по фильтру catalog.roundingRule.list», проанализируем лучшие практики и покажем, как правильно использовать catalog.roundingRule.list в реальных задачах.

Получить список правил округления цен по фильтру catalog.roundingRule.list

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

Метод возвращает список правил округления цен.

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

Название
тип
Описание
select
array
Массив со списком полей, которые необходимо выбрать (смотрите поля объекта catalog_rounding_rule).

Если массив не передан или же передан пустой массив, то будут выбраны все доступные поля правила округления цен

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

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

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

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

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

Возможные значения для 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 '{"select":["id","price","roundType"],"filter":{"modifiedBy":1},"order":{"id":"ASC"}}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/catalog.roundingrule.list
  • cURL (OAuth)
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"select":["id","price","roundType"],"filter":{"modifiedBy":1},"order":{"id":"ASC"},"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/catalog.roundingrule.list
  • JS
    // callListMethod рекомендуется использовать, когда необходимо получить весь набор списочных данных и объём записей относительно невелик (до примерно 1000 элементов). Метод загружает все данные сразу, что может привести к высокой нагрузке на память при работе с большими объемами.
    
    try {
      const response = await $b24.callListMethod(
        'catalog.roundingrule.list',
        {
          select: ['id', 'price', 'roundType'],
          filter: { 'modifiedBy': 1 },
          order: { 'id': 'ASC' }
        },
        (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('catalog.roundingrule.list', {
        select: ['id', 'price', 'roundType'],
        filter: { 'modifiedBy': 1 },
        order: { 'id': 'ASC' }
      }, '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('catalog.roundingrule.list', {
        select: ['id', 'price', 'roundType'],
        filter: { 'modifiedBy': 1 },
        order: { 'id': 'ASC' }
      }, 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(
                'catalog.roundingrule.list',
                [
                    'select' => [
                        'id',
                        'price',
                        'roundType'
                    ],
                    'filter' => [
                        'modifiedBy' => 1
                    ],
                    'order' => [
                        'id' => 'ASC'
                    ]
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        echo 'Success: ' . print_r($result, true);
        // Нужная вам логика обработки данных
        processData($result);
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error listing rounding rules: ' . $e->getMessage();
    }
  • BX24.js
    BX24.callMethod(
        'catalog.roundingrule.list',
        {
            select:[
                'id',
                'price',
                'roundType'
            ],
            filter:{
                'modifiedBy': 1
            },
            order:{
                'id': 'ASC'
            }
        },
        function(result)
        {
            if(result.error())
                console.error(result.error());
            else
                console.log(result.data());
            result.next();
        }
    );
  • PHP CRest
    require_once('crest.php');

    $result = CRest::call(
        'catalog.roundingrule.list',
        [
            'select' => [
                'id',
                'price',
                'roundType'
            ],
            'filter' => [
                'modifiedBy' => 1
            ],
            'order' => [
                'id' => 'ASC'
            ]
        ]
    );

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

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

HTTP-статус: 200

{
    "roundingRules": [
        {
            "id": 1,
            "price": 1500,
            "roundType": 2
        },
        {
            "id": 2,
            "price": 1000,
            "roundType": 4
        },
        {
            "id": 4,
            "price": 50,
            "roundType": 1
        }
    ],
    "total": 3,
    "time": {
        "start": 1712326352.63409,
        "finish": 1712326352.8319,
        "duration": 0.197818040847778,
        "processing": 0.00833678245544434,
        "date_start": "2024-04-05T16:24:46+02:00",
        "date_finish": "2024-04-05T16:24:46+02:00",
        "operating": 0
    }
}

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

Название
тип
Описание
result
object
Корневой элемент ответа
roundingRules
catalog_rounding_rule[]
Массив объектов с информацией о выбранных правилах округления цен
total
integer
Общее количество найденных записей
time
time
Информация о времени выполнения запроса

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

HTTP-статус: 400

{
    "error": 200040300010,
    "error_description": "Access Denied"
}

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

КодОписание
200040300010Недостаточно прав для чтения
0Другие ошибки (например, фатальные ошибки)
  • [](./catalog-rounding-rule-add)
  • [](./catalog-rounding-rule-update)
  • [](./catalog-rounding-rule-get)
  • [](./catalog-rounding-rule-delete)
  • [](./catalog-rounding-rule-get-fields)

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

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

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

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

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

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

Related Post

Добавить сообщение im.message.addДобавить сообщение im.message.add

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Добавить сообщение im.message.add». Вы узнаете экспертные методики работы с im.message.add и научитесь избегать

Разработка интернет-магазина противопожарного оборудования и средств защиты (МЧС) на 1С-БитриксРазработка интернет-магазина противопожарного оборудования и средств защиты (МЧС) на 1С-Битрикс

Создание современного интернет-магазина по направлению «противопожарного оборудования и средств защиты (МЧС)» на платформе 1С-Битрикс позволяет автоматизировать продажи, обеспечить высокую конверсию и бесшовную интеграцию с учетными системами. В этой нише решающее

Получить пользовательские поля предложений по идентификатору crm.quote.userfi…Получить пользовательские поля предложений по идентификатору crm.quote.userfi…

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Получить пользовательские поля предложений по идентификатору crm.quote.userfi…», разберем