For AI agents: markdown of this page — /docs-content-en/entities/shipment-items/aggregate.md documentation index — /llms.txt

Aggregate: Shipment items

POST /v1/shipment-items/aggregate

Scope: sale.

Example

Terminal

curl -X POST 'https://vibecode.bitrix24.com/v1/shipment-items/aggregate' -H 'X-Api-Key: YOUR_KEY' -H 'Content-Type: application/json' -d '{"filter": {"orderDeliveryId": 42}, "aggregate": [{"field": "*", "function": "count"}]}'

Behavior

Check fields and supported operations in /v1/guide.

Response

JSON

{
  "success": true,
  "data": {
    "count": 1,
    "aggregates": {}
  }
}

Errors

HTTP	Code
400	INVALID_PARAMS / READONLY_FIELD / MISSING_REQUIRED_FIELDS / UNKNOWN_FILTER_FIELD
401	TOKEN_MISSING
403	SCOPE_DENIED / WRITE_BLOCKED_READONLY_KEY / ACCESS_DENIED
404	ENTITY_NOT_FOUND
422	BITRIX_ERROR
429	QUEUE_OVERFLOW / ERROR_LOOP_DETECTED
502	BITRIX_UNAVAILABLE
503	BITRIX_TIMEOUT

Shipment items