Оптимизация производительности и безопасности — залог успешного проекта на 1С-Битрикс. Данный материал посвящен практическому применению «Получить список товаров по фильтру catalog.product.list». Мы подготовили подробный разбор принципов работы и развернутые примеры интеграции.

Получить список товаров по фильтру catalog.product.list

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

Метод получает список товаров торгового каталога по фильтру.

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

Название `тип`	Описание
select `array`	Массив содержащий список полей, которые необходимо выбрать (смотрите поля объекта catalog_product). Обязательные поля: `id`, `iblockId`
filter `object`	Объект для фильтрации выбранных товаров в формате `{"field_1": "value_1", ... "field_N": "value_N"}`. Возможные значения для `field` соответствуют полям объекта catalog_product. Обязательные поля:`iblockId`. Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса: — `>=` — больше либо равно — `>` — больше — `<=` — меньше либо равно — `<` — меньше — `%` — LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки. — `=%` — LIKE, поиск по подстроке. Символ `%` нужно передавать в значении. Примеры: — `"мол%"` — ищем значения начинающиеся с «мол» — `"%мол"` — ищем значения заканчивающиеся на «мол» — `"%мол%"` — ищем значения, где «мол» может быть в любой позиции — `%=` — LIKE (аналогично `=%`) — `!%` — NOT LIKE, поиск по подстроке. Символ `%` в значении фильтра передавать не нужно. Поиск идет с обоих сторон. — `!=%` — NOT LIKE, поиск по подстроке. Символ `%` нужно передавать в значении. Примеры: — `"мол%"` — ищем значения не начинающиеся с «мол» — `"%мол"` — ищем значения не заканчивающиеся на «мол» — `"%мол%"` — ищем значения, где подстроки «мол» нет в любой позиции — `!%=` — NOT LIKE (аналогично `!=%`) — `=` — равно, точное совпадение (используется по умолчанию). Для поиска IN можно передавать несколько значений массивом — `!=` — не равно — `!` — не равно. Для поиска NOT IN можно передавать несколько значений массивом
order `object`	Объект для сортировки выбранных товаров в формате `{"field_1": "order_1", ... "field_N": "order_N"}`. Возможные значения для `field` соответствуют полям объекта catalog_product. Возможные значения для order: — `asc` — в порядке возрастания — `desc` — в порядке убывания
start `string`	Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный — 50 записей. Чтобы выбрать вторую страницу результатов необходимо передавать значение — `50`. Чтобы выбрать третью страницу результатов значение — `100` и так далее. Формула расчета значения параметра `start`: `start = (N-1) * 50`, где `N` — номер нужной страницы

Чтобы получить цены товаров, используйте методы catalog.price.*.

Примеры кода

cURL (Webhook)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"select":["id","iblockId","name","active","available","barcodeMulti","bundle","canBuyZero","code","createdBy","dateActiveFrom","dateActiveTo","dateCreate","detailPicture","detailText","detailTextType","height","iblockSectionId","length","measure","modifiedBy","previewPicture","previewText","previewTextType","purchasingCurrency","purchasingPrice","quantity","quantityReserved","quantityTrace","recurSchemeLength","recurSchemeType","sort","subscribe","timestampX","trialPriceId","type","vatId","vatIncluded","weight","width","withoutOrder","xmlId","property258","property259"],"filter":{"iblockId":23,">id":10,"vatId":[1,2]},"order":{"id":"desc"}}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/catalog.product.list

