Агрегация товаров

POST /v1/catalog-products/aggregate

Подсчёт количества и числовые агрегации (сумма, среднее, минимум, максимум) по товарам каталога с фильтрацией и группировкой через groupBy.

Поля, доступные для агрегации:

  • purchasingPrice
  • quantity
  • iblockSectionId

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

Параметр Тип Обяз. Описание
filter object да Фильтрация по полям товара. Ключ iblockId обязателен — каталог из `GET /v1/catalogs`.
Синтаксис фильтрации
aggregate array нет Агрегации: [{ "field": "purchasingPrice", "function": "sum" }]. Функции: sum, avg, min, max, count. Для count поле — "*". Без параметра — только count
groupBy string | string[] нет Поле или массив полей для группировки (до 5). Значения — из списка выше

Примеры

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-products/aggregate" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25 },
    "aggregate": [
      { "field": "purchasingPrice", "function": "sum" },
      { "field": "purchasingPrice", "function": "avg" }
    ],
    "groupBy": "iblockSectionId"
  }'

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

Terminal 
curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-products/aggregate" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": { "iblockId": 25 },
    "aggregate": [
      { "field": "purchasingPrice", "function": "sum" },
      { "field": "purchasingPrice", "function": "avg" }
    ],
    "groupBy": "iblockSectionId"
  }'

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-products/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 25 },
    aggregate: [
      { field: 'purchasingPrice', function: 'sum' },
      { field: 'purchasingPrice', function: 'avg' },
    ],
    groupBy: 'iblockSectionId',
  }),
})

const { success, data } = await res.json()
console.log(data.groups)

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

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-products/aggregate', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    filter: { iblockId: 25 },
    aggregate: [
      { field: 'purchasingPrice', function: 'sum' },
      { field: 'purchasingPrice', function: 'avg' },
    ],
    groupBy: 'iblockSectionId',
  }),
})

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

Для группировки по нескольким полям передайте массив: "groupBy": ["iblockSectionId", "quantity"] (максимум 5 полей).

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

Подсчёт записей — count с полем "*", самый быстрый запрос без выгрузки записей. Для каталога обязателен фильтр iblockId:

JSON 
{ "aggregate": [{ "field": "*", "function": "count" }], "filter": { "iblockId": 25 } }

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.count number Общее количество товаров, соответствующих фильтру
data.aggregates object Результаты агрегаций: { "purchasingPrice": { "sum": 0, "avg": 0 } }
data.groups array Группы — присутствуют только при groupBy. Каждый элемент: поля группировки + count + aggregates
data.meta.totalRecords number Общее количество записей
data.meta.recordsProcessed number Количество обработанных записей (до 5000). Для запроса без числовых функций — 0
data.meta.truncated boolean true, если записей больше 5000 — агрегация по первым 5000
data.meta.groupTotal number Количество групп. Присутствует только при groupBy
data.meta.groupsTruncated boolean true, если число групп было ограничено. Присутствует только при groupBy

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

JSON 
{
  "success": true,
  "data": {
    "count": 19,
    "aggregates": {
      "purchasingPrice": { "sum": 22120, "avg": 3686.67 }
    },
    "groups": [
      {
        "iblockSectionId": 19,
        "count": 2,
        "aggregates": { "purchasingPrice": { "sum": 0, "avg": 0 } }
      },
      {
        "iblockSectionId": null,
        "count": 15,
        "aggregates": { "purchasingPrice": { "sum": 120, "avg": 60 } }
      },
      {
        "iblockSectionId": 85,
        "count": 2,
        "aggregates": { "purchasingPrice": { "sum": 22000, "avg": 11000 } }
      }
    ],
    "meta": {
      "totalRecords": 19,
      "recordsProcessed": 19,
      "truncated": false,
      "groupTotal": 3,
      "groupsTruncated": false
    }
  }
}

Без groupBy поле data.groups в ответе отсутствует.

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

400 — поле вне списка доступных для агрегации:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "groupBy field 'nonexistent' is not aggregatable on this entity. Available: purchasingPrice, quantity, iblockSectionId."
  }
}

Ошибки

HTTP Код Описание
400 MISSING_REQUIRED_FILTER Не передан обязательный фильтр filter[iblockId] — проверяется до вызова Битрикс24 (пример тела в сообщении)
400 INVALID_PARAMS Поле groupBy вне списка доступных — сообщение перечисляет допустимые
400 INVALID_PARAMS Числовая функция по неизвестному полю — Field '<имя>' not found. Available numeric fields: ...
400 INVALID_PARAMS Передано более 5 полей в groupBy
403 SCOPE_DENIED API-ключ не имеет скоупа catalog
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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

count обходится одним запросом, числовые функции — нет. count подсчитывается за один вызов независимо от объёма выборки. Функции sum, avg, min, max загружают записи постранично — до 5000 — и считают значения на стороне сервера. Если под фильтр попадает больше 5000 записей, meta.truncated равен true, а агрегаты и группы строятся по первым 5000.

Поля для группировки и для расчёта. В groupBy имеет смысл передавать iblockSectionId — раздел каталога. По числовым полям purchasingPrice и quantity считают sum, avg, min, max.

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