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

POST /v1/product-sections/search

Поиск разделов товаров с фильтрацией и авто-пагинацией. Аналогичен GET /v1/product-sections с фильтрами, но через POST — удобнее для сложных запросов с большим количеством условий.

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

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

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/product-sections/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "catalogId": 25 },
    "limit": 10,
    "select": ["id", "name", "catalogId", "code"]
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/product-sections/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "catalogId": 25 },
    "limit": 10,
    "select": ["id", "name", "catalogId", "code"]
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/product-sections/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { catalogId: 25 },
    limit: 10,
    select: ['id', 'name', 'catalogId', 'code'],
  }),
})

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/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { catalogId: 25 },
    limit: 10,
    select: ['id', 'name', 'catalogId', 'code'],
  }),
})

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

Поля ответа

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

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 31,
      "catalogId": 25,
      "sectionId": null,
      "name": "Одежда",
      "code": "clothes",
      "xmlId": "666"
    },
    {
      "id": 45,
      "catalogId": 25,
      "sectionId": null,
      "name": "Раздел для фильтра",
      "code": "razdel-dlya-filtra",
      "xmlId": null
    }
  ],
  "meta": {
    "total": 36,
    "hasMore": true
  }
}

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

400 — оператор или неподдерживаемое поле в фильтре:

JSON 
{
  "success": false,
  "error": {
    "code": "UNSUPPORTED_FILTER",
    "message": "UNSUPPORTED_FILTER: operators are not supported on 'product-sections' (near 'name'). Its Bitrix24 method (crm.productsection.list) filters by exact match only — operators are silently ignored by Bitrix24. Use exact match (field: value) or $in (field: {$in: [...]}) on: id, name, xmlId, code, catalogId, sectionId."
  }
}

Ошибки

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

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

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

Авто-пагинация. При limit > 50 запрос разбивается на несколько обращений к серверу. Максимум — 5000 записей за вызов. Если под фильтр попадает больше, в meta.hasMore придёт true.

Только точное равенство в фильтре. Метод фильтрует точным равенством (и $in) по id, name, xmlId, code, catalogId, sectionId. Операторы, $ne/$contains/$nin и фильтрация по sort дают 400 UNSUPPORTED_FILTER. Сортировка (order) по sort и другим полям работает.

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