метод REST scope: catalog

catalog.section.list

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

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

Описание

Метод 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 — номер нужной страницы

Примеры запроса

-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

Ответ

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"
}
Код Описание Значение
200040300030 Недостаточно прав для чтения раздела каталога
0 Не переданы обязательные поля структуры filter
0 Другие ошибки (например, фатальные ошибки)

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.