The Coupon Pool API allows users to create and manage coupon pools effectively. Coupon pools serve as containers that define the characteristics of individual coupons, including their value, code patterns, expiration dates, and other relevant attributes. This API is designed for developers who want to integrate coupon pool functionalities into their applications, facilitating the management of various promotional offers within a cohesive structure.
Key Features
-
Create a new Coupon Pool
Creating a new coupon pool with specific attributes allows for the establishment of a new set of coupons that define their characteristics and rules for usage.Use the
POST/v1/coupon-poolsendpoint to implement this feature. A request body should be sent containing required attributes such asname,source,type, and optional attributes likeproductsandstores. -
Update an existing Coupon Pool
Updating attributes for an existing coupon pool is beneficial when modifying details such as adjusting values or changing the expiration parameters of coupons.To perform this action, use the
POST/v1/coupon-pools/{coupon_pool_id}/updateendpoint. Thecoupon_pool_idshould be provided in the URL, along with a request body containing the updated attributes, including the requiredupdate_method.
API Principles
The Coupon Pools API follows RESTful principles, utilizing standard HTTP methods to interact with resources. All responses are formatted in JSON, ensuring easy integration into user interfaces.
Security and Compliance
All server-to-server calls must comply with the API security protocol and signing procedure and adhere to the defined API rate limits.