productSummary

Requires permission products:product:read.

Returns product counts for your organization, such as total, active, inactive, out-of-stock and low-stock products, products per category, inventory value and recently added products. Needs the products read permission.

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 ProductSummary {
  productSummary {
    activeProducts
    inactiveProducts
    lastUpdated
    lowStockProducts
    outOfStockProducts
    totalInventoryValue
    productsByCategory {
      count
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query ProductSummary {\n  productSummary {\n    activeProducts\n    inactiveProducts\n    lastUpdated\n    lowStockProducts\n    outOfStockProducts\n    totalInventoryValue\n    productsByCategory {\n      count\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "productSummary": {
      "activeProducts": 0,
      "inactiveProducts": 0,
      "lastUpdated": "2025-01-15T00:00:00Z",
      "lowStockProducts": 0,
      "outOfStockProducts": 0,
      "totalInventoryValue": 0,
      "productsByCategory": [
        {
          "count": 0
        }
      ]
    }
  }
}

productSummary: ProductSummary!

Type

ProductSummary object

Headline product figures.