Prerequisites
Installation & Setup
API
Config File
Developer Mode
Developer Tools
Enable Debug Mode
Events
Extensions
Features
Integrations
License System Extension
Permissions
Updating FaxStore
Weblutions Documentation > FaxStore > API > Discounts
Discounts
The Discounts API for FaxStore enables seamless management of promotional offers by supporting the creation, deletion, modification, and retrieval of discount codes. This streamlined interface helps maintain and update discount information effortlessly across your e-commerce platform.
GET /api/discounts
Returns all promotional codes on the store.
Parameters:
authorization | [Header] A valid API token |
Response: [Expand]
GET /api/discount/:id
Returns the provided promotion code
Parameters:
authorization | [Header] A valid API token |
id | [URL] The database ID for the discount |
Response: [Expand]
POST Creates a promotional code / discount code on the store.
Parameters:
authorization | [Header] A valid API token |
code | [Body] The discount code |
discount | [Body] Use an integer for a percentage. Or prefix an integer with '-' for fixed amount |
limit | [Body] Optional, the max amount of uses for the code. Defaults to 0 |
roles | [Body] Optional, the required Discord roles for the discount |
expire | [Body] Optional, the Unix timestamp in ms for the expiry of the discount |
paused | [Body] Optional, set to true to pause the discount code |
Response: [Expand]
DELETE /api/discount/:id
Deletes the provided discount
Parameters:
authorization | [Header] A valid API token |
id | [URL] The database ID for the discount |
Response: [Expand]
Review this page
discounts api