get
https://example.com
GET /v2/ecommerceReports/coupons/used-on-orders — All-coupon discount report
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
All-coupon uses and discount revenueImpact (negative) for Affiliate Command. Same order-qualify pipeline as per-coupon analytics. Redeem rows filter on redeemedAt; summary totalOrders / ordersWithCoupon also filter on order.createdAt.
Per-coupon KPIs, redeemers, and products: Coupon analytics metrics and definitions.
Query
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
dateRange | string | No | month_to_date | Any DATE_RANGE preset, or custom |
startDate | string | When custom | — | Custom range start |
endDate | string | When custom | — | Custom range end |
productVariationId | string | No | — | Product filter; omit or all for none |
campaignId | string | No | — | Campaign filter; omit or all for none |
page | integer | No | server default | Page number |
limit | integer | No | server default | Page size |
sortBy | string | No | uses | uses, revenueImpact, or coupon |
sortOrder | string | No | desc | asc or desc |
export | string | No | "false" | "true" or "1" returns CSV |
Invalid dateRange, or custom without both dates → 422 (key: INVALID_FIELD).
Auth and errors
| Status | When |
|---|---|
| 400 | Affiliate context is required, or ecommerce module is disabled |
| 401 | Missing or invalid bearer token |
| 403 | Role or couponAnalytics full access denied (AFFILIATE_SUPER_ADMIN or AFFILIATE_ADMIN only — not AFFILIATE_AGENT) |
| 422 | Invalid date range |
Response (200)
200)JSON:
{
"success": true,
"data": {
"range": {
"startDate": "2026-09-01T00:00:00.000Z",
"endDate": "2026-09-28T23:59:59.999Z",
"preset": "month_to_date"
},
"summary": {
"ordersWithCoupon": 12,
"totalOrders": 80,
"ordersWithCouponPct": 15,
"totalDiscounted": 420.5
},
"items": [
{
"coupon": "SAVE20",
"discount": {
"amount": 20,
"type": "percent",
"display": "20%"
},
"uses": 8,
"revenueImpact": -160.0
}
],
"pagination": {
"page": 1,
"limit": 10,
"total": 1,
"totalPages": 1
}
}
}CSV (export=true or export=1): columns Coupon, Discount Display, Discount Amount, Discount Type, Uses, Revenue Impact.
OpenAPI schema: CouponsUsedOnOrdersSuccessEnvelope.