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

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

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

Scope: catalog

Кто может выполнять метод: пользователь с правом «Просмотр каталога товаров», «Просмотр товаров каталога» или «Изменение цены продажи товара»

Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.

Метод catalog.product.list возвращает список товаров торгового каталога по фильтру.

Метод возвращает товары любого типа: простые товары, товары с вариациями, вариации, услуги. Чтобы получить товары одного типа, добавьте в фильтр условие по полю type.

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

Обязательные параметры отмечены *

Название
тип

Описание

filter*
array

Фильтр списка в формате REST 3.0: массив условий вида ["поле", "оператор", "значение"]. Синтаксис фильтра описан в обзоре REST 3.0.

Условие ["iblockId", "=", <идентификатор>] обязательно. Идентификатор инфоблока можно получить методом catalog.catalog.list.

Фильтровать можно по полям id, iblockId, name, code, xmlId, active, sort, createdBy, modifiedBy, dateCreate, timestampX, dateActiveFrom, dateActiveTo, iblockSectionId, type, available, bundle, quantity, quantityReserved, quantityTrace, canBuyZero, subscribe, vatId, vatIncluded, purchasingPrice, purchasingCurrency, barcodeMulti, weight, length, width, height, measure. Фильтр по значениям свойств не поддерживается.

Группы с логикой or и отрицание не поддерживаются. Условие in с пустым списком возвращает пустой список

select
array

Массив полей товара, которые нужно вернуть в ответе.

Доступные поля:

  • id — идентификатор товара
  • iblockId — идентификатор инфоблока
  • name — название
  • code — символьный код
  • xmlId — внешний код
  • active — активность
  • sort — сортировка
  • createdBy — кто создал
  • modifiedBy — кто изменил
  • dateCreate — дата создания
  • timestampX — дата изменения
  • dateActiveFrom — начало активности
  • dateActiveTo — окончание активности
  • previewText — описание для анонса
  • previewTextType — тип описания для анонса
  • previewPicture — картинка для анонса
  • detailText — детальное описание
  • detailTextType — тип детального описания
  • detailPicture — детальная картинка
  • iblockSectionId — основной раздел
  • iblockSection — все разделы
  • type — тип товара
  • available — доступность для покупки
  • bundle — признак комплекта
  • quantity — количество
  • quantityReserved — зарезервированное количество
  • quantityTrace — количественный учет
  • canBuyZero — покупка при отсутствии
  • subscribe — подписка на товар
  • vatId — ставка НДС
  • vatIncluded — НДС включен в цену
  • purchasingPrice — закупочная цена
  • purchasingCurrency — валюта закупочной цены
  • barcodeMulti — штрихкод для каждого экземпляра
  • weight — вес
  • length — длина
  • width — ширина
  • height — высота
  • measure — единица измерения
  • recurSchemeLength — длина периода оплаты
  • recurSchemeType — единица периода оплаты
  • trialPriceId — товар для пробной оплаты
  • withoutOrder — продление без заказа
  • quantityTraceRaw — сохраненный режим учета
  • paymentType — тип оплаты
  • subscribeRaw — сохраненное разрешение подписки
  • canBuyZeroRaw — сохраненное разрешение покупки при отсутствии
  • properties — значения всех свойств товара

Поле id возвращается, только если указано в select. Значения отдельных свойств выбрать нельзя: properties возвращает все свойства товара. Значение ["*"] не поддерживается.

По умолчанию: все поля

order
object

Сортировка в формате {"поле": "направление"}, например {"id": "desc"}.

Возможные значения направления:

  • asc — по возрастанию
  • desc — по убыванию

Сортировать можно по полям id, iblockId, name, code, xmlId, active, sort, dateCreate, timestampX, dateActiveFrom, dateActiveTo, type, quantity.

По умолчанию: {"id": "asc"}

pagination
object

Постраничная навигация. Описание параметра

Параметр pagination

Название
тип

Описание

limit
integer

Количество товаров на странице. Значения больше 50 уменьшаются до 50, значение 0 вызывает ошибку.

