Create a sale | FluxStore Docs

POST/api/v1/sales

Create a new sale.

Requires the Sales:Edit permission.

Body

namestringrequired

Internal sale name.

discountPercentagenumberrequired

Discount percentage, 0–100.

applicationScopestringrequired

What the sale applies to.

Values:: storecategorypackage

categoryIdsstring[]· uuid

Required when scope is category.

packageIdsstring[]· uuid

Required when scope is package.

isEnabledboolean

Whether the sale is enabled. Defaults to true.

startDatestring· date-time

Optional start time. If absent, the sale starts immediately.

endDatestring· date-time

Optional end time. If absent, the sale runs until disabled.

POST/api/v1/sales


curl -X POST \
  -H "X-Api-Key: flx_XXXX_XXXXXXXX" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Summer Sale",
    "discountPercentage": 30,
    "applicationScope": "store",
    "isEnabled": true,
    "startDate": "2026-06-01T00:00:00Z",
    "endDate": "2026-06-30T23:59:59Z"
  }' \
  https://api.fluxstore.net/api/v1/sales

200OK


{
  "success": true,
  "data": {
    "id": "sl_a1b2c3...",
    "name": "Summer Sale",
    "isEnabled": true
  }
}