Агрегация головных товаров

POST /v1/catalog-skus/aggregate

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

Поля dateCreate, timestampX, dateActiveFrom и dateActiveTo не принимаются в filter: запрос возвращает 400 UNKNOWN_FILTER_FIELD до обращения к Битрикс24. Отбора по периоду у агрегата нет — считайте его на своей стороне по записям списка, где эти даты доступны в select и приходят в ответе.

Стандартные поля. Для группировки доступно одно поле — iblockSectionId, раздел каталога. Числовые функции sum, avg, min, max принимают поля с типом number, но у головного товара это идентификаторы, sort и type, поэтому основной сценарий раздела — подсчёт count с группировкой.

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

Примеры

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

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

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

curl -X POST "https://vibecode.bitrix24.tech/v1/catalog-skus/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": "*", "function": "count" }],
    "groupBy": "iblockSectionId"
  }'

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

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

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

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

const res = await fetch('https://vibecode.bitrix24.tech/v1/catalog-skus/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: '*', function: 'count' }],
    groupBy: 'iblockSectionId',
  }),
})

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

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

Блоки ниже — тела запросов.

Подсчёт головных товаров без группировки — самый быстрый запрос, записи не выгружаются:

{ "filter": { "iblockId": 25 } }

Подсчёт головных товаров без вариаций — type равен 6:

{ "filter": { "iblockId": 25, "type": 6 } }

Поля ответа

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

{
  "success": true,
  "data": {
    "count": 14,
    "aggregates": {},
    "groups": [
      { "iblockSectionId": null, "count": 11, "aggregates": {} },
      { "iblockSectionId": 85, "count": 1, "aggregates": {} },
      { "iblockSectionId": 19, "count": 2, "aggregates": {} }
    ],
    "meta": {
      "totalRecords": 14,
      "recordsProcessed": 14,
      "truncated": false,
      "groupTotal": 3,
      "groupsTruncated": false
    }
  }
}

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

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

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

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

Ошибки

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

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

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

Признак усечения приходит рядом с самим числом. Когда ответ приходит с meta.truncated: true, пометка truncated: true стоит внутри объекта каждого поля в data.aggregates, у каждого элемента data.groups, а в data.meta.warnings добавляется предупреждение с кодом AGGREGATE_TRUNCATED. Так клиент, который читает только само число, видит, что оно посчитано по части записей. На полном ответе ни одной из этих пометок нет. Полный разбор — Агрегация POST — потолок 5000 записей.

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

• Список головных товаров
• Поиск головных товаров
• Поля головного товара
• Синтаксис фильтрации
• Лимиты и оптимизация