Получить список разделов торгового каталога catalog.section.list
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
catalogКто может выполнять метод: администратор
Метод catalog.section.list возвращает список разделов торгового каталога.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
select |
Массив содержит список полей, которые необходимо выбрать (смотрите поля объекта catalog_section). Если не передан или передан пустой массив, то будут выбраны все доступные поля раздела каталога |
|
filter |
Объект для фильтрации выбранных разделов каталога в формате Возможные значения для Поле Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
|
|
order |
Объект для сортировки выбранных разделов каталога в формате Возможные значения для Возможные значения для
|
|
start |
Параметр используется для управления постраничной навигацией. Размер страницы результатов всегда статичный: 50 записей. Чтобы выбрать вторую страницу результатов, необходимо передавать значение Формула расчета значения параметра
|
Примеры кода
Как использовать примеры в документации
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"select": ["id", "name", "sort"],
"filter": {
"iblockId": 14,
"<=sort": 100
},
"order": {
"sort": "DESC"
}
}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/catalog.section.list
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"select": ["id", "name", "sort"],
"filter": {
"iblockId": 14,
"<=sort": 100
},
"order": {
"sort": "DESC"
},
"auth": "**put_access_token_here**"
}' \
https://**put_your_bitrix24_address**/rest/catalog.section.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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type CatalogSectionListResult = {
sections: {
id: number
name: string
sort: number
}[]
}
try {
// catalog.section.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<CatalogSectionListResult>({
method: 'catalog.section.list',
params: {
select: ['id', 'name', 'sort'],
filter: {
iblockId: 14,
'<=sort': 100,
},
order: {
sort: '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('Sections on this page:', result.sections.length, result.sections)
}
} 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 fetchCatalogSections() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
// catalog.section.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.section.list',
params: {
select: ['id', 'name', 'sort'],
filter: {
iblockId: 14,
'<=sort': 100,
},
order: {
sort: '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('Sections on this page:', result.sections.length, result.sections)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', fetchCatalogSections)
</script>
try {
$response = $b24Service
->core
->call(
'catalog.section.list',
[
'select' => ["id", "name", "sort"],
'filter' => [
'iblockId' => 14,
'<=sort' => 100
],
'order' => ['sort' => 'DESC']
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error calling catalog section list: ' . $e->getMessage();
}
BX24.callMethod(
'catalog.section.list',
{
select: ["id", "name", "sort"],
filter: {
'iblockId': 14,
'<=sort': 100
},
order: {'sort': 'DESC'}
},
function(result)
{
if(result.error())
console.error(result.error());
else
console.log(result.data());
}
);
require_once('crest.php');
$result = CRest::call(
'catalog.section.list',
[
'select' => ["id", "name", "sort"],
'filter' => [
'iblockId' => 14,
'<=sort' => 100
],
'order' => [
'sort' => 'DESC'
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Обработка ответа
HTTP-статус: 200
{
"sections": [
{
"id": 13,
"name": "Товары",
"sort": 500
},
{
"id": 14,
"name": "Услуги",
"sort": 500
},
{
"id": 22,
"name": "Обувь",
"sort": 50
}
],
"total": 3,
"time": {
"start": 1712326352.63409,
"finish": 1712326352.8319,
"duration": 0.197818040847778,
"processing": 0.00833678245544434,
"date_start": "2024-04-05T16:12:32+02:00",
"date_finish": "2024-04-05T16:12:32+02:00",
"operating": 0
}
}
Возвращаемые данные
|
Название |
Описание |
|
result |
Корневой элемент ответа |
|
section |
Массив объектов с информацией о выбранных разделах каталога |
|
total |
Общее количество найденных записей |
|
time |
Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error":200040300030,
"error_description":"Access Denied"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
|
|
Недостаточно прав для чтения раздела каталога |
|
|
Не переданы обязательные поля структуры |
|
|
Другие ошибки (например, фатальные ошибки) |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Добавить раздел торгового каталога catalog.section.add
- Изменить раздел торгового каталога catalog.section.update
- Получить значения полей раздела торгового каталога catalog.section.get
- Удалить раздел торгового каталога catalog.section.delete
- Получить поля раздела торгового каталога catalog.section.getFields