List sales | FluxStore Docs

GET/api/v1/sales

List sales in the store. Paginated.

Requires the Sales:View permission.

Query parameters

statusstring

Filter by sale status.

Values:: activescheduledended

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/sales


curl -H "X-Api-Key: flx_XXXX_XXXXXXXX" \
  https://api.fluxstore.net/api/v1/sales

200OK


{
  "success": true,
  "data": {
    "items": [
      {
        "id": "sl_a1b2c3...",
        "name": "Summer Sale",
        "discountPercentage": 30,
        "applicationScope": "store",
        "isEnabled": true,
        "startDate": "2026-06-01T00:00:00Z",
        "endDate": "2026-06-30T23:59:59Z"
      }
    ],
    "total": 1,
    "skip": 0,
    "take": 20
  }
}