По умолчанию: 50

page
integer

Номер страницы, начиная с 1

offset
integer

Количество товаров, которые нужно пропустить. Значение должно быть кратно limit, иначе метод вернет ошибку

Примеры кода

Как использовать примеры в документации

Вызов нового API отличается добавлением параметра /api/ в запросе:

https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/catalog.product.list

curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"filter":[["iblockId","=",25],["iblockSectionId","=",41]],"select":["id","name","active","type"],"order":{"id":"desc"},"pagination":{"limit":2}}' \
https://**put_your_bitrix24_address**/rest/api/**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 '{"filter":[["iblockId","=",25],["iblockSectionId","=",41]],"select":["id","name","active","type"],"order":{"id":"desc"},"pagination":{"limit":2},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.product.list
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

type ProductListResult = {
  items: Array<{
    id: number
    name: string
    active: 'Y' | 'N'
    type: number
  }>
}

try {
  const response = await $b24.actions.v3.call.make<ProductListResult>({
    method: 'catalog.product.list',
    params: {
      filter: [
        ['iblockId', '=', 25],
        ['iblockSectionId', '=', 41],
      ],
      select: ['id', 'name', 'active', 'type'],
      order: {
        id: 'desc',
      },
      pagination: {
        limit: 2,
      },
    },
    requestId: Text.getUuidRfc4122()
  })

  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const result = response.getData()!.result
    console.info('Products:', result.items.length)
  }
} catch (error) {
  // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
  console.error(error)
}
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
  async function productList() {
    try {
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v3.call.make({
        method: 'catalog.product.list',
        params: {
          filter: [
            ['iblockId', '=', 25],
            ['iblockSectionId', '=', 41],
          ],
          select: ['id', 'name', 'active', 'type'],
          order: {
            id: 'desc',
          },
          pagination: {
            limit: 2,
          },
        },
        requestId: B24Js.Text.getUuidRfc4122()
      })

      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const result = response.getData().result
      console.info('Products:', result.items.length)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', productList)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.catalog.product.list(
        filter=[
            ["iblockId", "=", 25],
            ["iblockSectionId", "=", 41],
        ],
        select=["id", "name", "active", "type"],
        order={
            "id": "desc",
        },
        pagination={
            "limit": 2,
        },
    ).response
    result = bitrix_response.result
    print(result)
except BitrixAPIError as error:
    print(
        "Ошибка Bitrix API",
        f"error: {error.error}",
        f"error_description: {error.error_description}",
        sep="\n",
    )
except BitrixSDKException as error:
    print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
    print(f"Непредвиденная ошибка: {error}")

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

try {
    $response = $b24Service
        ->core
        ->call(
            'catalog.product.list',
            [
                'filter' => [
                    ['iblockId', '=', 25],
                    ['iblockSectionId', '=', 41],
                ],
                'select' => ['id', 'name', 'active', 'type'],
                'order' => [
                    'id' => 'desc',
                ],
                'pagination' => [
                    'limit' => 2,
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    if ($result->error()) {
        error_log($result->error());
    } else {
        echo 'Success: ' . print_r($result->data(), true);
    }

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error: ' . $e->getMessage();
}

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

BX24.callMethod(
    'catalog.product.list',
    {
        filter: [
            ['iblockId', '=', 25],
            ['iblockSectionId', '=', 41],
        ],
        select: ['id', 'name', 'active', 'type'],
        order: {
            id: 'desc',
        },
        pagination: {
            limit: 2,
        },
    },
    result => {
        if (result.error())
            console.error(result.error());
        else
            console.dir(result.data());
    }
);

SDK пока не поддерживает вызовы по адресу /rest/api/. Используйте прямой HTTP-запрос, например через cURL или fetch.

require_once('crest.php');

$result = CRest::call(
    'catalog.product.list',
    [
        'filter' => [
            ['iblockId', '=', 25],
            ['iblockSectionId', '=', 41],
        ],
        'select' => ['id', 'name', 'active', 'type'],
        'order' => [
            'id' => 'desc',
        ],
        'pagination' => [
            'limit' => 2,
        ],
    ]
);

echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.product.list", b24.Params{
	"filter":    []any{
		[]any{"iblockId", "=", 25},
		[]any{"iblockSectionId", "=", 41},
	},
	"select":    []string{"id", "name", "active", "type"},
	"order":     b24.Params{
		"id":"desc",
	},
	"pagination":b24.Params{
		"limit":2,
	},
}, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("catalog.product.list: %w", err)
}

var result struct {
	Items []struct {
		ID     int    `json:"id"`
		Name   string `json:"name"`
		Active string `json:"active"`
		Type   int    `json:"type"`
	} `json:"items"`
}
if err := json.Unmarshal(res.Result, &result); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, item := range result.Items {
	fmt.Println(item.ID, item.Name, item.Type)
}

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

HTTP-статус: 200

{
    "result": {
        "items": [
            {
                "id": 7549,
                "name": "Футболка базовая белая",
                "active": "Y",
                "type": 1
            },
            {
                "id": 7527,
                "name": "Футболка хлопковая",
                "active": "Y",
                "type": 1
            }
        ]
    },
    "time": {
        "start": 1792660648,
        "finish": 1792660648.515471,
        "duration": 0.5154709815979004,
        "processing": 0,
        "date_start": "2026-10-22T12:17:28+03:00",
        "date_finish": "2026-10-22T12:17:28+03:00",
        "operating_reset_at": 1792661220,
        "operating": 0
    }
}

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

Название
тип

Описание

result
object

Объект с данными ответа

result.items
array

Массив товаров. Состав полей каждого товара зависит от select. Описание полей

time
time

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

Элемент items

Название
тип

Описание

id
integer

Идентификатор товара

iblockId
integer

Идентификатор инфоблока торгового каталога

name
string

Название товара

code
string или null

Символьный код

xmlId
string

Внешний код. Если не задан при создании, совпадает с id

active
string

Активность товара: Y — активен, N — неактивен

sort
integer

Сортировка

createdBy
integer

Идентификатор пользователя, который создал товар

modifiedBy
integer

Идентификатор пользователя, который последним изменил товар

dateCreate
datetime

Дата и время создания в формате ISO 8601

timestampX
datetime

Дата и время последнего изменения в формате ISO 8601

dateActiveFrom
datetime или null

Дата начала активности

dateActiveTo
datetime или null

Дата окончания активности

previewText
string или null

Описание для анонса

previewTextType
string

Тип описания для анонса: text — текст, html — HTML

previewPicture
string или null

Идентификатор файла картинки для анонса. Файл можно получить методом catalog.product.download

detailText
string или null

Детальное описание

detailTextType
string

Тип детального описания: text — текст, html — HTML

detailPicture
string или null

Идентификатор файла детальной картинки. Файл можно получить методом catalog.product.download

iblockSectionId
integer или null

Идентификатор основного раздела товара

iblockSection
array

Массив идентификаторов всех разделов, к которым привязан товар

type
integer

Тип товара. Список типов возвращает метод catalog.product.type.list. У товара, созданного методом catalog.product.add, — 1

available
string

Доступность для покупки: Y — доступен, N — недоступен

bundle
string

Признак комплекта: Y — да, N — нет

quantity
double

Доступное количество

quantityReserved
double

Зарезервированное количество

quantityTrace
string

Действующий режим количественного учета: Y — включен, N — выключен

canBuyZero
string

Действующее разрешение покупки при отсутствии товара: Y — да, N — нет

subscribe
string

Действующее разрешение подписки на товар: Y — да, N — нет

vatId
integer или null

Идентификатор ставки НДС

vatIncluded
string

НДС включен в цену: Y — да, N — нет

purchasingPrice
double или null

Закупочная цена

purchasingCurrency
string или null

Валюта закупочной цены

barcodeMulti
string

Уникальный штрихкод для каждого экземпляра: Y — да, N — нет

weight
double

Вес

length
double или null

Длина

width
double или null

Ширина

height
double или null

Высота

measure
integer или null

Идентификатор единицы измерения

recurSchemeLength
integer или null

Длина периода оплаты. Используется только в коробочной версии для продажи контента

recurSchemeType
string

Единица времени периода оплаты. Используется только в коробочной версии для продажи контента

trialPriceId
integer или null

Идентификатор товара для пробной оплаты. Используется только в коробочной версии для продажи контента

withoutOrder
string

Продление без оформления заказа: Y — да, N — нет. Используется только в коробочной версии для продажи контента

quantityTraceRaw
string

Сохраненное значение режима количественного учета: Y, N или D — значение из настроек модуля

paymentType
string

Тип оплаты. Используется только в коробочной версии для продажи контента

subscribeRaw
string

Сохраненное значение разрешения подписки: Y, N или D — значение из настроек модуля

canBuyZeroRaw
string

Сохраненное значение разрешения покупки при отсутствии товара: Y, N или D — значение из настроек модуля

properties
object

Значения свойств товара. Ключ — PROPERTY_{id}, где id — идентификатор свойства. Ответ содержит все свойства инфоблока.

Значение ключа:

  • null — значение не заполнено
  • объект {"VALUE": ..., "VALUE_ID": ...} — значение одиночного свойства и идентификатор этого значения
  • массив таких объектов — значения множественного свойства

Для свойства типа «Файл» в VALUE возвращается идентификатор файла

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

HTTP-статус: 400

{
    "error": {
        "code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION",
        "message": "Ошибка при валидации объекта запроса",
        "validation": [
            {
                "message": "Iblock Not Found",
                "field": "200040300000"
            }
        ]
    }
}

Название
тип

Описание

error.code
string

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

error.message
string

Текстовое описание ошибки

error.validation
array

Массив c деталями ошибки. Присутствует только в ошибках валидации данных BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

error.validation[].field
string

Название поля, в котором возникла ошибка валидации

error.validation[].message
string

Описание ошибки, связанной с указанным полем

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

Ошибки валидации запроса

Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION

Поле

Описание ошибки

Как исправить

200040300000

Iblock Not Found

Добавьте в filter условие ["iblockId", "=", <идентификатор>] с существующим инфоблоком

-

Filter OR groups are not supported

Уберите из фильтра группы с логикой or

#FIELD#

В DTO ProductDto в поле #FIELD# требуется наличие атрибута Filterable для такого запроса

Фильтруйте только по полям из описания параметра filter

#FIELD#

В DTO ProductDto в поле #FIELD# требуется наличие атрибута Sortable для такого запроса

Сортируйте только по полям из описания параметра order

-

pagination.offset must be a non-negative multiple of pagination.limit

Передайте offset, кратный limit, или используйте page

Ошибка параметра пагинации

Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION

Поле

Описание ошибки

Как исправить

pagination

Не удается распознать параметр пагинации #PAGINATION#

Передайте limit больше нуля

Ошибка неизвестного поля

Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION

Поле

Описание ошибки

Как исправить

select, filter, order

Неизвестное поле #FIELD# для сущности ProductDto

Укажите только поля из описания параметра select. Ключи PROPERTY_{id} не поддерживаются

Ошибка доступа

Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION

HTTP-статус: 403

Поле

Описание ошибки

Как исправить

-

Доступ запрещен

Проверьте права пользователя на просмотр каталога и на чтение инфоблока

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

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус

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

Описание

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

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

401

NO_AUTH_FOUND
Wrong authorization data

В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука

401

INVALID_REQUEST
Https required

Методы вызываются только по протоколу HTTPS

401

OVERLOAD_LIMIT
REST API is blocked due to overload

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

401

ACCESS_DENIED
REST is available only on commercial plans

REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом

404

ERROR_METHOD_NOT_FOUND
Method not found!

Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа

401

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

Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на provided by the access token

401

expired_token
The access token provided has expired

Срок действия access-токена истек

401

user_access_error
The user does not have access to the application

Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям

403

PORTAL_DELETED
Portal was deleted

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

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