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

POST /v1/catalog-product-properties/search

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

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

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

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

Примеры

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

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

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-product-properties/search" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 19, "active": true },
    "limit": 3
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-product-properties/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 19, 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-product-properties/search', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 19, 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 Время выполнения запроса в миллисекундах

Поле id каждого определения из массива data — это NNN в ключе propertyNNN у элементов Товаров каталога:

propertyNNN  →  свойство с id = NNN

По этому соответствию строится карта id → name для подписи значений propertyNNN. Доступ ограничен правами сотрудника в Битрикс24.

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

JSON 
{
  "success": true,
  "data": [
    {
      "id": 152,
      "iblockId": 19,
      "name": "Характеристики товара",
      "propertyType": "L",
      "code": "FEATURES",
      "active": true,
      "sort": 100,
      "defaultValue": null,
      "userType": null,
      "userTypeSettings": null,
      "listType": "L",
      "multiple": true,
      "multipleCnt": null,
      "rowCount": 1,
      "colCount": 30,
      "withDescription": null,
      "searchable": false,
      "filtrable": false,
      "isRequired": false,
      "linkIblockId": null,
      "fileType": null,
      "xmlId": null,
      "hint": null,
      "timestampX": "2026-03-19T18:23:02.000Z"
    },
    {
      "id": 154,
      "iblockId": 19,
      "name": "Наименование по РУ",
      "propertyType": "S",
      "code": "NAME_RU",
      "active": true,
      "sort": 110,
      "defaultValue": null,
      "userType": null,
      "userTypeSettings": null,
      "listType": "L",
      "multiple": false,
      "multipleCnt": null,
      "rowCount": 1,
      "colCount": 30,
      "withDescription": null,
      "searchable": false,
      "filtrable": false,
      "isRequired": false,
      "linkIblockId": null,
      "fileType": null,
      "xmlId": null,
      "hint": null,
      "timestampX": "2026-03-19T18:23:02.000Z"
    }
  ],
  "meta": {
    "total": 12,
    "hasMore": false,
    "durationMs": 540
  }
}

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

400 — фильтр по полю, которого нет у свойства:

JSON 
{
  "success": false,
  "error": {
    "code": "UNKNOWN_FILTER_FIELD",
    "message": "Unknown filter field"
  }
}

Ошибки

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

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

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