Список разделов

GET /v1/product-sections

Возвращает разделы каталога товаров с поддержкой фильтрации и авто-пагинации. Это те же разделы, что доступны через `GET /v1/catalog-sections` — с тем же id.

Параметры

Параметр Тип По умолч. Описание
limit number 50 Количество записей до 5000. При limit > 50 Вайбкод автоматически запрашивает несколько страниц у Битрикс24
offset number 0 Смещение от начала выборки
select string — Выборка полей: ?select=id,name,sectionId
filter object — Только точное равенство и $in (IN-множество) по полям id, name, xmlId, code, catalogId, sectionId. Операторы (>, >=, <, <=, !, %, $ne, $contains, $nin) и фильтрация по sort не поддерживаются — вернётся 400 UNSUPPORTED_FILTER.
Синтаксис фильтрации. Пример: ?filter[catalogId]=25

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/product-sections?filter[catalogId]=25&limit=10" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/product-sections?filter[catalogId]=25&limit=10" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/product-sections?filter[catalogId]=25&limit=10', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Найдено ${meta.total} разделов`)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/product-sections?filter[catalogId]=25&limit=10', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив разделов
data[].id number Идентификатор раздела
data[].name string Название раздела
data[].catalogId number ID каталога, к которому относится раздел
data[].sectionId number ID родительского раздела. У раздела верхнего уровня — null
data[].code string Символьный код раздела
data[].xmlId string Внешний идентификатор
meta.total number Общее количество записей, соответствующих фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit

Поле sort в список не входит и по нему нельзя фильтровать (в сортировке order/sort — можно). Полный набор полей раздела — `GET /v1/product-sections/fields`.

Пример ответа

JSON 
{
  "success": true,
  "data": [
    {
      "id": 31,
      "catalogId": 25,
      "sectionId": null,
      "name": "Одежда",
      "code": "clothes",
      "xmlId": "666"
    },
    {
      "id": 45,
      "catalogId": 25,
      "sectionId": null,
      "name": "Зимняя коллекция",
      "code": "winter",
      "xmlId": null
    }
  ],
  "meta": {
    "total": 36,
    "hasMore": true
  }
}

Пример ответа при ошибке

403 — нет скоупа:

JSON 
{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'crm' scope"
  }
}

Ошибки

HTTP Код Описание
400 UNSUPPORTED_FILTER Оператор или неподдерживаемое поле в фильтре. Фильтруйте точным равенством или $in по id, name, xmlId, code, catalogId, sectionId
400 INVALID_FILTER Ошибка в синтаксисе фильтра
403 SCOPE_DENIED Ключу не хватает скоупа crm
401 MISSING_API_KEY Не передан заголовок X-Api-Key

Полный список общих ошибок API — Ошибки.

Известные особенности

Только точное равенство. Фильтр применяется точным равенством (и $in-множеством) по id, name, xmlId, code, catalogId, sectionId. Операторы (>, <, !, %), $ne/$contains/$nin и фильтрация по sort дают 400 UNSUPPORTED_FILTER — так вы сразу видите, что фильтр не применился, а не получаете весь список без фильтра.

Разделы одного родителя. Чтобы получить вложенные разделы внутри конкретного раздела, фильтруйте точным равенством по filter[sectionId] с идентификатором родителя.

Без фильтра возвращаются разделы всех каталогов портала. Чтобы ограничить выборку одним каталогом, передавайте filter[catalogId]. Список каталогов — GET /v1/catalogs.

Смотрите также