Aggregate SKUs

POST /v1/catalog-skus/aggregate

Counts the parent products of a product catalog with filtering and grouping by section via groupBy.

The dateCreate, timestampX, dateActiveFrom, and dateActiveTo fields are not accepted in filter: the request returns 400 UNKNOWN_FILTER_FIELD before calling Bitrix24. This endpoint does not support date-range filtering. Calculate aggregates for a specific period in your integration using records from the list endpoint, where these dates are available in select and responses.

Standard fields. One field is available for grouping — iblockSectionId, the catalog section. The numeric functions sum, avg, min, max accept fields of type number, but on a parent product these are identifiers, sort and type, so the primary use case is counting products with count and grouping the results.

Request fields (body)

Examples

curl — personal key

curl -X POST "https://vibecode.bitrix24.com/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 application

curl -X POST "https://vibecode.bitrix24.com/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 — personal key

const res = await fetch('https://vibecode.bitrix24.com/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 application

const res = await fetch('https://vibecode.bitrix24.com/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()

Other scenarios

The blocks below are request bodies.

Count parent products without grouping — the fastest request, no records are fetched:

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

Count parent products without offers — type equals 6:

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

Response fields

Response example

{
  "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
    }
  }
}

Without groupBy, the data.groups field is absent from the response.

Error response example

400 — a field outside the list available for grouping:

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

Errors

For the full list of common API errors, see Errors.

Known specifics

count is resolved in one request, grouping and numeric functions are not. A request without groupBy and numeric functions is counted in a single call regardless of the size of the result set. With groupBy or the sum, avg, min, max functions, records are loaded page by page — up to 5000 — and counted on the server side. If more than 5000 records match the filter, meta.truncated is true, and the groups and aggregates are built over the first 5000. The ceiling is not the only reason for this marker: it also appears when fewer records were read than data.count promised, and the size of the gap is reported in data.meta.recordsShortfall.

The truncation marker travels with the number itself. When a response arrives with meta.truncated: true, the marker truncated: true sits inside every field object in data.aggregates and on every element of data.groups, and data.meta.warnings gains a warning with the code AGGREGATE_TRUNCATED. A client that reads only the number itself therefore sees that it was computed over only some of the records. None of these markers appear on a complete response. Full details — Aggregation POST — the 5000-record ceiling.

See also

• List SKUs
• Search SKUs
• SKU fields
• Filtering syntax
• Limits and optimization