Для AI-агентов: markdown этой страницы — /docs-content/entities/product-sections/list.md индекс документации — /llms.txt

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

GET /v1/product-sections

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

Параметры

Параметр Тип По умолч. Описание
limit number 50 Количество записей до 5000. При limit > 50 Вайбкод сам собирает несколько страниц в один ответ
offset number 0 Смещение от начала выборки
select string — Выборка полей: ?select=id,name,sectionId
sort string — Сортировка по полям name, sort, code, xmlId, catalogId, sectionId: ?sort=name, минус означает убывание: ?sort=-name
order object — Сортировка объектом: ?order[name]=desc. Если передан sort, действует он
include string — Связанные данные: catalog, parentSection. Подробнее — секция «Связанные данные»
withTotal string — Принимается как true или false, но для разделов товаров не меняет подсчёт и наличие meta.total
filter object — Фильтрация по полям GET /v1/product-sections/fields. Только точное равенство и $in (IN-множество) по полям id, name, xmlId, code, catalogId, sectionId. Операторы (>, >=, <, <=, !, %, $ne, $contains, $nin) и фильтрация по sort не поддерживаются — вернётся 400 UNSUPPORTED_FILTER.
Синтаксис фильтрации. Пример: ?filter[catalogId]=25. Источник catalogId: GET /v1/catalogs

Примеры

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

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

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

Terminal 
curl -g "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 каталога, к которому относится раздел. Источник: GET /v1/catalogs
data[].sectionId number | null ID родительского раздела — id другого раздела из этого же списка. Источник: GET /v1/product-sections. У раздела верхнего уровня — null
data[].code string | null Символьный код раздела
data[].xmlId string | null Внешний идентификатор
meta.total number Общее количество записей, соответствующих фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit

Поле sort в ответ списка не входит. Полный набор полей раздела — GET /v1/product-sections/fields.

Связанные данные

Получить связанные записи вместе со списком — параметр include:

GET /v1/product-sections?filter[catalogId]=25&limit=1&include=catalog,parentSection

Доступные значения include: catalog — торговый каталог, к которому относится раздел, и parentSection — родительский раздел. Связь catalog читает каталоги, поэтому ключу нужен скоуп catalog. У раздела верхнего уровня parentSection приходит null. Результат — в поле _included каждого элемента data[]:

JSON 
{
  "success": true,
  "data": [
    {
      "id": 31,
      "catalogId": 25,
      "sectionId": null,
      "name": "Одежда",
      "code": "clothes",
      "xmlId": "666",
      "_included": {
        "catalog": {
          "iblockId": 25,
          "iblockTypeId": "CRM_PRODUCT_CATALOG",
          "id": 25,
          "lid": "s1",
          "name": "Товарный каталог CRM",
          "productIblockId": null,
          "skuPropertyId": null,
          "subscription": "N",
          "vatId": 1,
          "yandexExport": false
        },
        "parentSection": null
      }
    }
  ],
  "meta": {
    "total": 37,
    "hasMore": true
  }
}

Подробнее о параметре include: Связанные данные.

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

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 Ошибка в синтаксисе фильтра
400 INVALID_INCLUDE Неизвестное имя в include. Сообщение перечисляет доступные: catalog, parentSection
403 SCOPE_DENIED Ключу не хватает скоупа crm
403 SCOPE_DENIED Передан include=catalog, а у ключа нет скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key
429 RATE_LIMITED Превышен лимит запросов: 300 в минуту на портал, все API-ключи портала делят один лимит. Точное значение — в заголовке x-ratelimit-limit (потолок делится на реплики). Повторите после срока из заголовка Retry-After

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

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

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

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

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

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