shipmentStatusGroupCounts

Requires permission sales:shipment:list.

How many shipments each status group (Shipments list tab) holds under the filter — the filter's own statusGroup is ignored so every tab shows its count. Every group is listed. Rep-scoped like the list.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query ShipmentStatusGroupCounts {
  shipmentStatusGroupCounts {
    count
    statusGroup
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ShipmentStatusGroupCounts {\n  shipmentStatusGroupCounts {\n    count\n    statusGroup\n  }\n}"
}
EOF

Response:

{
  "data": {
    "shipmentStatusGroupCounts": [
      {
        "count": 0,
        "statusGroup": "BOOKED"
      }
    ]
  }
}

shipmentStatusGroupCounts(
  filter: ShipmentListFilterInput
): [ShipmentStatusGroupCount!]!

Arguments

shipmentStatusGroupCounts.filter ● ShipmentListFilterInput input

Filter criteria for shipment list records. Omit to match all.

Type

ShipmentStatusGroupCount object

How many shipments one list tab holds under a filter.