Для AI-агентов: markdown этой страницы — /docs-content/entities/products/search.md индекс документации — /llms.txt

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

POST /v1/products/search

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

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

Параметр Тип По умолч. Описание
filter object — Только точное равенство и $in (IN-множество) по полям id, name, code, xmlId, active, sectionId, sort, description. Операторы (>, >=, <, <=, !, %, $ne, $contains, $nin) и фильтрация по другим полям (price, currency) не поддерживаются — вернётся 400 UNSUPPORTED_FILTER.
Синтаксис фильтрации. Пример: { "sectionId": 19, "active": true }
limit number 50 Количество записей (до 5000)
offset number 0 Пропустить N записей
order object — Сортировка по полям id, name, sort: { "sort": "desc" }. Поля price и currency сортировку не поддерживают
select string[] — Выборка полей: ["id", "name", "price"]. Пользовательское свойство каталога запрашивается своим именем: ["id", "name", "PROPERTY_301"]. Имена свойств — в Полях товара

Примеры

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": { "sort": "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": { "sort": "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: { sort: '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: { sort: 'desc' },
  }),
})

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

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

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

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

Несколько товаров по идентификаторам через $in:

JSON 
{ "filter": { "id": { "$in": [6967, 533] } } }

Поля ответа

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

Поля meta лежат рядом с data, а не внутри него. Обходить страницы нужно по meta.hasMore: длина data, равная 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, "durationMs": 2509 }
}

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

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

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

Ошибки

HTTP Код Описание
400 UNSUPPORTED_FILTER Оператор или неподдерживаемое поле в фильтре. Фильтруйте точным равенством или $in по id, name, code, xmlId, active, sectionId, sort, description
400 INVALID_FILTER Ошибка при разборе фильтра
400 UNKNOWN_SELECT_FIELD В select передано имя, которого нет у товара. Сообщение перечисляет допустимые имена после слова Available
400 SELECT_FIELD_NOT_RETURNED В select передано имя, которое Поля товара показывают с признаком notReturned: true, — например currencyId. Уберите его из select
403 SCOPE_DENIED API-ключу не хватает скоупа crm
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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

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

Свойства каталога приходят по явному перечислению. Без select массив data содержит базовые поля товара. Каждое нужное свойство называется в select своим именем — ["id", "name", "PROPERTY_295"]. Значение select со звёздочкой их не возвращает.

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