cURL (OAuth)

    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"select":["id","iblockId","name","active","available","barcodeMulti","bundle","canBuyZero","code","createdBy","dateActiveFrom","dateActiveTo","dateCreate","detailPicture","detailText","detailTextType","height","iblockSectionId","length","measure","modifiedBy","previewPicture","previewText","previewTextType","purchasingCurrency","purchasingPrice","quantity","quantityReserved","quantityTrace","recurSchemeLength","recurSchemeType","sort","subscribe","timestampX","trialPriceId","type","vatId","vatIncluded","weight","width","withoutOrder","xmlId","property258","property259"],"filter":{"iblockId":23,">id":10,"vatId":[1,2]},"order":{"id":"desc"},"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/catalog.product.list

    // callListMethod рекомендуется использовать, когда необходимо получить весь набор списочных данных и объём записей относительно невелик (до примерно 1000 элементов). Метод загружает все данные сразу, что может привести к высокой нагрузке на память при работе с большими объемами.
    
    try {
      const response = await $b24.callListMethod(
        'catalog.product.list',
        {
          "select": [
            "id",
            "iblockId",
            "name",
            "active",
            "available",
            "barcodeMulti",
            "bundle",
            "canBuyZero",
            "code",
            "createdBy",
            "dateActiveFrom",
            "dateActiveTo",
            "dateCreate",
            "detailPicture",
            "detailText",
            "detailTextType",
            "height",
            "iblockSectionId",
            "length",
            "measure",
            "modifiedBy",
            "previewPicture",
            "previewText",
            "previewTextType",
            "purchasingCurrency",
            "purchasingPrice",
            "quantity",
            "quantityReserved",
            "quantityTrace",
            "recurSchemeLength",
            "recurSchemeType",
            "sort",
            "subscribe",
            "timestampX",
            "trialPriceId",
            "type",
            "vatId",
            "vatIncluded",
            "weight",
            "width",
            "withoutOrder",
            "xmlId",
            "property258",
            "property259",
          ],
          "filter": {
            "iblockId": 23,
            ">id": 10,
            "vatId": [1, 2],
          },
          "order": {
            "id": "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('catalog.product.list', {
        "select": [
          "id",
          "iblockId",
          "name",
          "active",
          "available",
          "barcodeMulti",
          "bundle",
          "canBuyZero",
          "code",
          "createdBy",
          "dateActiveFrom",
          "dateActiveTo",
          "dateCreate",
          "detailPicture",
          "detailText",
          "detailTextType",
          "height",
          "iblockSectionId",
          "length",
          "measure",
          "modifiedBy",
          "previewPicture",
          "previewText",
          "previewTextType",
          "purchasingCurrency",
          "purchasingPrice",
          "quantity",
          "quantityReserved",
          "quantityTrace",
          "recurSchemeLength",
          "recurSchemeType",
          "sort",
          "subscribe",
          "timestampX",
          "trialPriceId",
          "type",
          "vatId",
          "vatIncluded",
          "weight",
          "width",
          "withoutOrder",
          "xmlId",
          "property258",
          "property259",
        ],
        "filter": {
          "iblockId": 23,
          ">id": 10,
          "vatId": [1, 2],
        },
        "order": {
          "id": "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('catalog.product.list', {
        "select": [
          "id",
          "iblockId",
          "name",
          "active",
          "available",
          "barcodeMulti",
          "bundle",
          "canBuyZero",
          "code",
          "createdBy",
          "dateActiveFrom",
          "dateActiveTo",
          "dateCreate",
          "detailPicture",
          "detailText",
          "detailTextType",
          "height",
          "iblockSectionId",
          "length",
          "measure",
          "modifiedBy",
          "previewPicture",
          "previewText",
          "previewTextType",
          "purchasingCurrency",
          "purchasingPrice",
          "quantity",
          "quantityReserved",
          "quantityTrace",
          "recurSchemeLength",
          "recurSchemeType",
          "sort",
          "subscribe",
          "timestampX",
          "trialPriceId",
          "type",
          "vatId",
          "vatIncluded",
          "weight",
          "width",
          "withoutOrder",
          "xmlId",
          "property258",
          "property259",
        ],
        "filter": {
          "iblockId": 23,
          ">id": 10,
          "vatId": [1, 2],
        },
        "order": {
          "id": "desc",
        }
      }, 0);
      const result = response.getData().result || [];
      for (const entity of result) { console.log('Entity:', entity); }
    } catch (error) {
      console.error('Request failed', error);
    }

    try {
        $select = ['id', 'name', 'price', 'active', 'available', 'dateCreate'];
        $filter = ['active' => 'Y'];
        $order = ['name' => 'ASC'];
        $start = 0;
        $result = $serviceBuilder
            ->getCatalogScope()
            ->product()
            ->list($select, $filter, $order, $start);
        foreach ($result->getProducts() as $itemResult) {
            print("ID: {$itemResult->id}\n");
            print("Name: {$itemResult->name}\n");
            print("Active: {$itemResult->active}\n");
            print("Available: {$itemResult->available}\n");
            print("Date Created: {$itemResult->dateCreate->format(DATE_ATOM)}\n");
        }
    } catch (Throwable $e) {
        print("Error: {$e->getMessage()}\n");
    }

BX24.js

    BX24.callMethod(
        "catalog.product.list",
        {
            "select": [
                "id",
                "iblockId",
                "name",
                "active",
                "available",
                "barcodeMulti",
                "bundle",
                "canBuyZero",
                "code",
                "createdBy",
                "dateActiveFrom",
                "dateActiveTo",
                "dateCreate",
                "detailPicture",
                "detailText",
                "detailTextType",
                "height",
                "iblockSectionId",
                "length",
                "measure",
                "modifiedBy",
                "previewPicture",
                "previewText",
                "previewTextType",
                "purchasingCurrency",
                "purchasingPrice",
                "quantity",
                "quantityReserved",
                "quantityTrace",
                "recurSchemeLength",
                "recurSchemeType",
                "sort",
                "subscribe",
                "timestampX",
                "trialPriceId",
                "type",
                "vatId",
                "vatIncluded",
                "weight",
                "width",
                "withoutOrder",
                "xmlId",
                "property258",
                "property259",
            ],
            "filter": {
                "iblockId": 23,
                ">id": 10,
                "vatId": [1, 2],
            },
            "order": {
                "id": "desc",
            }
        },
        function(result) {
            if (result.error()) {
                console.error(result.error());
            } else {
                console.info(result.data());
            }
        }
    );

PHP CRest

    require_once('crest.php');

    $result = CRest::call(
        'catalog.product.list',
        [
            'select' => [
                "id",
                "iblockId",
                "name",
                "active",
                "available",
                "barcodeMulti",
                "bundle",
                "canBuyZero",
                "code",
                "createdBy",
                "dateActiveFrom",
                "dateActiveTo",
                "dateCreate",
                "detailPicture",
                "detailText",
                "detailTextType",
                "height",
                "iblockSectionId",
                "length",
                "measure",
                "modifiedBy",
                "previewPicture",
                "previewText",
                "previewTextType",
                "purchasingCurrency",
                "purchasingPrice",
                "quantity",
                "quantityReserved",
                "quantityTrace",
                "recurSchemeLength",
                "recurSchemeType",
                "sort",
                "subscribe",
                "timestampX",
                "trialPriceId",
                "type",
                "vatId",
                "vatIncluded",
                "weight",
                "width",
                "withoutOrder",
                "xmlId",
                "property258",
                "property259",
            ],
            'filter' => [
                "iblockId" => 23,
                ">id" => 10,
                "vatId" => [1, 2],
            ],
            'order' => [
                "id" => "desc",
            ]
        ]
    );

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

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

HTTP-статус: 200

{
    "result": {
        "products": [
            {
                "active": "Y",
                "available": "Y",
                "barcodeMulti": "Y",
                "bundle": "N",
                "canBuyZero": "Y",
                "code": "Tovar",
                "createdBy": 1,
                "dateActiveFrom": "2024-05-28T10:00:00+03:00",
                "dateActiveTo": "2024-05-29T10:00:00+03:00",
                "dateCreate": "2024-05-27T10:00:00+03:00",
                "detailPicture": {
                    "id": "6439",
                    "url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6439\u0026fields%5BproductId%5D=1243",
                    "urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=detailPicture\u0026fields%5BfileId%5D=6439\u0026fields%5BproductId%5D=1243"
                },
                "detailText": null,
                "detailTextType": "text",
                "height": 100,
                "iblockId": 23,
                "iblockSectionId": 47,
                "id": 1243,
                "length": 100,
                "measure": 5,
                "modifiedBy": 1,
                "name": "Товар",
                "previewPicture": {
                    "id": "6438",
                    "url": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6438\u0026fields%5BproductId%5D=1243",
                    "urlMachine": "\/rest\/catalog.product.download?fields%5BfieldName%5D=previewPicture\u0026fields%5BfileId%5D=6438\u0026fields%5BproductId%5D=1243"
                },
                "previewText": null,
                "previewTextType": "text",
                "property258": {
                    "value": "test",
                    "valueId": "9735"
                },
                "property259": [
                    {
                        "value": "test1",
                        "valueId": "9736"
                    },
                    {
                        "value": "test2",
                        "valueId": "9737"
                    }
                ],
                "purchasingCurrency": "RUB",
                "purchasingPrice": 1000,
                "quantity": 10,
                "quantityReserved": 1,
                "quantityTrace": "Y",
                "recurSchemeLength": 1,
                "recurSchemeType": "D",
                "sort": 100,
                "subscribe": "Y",
                "timestampX": "2024-06-05T10:05:06+03:00",
                "trialPriceId": 175,
                "type": 1,
                "vatId": 1,
                "vatIncluded": "Y",
                "weight": 100,
                "width": 100,
                "withoutOrder": "Y",
                "xmlId": "1243"
            }
        ]
    },
    "total": 1,
    "time": {
        "start": 1717661048.302644,
        "finish": 1717661049.079089,
        "duration": 0.7764449119567871,
        "processing": 0.3525362014770508,
        "date_start": "2024-06-06T11:04:08+03:00",
        "date_finish": "2024-06-06T11:04:09+03:00"
    }
}

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

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

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

HTTP-статус: 400

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

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

Код	Описание
`200040300010`	Недостаточно прав для чтения торгового каталога
`0`	Не указаны поля `id`, `iblockId` в полях выбора
`0`	Не указано поле `iblockId` в фильтре
`0`	Другие ошибки (например, фатальные ошибки)

[](./catalog-product-add)
[](./catalog-product-update)
[](./catalog-product-get)
[](./catalog-product-download)
[](./catalog-product-delete)
[](./catalog-product-get-fields-by-filter)

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

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

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

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

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

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

Написать во ВКонтакте

или на почту: gorandvas@yandex.ru

Получить список товаров по фильтру catalog.product.list

Получить список товаров по фильтру catalog.product.list

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

Примеры кода

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

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

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

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

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

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

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

Related Post

Получить список дел crm.activity.listПолучить список дел crm.activity.list

Сколько стоит подключение онлайн-оплаты и кассы 54-ФЗ к сайту на БитриксСколько стоит подключение онлайн-оплаты и кассы 54-ФЗ к сайту на Битрикс

Вернуть параметры действию или роботу bizproc.event.sendВернуть параметры действию или роботу bizproc.event.send