Получить список разделов торгового каталога v 3.0 catalog.section.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: пользователь с правом «Просмотр каталога товаров» или «Просмотр товаров каталога» и правом на чтение разделов инфоблока
Метод относится к REST 3.0. Особенности вызова и формат ответа новой версии API описаны в обзоре REST 3.0.
Метод catalog.section.list возвращает постранично разделы одного инфоблока торгового каталога.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
filter* |
Фильтр списка в формате REST 3.0: массив условий вида Синтаксис фильтра описан в обзоре REST 3.0 |
|
select |
Массив строк с именами полей раздела, которые нужно вернуть в ответе, например Доступные поля:
По умолчанию: все поля |
|
order |
Сортировка в формате Поля для сортировки: По умолчанию: |
|
pagination |
Постраничная навигация. Описание структуры объекта |
Параметр filter
Поддерживаются операторы =, !=, >, >=, <, <=, in, between. Условия соединяются логикой И. Группы с логикой or и отрицание не поддерживаются. Два условия с одинаковым полем и оператором в одном фильтре вызывают ошибку валидации.
|
Поле |
Описание |
|
iblockId* |
Идентификатор инфоблока. Поддерживается только оператор Идентификатор можно получить методом catalog.catalog.list |
|
iblockSectionId |
Идентификатор родительского раздела. Условие возвращает только прямые вложенные разделы, без разделов следующих уровней. Значение Операторы |
|
id |
Идентификатор раздела |
|
name |
Название раздела |
|
active |
Активность раздела: |
|
code |
Символьный код раздела |
|
xmlId |
Внешний идентификатор раздела |
Поля sort, description и descriptionType в фильтре недоступны. Условие in с пустым массивом возвращает пустой список.
Параметр pagination
|
Название |
Описание |
|
limit |
Количество разделов на странице. Допустимые значения: от По умолчанию: |
|
page |
Номер страницы, начиная с |
|
offset |
Количество разделов, которые нужно пропустить. Значение должно быть кратно По умолчанию: |
Если запрошена страница за пределами списка, метод возвращает пустой массив items. Общее количество разделов в ответе не передается: продолжайте обход, пока страница содержит limit элементов.
Примеры кода
Как использовать примеры в документации
Вызов нового API отличается добавлением параметра /api/ в запросе:
https://{адрес_установки}/rest/api/{id_пользователя}/{токен_вебхука}/catalog.section.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","name","iblockSectionId","active","sort"],"filter":[["iblockId","=",25],["iblockSectionId","=",385]],"order":{"sort":"ASC"},"pagination":{"limit":10}}' \
https://**put_your_bitrix24_address**/rest/api/**put_your_user_id_here**/**put_your_webhook_here**/catalog.section.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"select":["id","name","iblockSectionId","active","sort"],"filter":[["iblockId","=",25],["iblockSectionId","=",385]],"order":{"sort":"ASC"},"pagination":{"limit":10},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/api/catalog.section.list
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type SectionListResult = {
items: Array<{
id: number
name: string
iblockSectionId: number
active: 'Y' | 'N'
sort: number
}>
}
try {
const response = await $b24.actions.v3.call.make<SectionListResult>({
method: 'catalog.section.list',
params: {
select: [
'id',
'name',
'iblockSectionId',
'active',
'sort',
],
filter: [
['iblockId', '=', 25],
['iblockSectionId', '=', 385],
],
order: {
sort: 'ASC',
},
pagination: {
limit: 10,
},
},
requestId: Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Sections:', 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 listSections() {
try {
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v3.call.make({
method: 'catalog.section.list',
params: {
select: [
'id',
'name',
'iblockSectionId',
'active',
'sort',
],
filter: [
['iblockId', '=', 25],
['iblockSectionId', '=', 385],
],
order: {
sort: 'ASC',
},
pagination: {
limit: 10,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Sections:', result.items.length)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listSections)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.catalog.section.list(
select=["id", "name", "iblockSectionId", "active", "sort"],
filter=[
["iblockId", "=", 25],
["iblockSectionId", "=", 385],
],
order={
"sort": "ASC",
},
pagination={
"limit": 10,
},
).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.section.list',
[
'select' => ['id', 'name', 'iblockSectionId', 'active', 'sort'],
'filter' => [
['iblockId', '=', 25],
['iblockSectionId', '=', 385],
],
'order' => [
'sort' => 'ASC',
],
'pagination' => [
'limit' => 10,
],
]
);
$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.section.list',
{
select: ['id', 'name', 'iblockSectionId', 'active', 'sort'],
filter: [
['iblockId', '=', 25],
['iblockSectionId', '=', 385],
],
order: {
sort: 'ASC',
},
pagination: {
limit: 10,
},
},
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.section.list',
[
'select' => ['id', 'name', 'iblockSectionId', 'active', 'sort'],
'filter' => [
['iblockId', '=', 25],
['iblockSectionId', '=', 385],
],
'order' => [
'sort' => 'ASC',
],
'pagination' => [
'limit' => 10,
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "catalog.section.list", b24.Params{
"select": []string{"id", "name", "iblockSectionId", "active", "sort"},
"filter": []any{
[]any{"iblockId", "=", 25},
[]any{"iblockSectionId", "=", 385},
},
"order": b24.Params{
"sort": "ASC",
},
"pagination": b24.Params{
"limit": 10,
},
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("catalog.section.list: %w", err)
}
var result struct {
Items []struct {
ID int `json:"id"`
Name string `json:"name"`
IblockSectionID int `json:"iblockSectionId"`
Active string `json:"active"`
Sort int `json:"sort"`
} `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)
}
Обработка ответа
HTTP-статус: 200
{
"result": {
"items": [
{
"id": 387,
"name": "Сумки и рюкзаки",
"iblockSectionId": 385,
"active": "N",
"sort": 200
}
]
},
"time": {
"start": 1792665627,
"finish": 1792665627.622331,
"duration": 0.622330904006958,
"processing": 0,
"date_start": "2026-10-22T13:40:27+03:00",
"date_finish": "2026-10-22T13:40:27+03:00",
"operating_reset_at": 1792666200,
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Объект со списком разделов |
|
result.items |
Массив разделов на странице. Состав полей каждого раздела зависит от |
|
time |
Информация о времени выполнения запроса |
Элемент items
Таблица содержит все поля, которые можно запросить в select.
|
Название |
Описание |
|
id |
Идентификатор раздела |
|
iblockId |
Идентификатор инфоблока торгового каталога |
|
name |
Название раздела |
|
iblockSectionId |
Идентификатор родительского раздела. |
|
active |
Активность раздела: |
|
code |
Символьный код раздела. Пустая строка, если код не задан |
|
xmlId |
Внешний идентификатор раздела. Пустая строка, если идентификатор не задан |
|
sort |
Индекс сортировки |
|
description |
Описание раздела. Пустая строка, если описание не задано |
|
descriptionType |
Формат описания: |
Обработка ошибок
HTTP-статус: 400
{
"error": {
"code": "BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION",
"message": "Ошибка при валидации фильтров объекта запроса",
"validation": [
{
"message": "Требуется указать фильтр по обязательному полю `iblockId`",
"field": "filter.iblockId"
}
]
}
}
|
Название |
Описание |
|
error.code |
Строковый код ошибки. Используйте для идентификации типа исключения |
|
error.message |
Текстовое описание ошибки |
|
error.validation |
Массив c деталями ошибки. Присутствует только в ошибках валидации данных |
|
error.validation[].field |
Название поля, в котором возникла ошибка валидации |
|
error.validation[].message |
Описание ошибки, связанной с указанным полем |
Возможные коды ошибок
Ошибка обязательного фильтра
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTFILTERVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Требуется указать фильтр по обязательному полю |
Добавьте в |
Ошибки валидации запроса
Код ошибки: BITRIX_REST_V3_EXCEPTION_VALIDATION_REQUESTVALIDATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Filter condition for "iblockId" supports only equality with a single iblock |
Передайте |
|
|
Filter condition for "iblockSectionId" does not support less than comparisons |
Не используйте |
|
|
Filter condition for "iblockSectionId" supports the root value 0 only with "=", "!=", ">" or a single value "in" |
Не смешивайте |
|
|
Filter OR groups are not supported |
Уберите группу с |
|
|
Filter NOT groups are not supported |
Уберите отрицание группы условий |
|
|
Filter has conflicting conditions for the field "#FIELD#" |
Оставьте одно условие с этим полем и оператором, например замените два условия |
|
|
В DTO |
Уберите из |
|
|
В DTO |
Уберите из |
|
|
pagination.offset must be a non-negative multiple of pagination.limit |
Передайте |
Ошибка неизвестного поля
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестное поле |
Передайте в |
Ошибки формата параметров
Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не удается распознать выражение фильтра |
Передайте |
Код ошибки: BITRIX_REST_V3_EXCEPTION_UNKNOWNFILTEROPERATOREXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Неизвестный оператор фильтра |
Используйте операторы из обзора REST 3.0 |
Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDORDEREXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не удается распознать выражение сортировки |
Передайте |
Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDPAGINATIONEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не удается распознать параметр пагинации |
Передайте |
Код ошибки: BITRIX_REST_V3_EXCEPTION_INVALIDSELECTEXCEPTION
|
Поле |
Описание ошибки |
Как исправить |
|
|
Не удается распознать выражение select |
Передайте |
Ошибка доступа
Код ошибки: BITRIX_REST_V3_EXCEPTION_ACCESSDENIEDEXCEPTION
HTTP-статус: 403
|
Поле |
Описание ошибки |
Как исправить |
|
|
Доступ запрещен |
Проверьте права пользователя на каталог и разделы инфоблока из |
Статусы и коды системных ошибок
HTTP-статус: 4xx, 5xx
Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит |
|
|
|
В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука |
|
|
|
Методы вызываются только по протоколу HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — |
|
|
|
Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом |
|
|
|
Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа |
|
|
|
Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на |
|
|
|
Срок действия access-токена истек |
|
|
|
Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить раздел торгового каталога v 3.0 catalog.section.add
- Изменить раздел торгового каталога v 3.0 catalog.section.update
- Получить значения полей раздела торгового каталога v 3.0 catalog.section.get
- Удалить раздел торгового каталога v 3.0 catalog.section.delete
- Получить список полей раздела торгового каталога v 3.0 catalog.section.field.list