#Поиск каталогов

POST /v1/catalogs/search

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

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

Параметр Тип По умолч. Описание
filter object — Фильтрация по полям GET /v1/catalogs/fields.
Синтаксис фильтрации. Пример: { "iblockTypeId": "CRM_PRODUCT_CATALOG" }
limit number 50 Количество записей (до 5000)
select string[] — Выборка полей: ["id", "name"]

#Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalogs/search" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockTypeId": "CRM_PRODUCT_CATALOG" },
    "limit": 10
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalogs/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockTypeId": "CRM_PRODUCT_CATALOG" },
    "limit": 10
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalogs/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockTypeId: 'CRM_PRODUCT_CATALOG' },
    limit: 10,
  }),
})

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalogs/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockTypeId: 'CRM_PRODUCT_CATALOG' },
    limit: 10,
  }),
})

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

#Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data array Массив каталогов (все поля — см. Поля каталога)
meta.total number Общее количество каталогов, соответствующих фильтру
meta.hasMore boolean Есть ли ещё записи за пределами limit

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 25,
      "iblockId": 25,
      "iblockTypeId": "CRM_PRODUCT_CATALOG",
      "lid": "s1",
      "name": "Товарный каталог CRM",
      "productIblockId": null,
      "skuPropertyId": null,
      "subscription": "N",
      "vatId": 1
    },
    {
      "id": 27,
      "iblockId": 27,
      "iblockTypeId": "CRM_PRODUCT_CATALOG",
      "lid": "s1",
      "name": "Товарный каталог CRM (предложения)",
      "productIblockId": 25,
      "skuPropertyId": 101,
      "subscription": "N",
      "vatId": 1
    }
  ],
  "meta": {
    "total": 2,
    "hasMore": false
  }
}

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field 'nonExistentField' for entity 'catalogs'. Available: id, iblockId, iblockTypeId, lid, name, originatorId, productIblockId, skuPropertyId, subscription, vatId"
  }
}

#Ошибки

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

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

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

Каталог товаров или каталог предложений. Тип каталога в выдаче видно по полям productIblockId и skuPropertyId: у базового каталога товаров оба null; у каталога предложений они заполнены, причём productIblockId — это iblockId связанного каталога товаров.

Когда использовать list вместо search: для одного простого условия проще `GET /v1/catalogs` с query-параметром filter.

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