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

POST /v1/products/aggregate

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

Стандартные поля. Для группировки и подсчёта доступны:

  • price — цена. Числовое агрегирование имеет смысл
  • sectionId — раздел каталога. Для groupBy
  • catalogId — идентификатор каталога. Для groupBy
  • active — активность. Для groupBy

Пользовательские свойства. Свойства каталога вида PROPERTY_<N> в агрегации не участвуют — для числовых функций используйте price, для разбиения по группам — sectionId, catalogId или active.

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

Параметр Тип Обяз. Описание
aggregate array нет Агрегации: [{ "field": "price", "function": "sum" }]. Функции: sum, avg, min, max, count. Для count поле — "*". Без параметра — только count
filter object нет Фильтрация по полям товара.
Синтаксис фильтрации. Пример: { "active": true }
groupBy string | string[] нет Поле или массив полей для группировки (до 5). Значения — price, sectionId, catalogId, active

Примеры

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

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

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

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

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

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

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

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

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

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

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

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

Подсчёт записей — count с полем "*", самый быстрый запрос без выгрузки записей. Без массива aggregate результат тот же:

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

Сумма и среднее цены по всему каталогу, без разбиения по группам:

JSON 
{
  "aggregate": [
    { "field": "price", "function": "sum" },
    { "field": "price", "function": "avg" }
  ]
}

Поля ответа

Поле Тип Описание
success boolean Всегда true при успехе
data.count number Общее количество товаров, соответствующих фильтру
data.aggregates object Результаты агрегаций: { "price": { "sum": 0, "avg": 0 } }
data.groups array Группы — присутствуют только при groupBy. Каждый элемент: поля группировки + count + aggregates
data.meta.totalRecords number Общее количество записей
data.meta.recordsProcessed number Количество обработанных записей (до 5000)
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": {
      "price": { "sum": 68680, "avg": 5283.076923076923 }
    },
    "groups": [
      {
        "sectionId": null,
        "count": 15,
        "aggregates": { "price": { "sum": 2662, "avg": 295.77777777777777 } }
      },
      {
        "sectionId": 19,
        "count": 2,
        "aggregates": { "price": { "sum": 20, "avg": 10 } }
      },
      {
        "sectionId": 85,
        "count": 2,
        "aggregates": { "price": { "sum": 65998, "avg": 32999 } }
      }
    ],
    "meta": {
      "totalRecords": 19,
      "recordsProcessed": 19,
      "truncated": false,
      "groupTotal": 3,
      "groupsTruncated": false
    }
  }
}

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

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

400 — числовая функция по нечисловому полю:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_PARAMS",
    "message": "Field 'name' is not numeric (type: string). Only number fields support sum."
  }
}

Ошибки

HTTP Код Описание
400 INVALID_PARAMS Неизвестная функция агрегации
400 INVALID_PARAMS Числовая функция по нечисловому полю — сообщение называет тип поля
400 INVALID_PARAMS Несуществующее поле — сообщение перечисляет допустимые числовые поля
400 INVALID_PARAMS Поле groupBy вне списка price, sectionId, catalogId, active
400 INVALID_PARAMS Передано более 5 полей в groupBy
403 SCOPE_DENIED API-ключу не хватает скоупа crm
401 MISSING_API_KEY Не передан заголовок X-Api-Key

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

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

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

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