Sign in
DiscountUsage

Discount usage report (v2)

Returns discount usage as a JSON-native list: one row per discount type, with counts and total amounts (in minor units) for baskets, items, and the combined total.

Prefer this endpoint over /shop/reports/discount-usage when integrating with another system.

get/shop/reports/discount-usage-v2

Query parameters

site_idstring uuid

Restrict to baskets at the given site.

revenue_date_fromstring date
Example:2026-06-01

Restrict to baskets with a revenue date on or after this date.

revenue_date_tostring date
Example:2026-06-30

Restrict to baskets with a revenue date on or before this date.

submitted_at_fromstring date

Restrict to baskets submitted on or after this date.

submitted_at_tostring date

Restrict to baskets submitted on or before this date.

Response

The report was successfully generated.

Example response

{
  "data": [
    {
      "discount_type_id": "60a8c0901d210625e3a87667",
      "discount_type_name": "Member Discount",
      "discount_type_code": "MEMBER10"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.