Поиск разделов

POST /v1/catalog-sections/search

Поиск разделов каталога по условиям, переданным в теле запроса.

В отличие от `GET /v1/catalog-sections`, параметры filter, select, sort, limit и offset передаются в JSON-теле, а не в строке адреса — условия по нескольким полям задаются вложенной структурой. Как и список, поиск требует filter.iblockId — без этого поля запрос возвращает 400. Формат ответа тот же, что у списка.

Поля запроса (body)

Параметр Тип Обяз. По умолч. Описание
filter object да — Условия фильтрации. Ключ iblockId обязателен — ID каталога из `GET /v1/catalogs`.
Синтаксис фильтрации. Пример: { "iblockId": 25, "active": true }
select string[] нет — Выборка полей: ["id", "name", "sort"]. Возвращаются только перечисленные поля
sort string нет — Поле сортировки. Префикс - — по убыванию: "-sort"
limit number нет 50 Количество записей (до 5000)
offset number нет 0 Смещение от начала выборки

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-sections/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25, "active": true },
    "limit": 2
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-sections/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25, "active": true },
    "limit": 2
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-sections/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 25, active: true },
    limit: 2,
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-sections/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 25, active: true },
    limit: 2,
  }),
})

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

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив разделов
data[].id number Идентификатор раздела
data[].iblockId number ID каталога, которому принадлежит раздел
data[].iblockSectionId number | null ID родительского раздела. null — раздел верхнего уровня
data[].name string Название раздела
data[].code string | null Символьный код раздела
data[].xmlId string | null Внешний идентификатор
data[].sort number Индекс сортировки
data[].active boolean Активен ли раздел
data[].description string | null Описание раздела
data[].descriptionType string Формат описания: text или html
meta.total number Общее количество записей, соответствующих фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit

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

JSON 
{
  "success": true,
  "data": [
    {
      "active": true,
      "code": "clothes",
      "description": null,
      "descriptionType": "text",
      "iblockId": 25,
      "iblockSectionId": null,
      "id": 31,
      "name": "Одежда",
      "sort": 50,
      "xmlId": null
    },
    {
      "active": true,
      "code": "shoes",
      "description": null,
      "descriptionType": "text",
      "iblockId": 25,
      "iblockSectionId": 31,
      "id": 35,
      "name": "Обувь",
      "sort": 100,
      "xmlId": null
    }
  ],
  "meta": {
    "total": 37,
    "hasMore": true
  }
}

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

400 — фильтр по несуществующему полю:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'bogus' for entity 'catalog-sections'. Available: id, iblockId, iblockSectionId, name, xmlId, code, sort, active, description, descriptionType"
  }
}

Ошибки

HTTP Код Описание
400 MISSING_REQUIRED_FILTER Не передан обязательный фильтр filter.iblockId. Запрос отклоняется до обращения к Битрикс24 — сообщение содержит имя недостающего поля и пример тела запроса
400 UNKNOWN_FILTER_FIELD Фильтр по полю, которого нет у раздела. Сообщение содержит список доступных полей
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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