discountSchemesSummary

Requires permission products:discount:read.

Returns discount scheme counts for the whole organization, such as total, active, expired and scheduled schemes, counted by the database over every scheme. Needs the discounts 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 DiscountSchemesSummary {
  discountSchemesSummary {
    activeSchemes
    expiredSchemes
    scheduledSchemes
    totalSchemes
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query DiscountSchemesSummary {\n  discountSchemesSummary {\n    activeSchemes\n    expiredSchemes\n    scheduledSchemes\n    totalSchemes\n  }\n}"
}
EOF

Response:

{
  "data": {
    "discountSchemesSummary": {
      "activeSchemes": 0,
      "expiredSchemes": 0,
      "scheduledSchemes": 0,
      "totalSchemes": 0
    }
  }
}

discountSchemesSummary: DiscountSchemesSummary!

Type

DiscountSchemesSummary object

Headline discount scheme counts.