Endpoints
The Coupon Management API is categorized into three functional areas:Coupon Lists (Metadata and Status)
- Create a Coupon List: Defines a new category for unique codes.
- Fetch All Coupon Lists: Retrieves a list of active or archived coupon containers.
- Fetch Coupon List Details: Retrieves real-time counts of available vs. total coupons.
- Update a Coupon List: Modifies names, expiry dates, or alert settings.
- Activate Coupon List: Reactivates archived lists with a new expiry date.
- Archive a Coupon List: Transitions a list to inactive and deletes associated codes.
Coupon Files (Inventory Management)
- Upload Coupon File: Populates a list via a hosted file URL.
- Fetch All Coupon Files: Tracks the status of all uploaded batches.
- Fetch a Coupon File: Checks the processing status (e.g., PENDING) of a specific file.
- Delete a Coupon File: Removes specific batches (useful for correcting upload errors).
Reports
- Generate Usage Report: Generates a detailed usage report for a specific coupon list, providing details on which user received which coupon.