Получить список разделов торгового каталога catalog.section.list

Scope: catalog

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

Метод catalog.section.list возвращает список разделов торгового каталога.

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

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

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

Примеры кода

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

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

-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

// callListMethod: Получает все данные сразу. Используйте только для небольших выборок (< 1000 элементов) из-за высокой нагрузки на память.
        
        try {
          const response = await $b24.callListMethod(
            'catalog.section.list',
            {
              select: ["id", "name", "sort"],
              filter: {
                'iblockId': 14,
                '<=sort': 100
              },
              order: {'sort': '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.section.list', { select: ["id", "name", "sort"], filter: { 'iblockId': 14, '<=sort': 100 }, order: {'sort': '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.section.list', { select: ["id", "name", "sort"], filter: { 'iblockId': 14, '<=sort': 100 }, order: {'sort': 'DESC'} }, 0)
          const result = response.getData().result || []
          for (const entity of result) { console.log('Entity:', entity) }
        } catch (error) {
          console.error('Request failed', error)
        }

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 `object`	Корневой элемент ответа
section `catalog_section[]`	Массив объектов с информацией о выбранных разделах каталога
total `integer`	Общее количество найденных записей
time `time`	Информация о времени выполнения запроса

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

HTTP-статус: 400

{
            "error":200040300030,
            "error_description":"Access Denied"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код	Описание
`200040300030`	Недостаточно прав для чтения раздела каталога
`0`	Не переданы обязательные поля структуры `filter`
`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	Превышен лимит на интенсивность запросов
`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	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Получить значения полей раздела торгового каталога

Удалить раздел торгового каталога

Получить список разделов торгового каталога catalog.section.list

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

Примеры кодаПримеры кода

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

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

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

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

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

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