Поиск товаров

POST /v1/catalog-products/search

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

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

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

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

Примеры

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

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

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-products/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": 3
  }'

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

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

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

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-products/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: 3,
  }),
})

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

Поля ответа

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

URL карточки любого товара из массива data строится из его iblockId и id:

https://<portal>.bitrix24.ru/shop/catalog/<iblockId>/product/<id>/

<portal> — домен портала. Доступ ограничен правами сотрудника в Битрикс24.

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 6975,
      "iblockId": 25,
      "iblockSectionId": null,
      "name": "Услуга доставки",
      "active": true,
      "available": true,
      "barcodeMulti": false,
      "bundle": false,
      "canBuyZero": true,
      "measure": 9,
      "purchasingCurrency": null,
      "purchasingPrice": null,
      "quantity": 1,
      "quantityTrace": false,
      "subscribe": false,
      "vatIncluded": false,
      "weight": null,
      "withoutOrder": false,
      "dateCreate": "2025-12-02T09:14:05.000Z",
      "timestampX": "2025-12-02T09:14:05.000Z"
    }
  ],
  "meta": {
    "total": 19,
    "hasMore": true,
    "durationMs": 540
  }
}

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

400 — не передан обязательный фильтр:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_REQUIRED_FILTER",
    "message": "POST /v1/catalog-products/search requires filter fields: iblockId. Example body: { \"filter\": {\"iblockId\":\"...\"} }"
  }
}

Ошибки

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

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

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