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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

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 можно передавать несколько значений массивом

Для пользовательских полей propertyN формат значения в filter зависит от типа условия:

  • если фильтруете свойство типа дата или дата-время по диапазону, используйте префикс в ключе, а значение передавайте в поле value
  • если фильтруете числовое, строковое или списочное пользовательское поле по точному совпадению, передавайте значение напрямую, без value
  • для поиска IN и NOT IN можно передавать массив значений

Примеры фильтрации по пользовательским полям:

filter: {
            iblockId: 23,
            '>=property424': {
                value: '2025-05-29T12:00:00+03:00' 
            },
            '<=property424': {
                value: '2025-05-30T13:00:00+03:00'
            },
            property996: 9636,
            property997: [9636, 568, 570, 9658],
        }
        

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 -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_webhook_here**/catalog.product.list
        
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
        
// This snippet is an ES module: top-level await requires type="module" or a bundler.
        // $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
        import { Text } from '@bitrix24/b24jssdk'
        import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
        
        declare const $b24: B24Frame
        
        type CatalogProductFile = {
          id: string,
          url: string,
          urlMachine: string,
        }
        
        type CatalogProductProperty = {
          value: string,
          valueId: string,
        }
        
        type CatalogProduct = {
          id: number,
          iblockId: number,
          name: string,
          active: string,
          available: string,
          barcodeMulti: string,
          bundle: string,
          canBuyZero: string,
          code: string,
          createdBy: number,
          dateActiveFrom: ISODate | null,
          dateActiveTo: ISODate | null,
          dateCreate: ISODate | null,
          detailPicture: CatalogProductFile | null,
          detailText: string | null,
          detailTextType: string,
          height: number,
          iblockSectionId: number | null,
          length: number,
          measure: number | null,
          modifiedBy: number,
          previewPicture: CatalogProductFile | null,
          previewText: string | null,
          previewTextType: string,
          property258: CatalogProductProperty | null,
          property259: CatalogProductProperty[] | null,
          purchasingCurrency: string | null,
          purchasingPrice: number | null,
          quantity: number,
          quantityReserved: number,
          quantityTrace: string,
          recurSchemeLength: number | null,
          recurSchemeType: string | null,
          sort: number,
          subscribe: string | null,
          timestampX: ISODate | null,
          trialPriceId: number | null,
          type: number,
          vatId: number | null,
          vatIncluded: string | null,
          weight: number,
          width: number,
          withoutOrder: string | null,
          xmlId: string | null,
        }
        
        // Shape of the payload returned in result (match the "response handling" section of the page)
        type CatalogProductListResult = {
          products: CatalogProduct[],
        }
        
        try {
          // catalog.product.list returns a single page (max 50 records). For the whole result set
          // use a list helper: $b24.actions.v2.callList.make() returns every record as one
          // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
          // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
          // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
          const response = await $b24.actions.v2.call.make<CatalogProductListResult>({
            method: 'catalog.product.list',
            params: {
              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',
              },
              start: 0,
            },
            requestId: Text.getUuidRfc4122()
          })
        
          // The payload is available only on a successful response
          if (!response.isSuccess) {
            console.error(response.getErrorMessages().join('; '))
          } else {
            const result = response.getData()!.result
            console.info('Products fetched:', result.products.length, result.products)
          }
        } catch (error) {
          // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
          console.error(error)
        }
        
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
        <script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
        <script>
          async function fetchProductList() {
            try {
              // Initialize the SDK inside a Bitrix24 frame
              const $b24 = await B24Js.initializeB24Frame()
        
              // catalog.product.list returns a single page (max 50 records). For the whole result set
              // use a list helper: $b24.actions.v2.callList.make() returns every record as one
              // array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
              // NOTE: the list helpers do not accept `order` (it is excluded from their params, so
              // passing it is a TS error) — keep this call.make + `start` variant when sort matters.
              const response = await $b24.actions.v2.call.make({
                method: 'catalog.product.list',
                params: {
                  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',
                  },
                  start: 0,
                },
                requestId: B24Js.Text.getUuidRfc4122()
              })
        
              // The payload is available only on a successful response
              if (!response.isSuccess) {
                console.error(response.getErrorMessages().join('; '))
                return
              }
        
              const result = response.getData().result
              console.info('Products fetched:', result.products.length, result.products)
            } catch (error) {
              // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
              console.error(error)
            }
          }
        
          document.addEventListener('DOMContentLoaded', fetchProductList)
        </script>
        
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.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());
                }
            }
        );
        
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"
        }
        

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

200040300010

Недостаточно прав для чтения торгового каталога

0

Не указаны поля id, iblockId в полях выбора

0

Не указано поле iblockId в фильтре

0

Другие ошибки (например, фатальные ошибки)

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение