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

POST /v1/products/search

Поиск товаров каталога с фильтрами и авто-пагинацией. Параметры передаются в теле запроса — это удобнее для сложных фильтров с большим количеством условий и для программной сборки запросов. Для списков до 5000 записей подойдёт и `GET /v1/products` с фильтром в query-параметрах.

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

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

Примеры

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

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

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/products/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "active": true },
    "limit": 20,
    "order": { "price": "desc" }
  }'

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

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

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

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

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

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

Другие сценарии

Товары одного раздела каталога:

JSON 
{ "filter": { "sectionId": 19 } }

Товары дороже 1000 в выбранной валюте:

JSON 
{ "filter": { ">=price": 1000, "currency": "RUB" } }

Поля ответа

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

URL карточки любого товара из массива data строится из catalogId и id: https://<портал>.bitrix24.ru/shop/catalog/<catalogId>/product/<id>/. <портал> — домен портала. Доступ ограничен правами сотрудника в Битрикс24.

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 6967,
      "name": "Головной товар",
      "code": "product_sku",
      "active": true,
      "sort": 100,
      "xmlId": "6967",
      "catalogId": 25,
      "sectionId": null,
      "price": 100,
      "currency": "RUB",
      "vatId": null,
      "vatIncluded": false,
      "createdAt": "2025-05-12T09:03:15.000Z",
      "updatedAt": "2025-05-12T09:05:27.000Z"
    },
    {
      "id": 6969,
      "name": "Услуга",
      "code": "service",
      "active": true,
      "catalogId": 25,
      "price": 250,
      "currency": "RUB",
      "vatId": 1,
      "vatIncluded": true,
      "createdAt": "2025-05-12T09:04:01.000Z",
      "updatedAt": "2025-05-12T09:04:01.000Z"
    }
  ],
  "meta": { "total": 19, "hasMore": true }
}

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

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

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_FILTER_OPERATOR",
    "message": "INVALID_FILTER_OPERATOR: Unknown filter operator: $badop. Supported: $gt, $gte, $lt, $lte, $ne, $contains, $in, >, >=, <, <=, !, %, !="
  }
}

Ошибки

HTTP Код Описание
400 INVALID_FILTER_OPERATOR Неподдерживаемый оператор фильтра — сообщение перечисляет допустимые
400 INVALID_FILTER Ошибка при разборе фильтра
403 SCOPE_DENIED API-ключу не хватает скоупа crm
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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

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

Свойства каталога в ответ не входят. Массив data содержит стандартные поля товара. Чтобы получить значения свойств PROPERTY_<N>, запросите товар по идентификатору через `GET /v1/products/:id`.

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