Skip to Content
FluxStore is currently invite-only. Some sections of this documentation are still being written and expanded.
APIManagement APISalesGet a sale
GET/api/v1/sales/{id}

Retrieve a single sale by its ID.

Requires the Sales:View permission.

Path parameters

idstring· uuidrequired
The sale ID.

Sale object

idstring· uuidrequired
The sale ID.
namestringrequired
Internal sale name.
discountPercentagenumberrequired
Discount percentage, 0–100.
applicationScopestringrequired
What the sale applies to.
Values:
storecategorypackage
categoryIdsstring[]· uuid
Categories on sale (when scope is category).
packageIdsstring[]· uuid
Packages on sale (when scope is package).
isEnabledbooleanrequired
Whether the sale is currently active.
startDatestring· date-time
Sale start time.
endDatestring· date-time
Sale end time.
createdAtstring· date-timerequired
Creation timestamp.
updatedAtstring· date-timerequired
Last update timestamp.
List salesCreate a sale