List coupons | FluxStore Docs

GET/api/v1/coupons

List coupons in the store. Paginated.

Requires the Coupons:View permission.

Query parameters

searchstring

Filter by coupon code (case-insensitive contains match).

statusstring

Filter by coupon status.

Values:: activeinactiveexpired

skipinteger

Number of results to skip. Defaults to 0.

takeinteger

Page size, max 100. Defaults to 20.

Headers

X-Api-Keystringrequired

Your API key.

GET/api/v1/coupons?status=active&take=20


curl -H "X-Api-Key: flx_XXXX_XXXXXXXX" \
  "https://api.fluxstore.net/api/v1/coupons?status=active&take=20"

200OK


{
  "success": true,
  "data": {
    "items": [
      {
        "id": "cp_a1b2c3...",
        "code": "SUMMER25",
        "discountType": "percentage",
        "discountValue": 25,
        "isActive": true,
        "uses": 12,
        "maxUses": 100
      }
    ],
    "total": 1,
    "skip": 0,
    "take": 20
  }
}