Coupons API
Overview
The CCVM (Centralized Coupon and Voucher Management) feature enables Vynamic Engage retailers to offer their customers a variety of discounts and promotions. Coupons are a reward used to grant discounts to customers based on the quantity or value of the purchased products. Both the required quantity and value can be adjusted to the preferences of the user configuring a given offer.
The Coupons API enables retailers to integrate with the existing POS systems or e-commerce platforms. The retailer can manage, retrieve, and validate Coupons to provide offers to the customer as per the configured setup.
Coupon templates is a feature that enables users to pre-configure settings for future coupons, which can be used for quicker and more efficient creation thereof. Using the promotions offered by Vynamic Engage, users can set up coupons that guarantee a discount for the subsequent purchases. The Coupon Templates area in Vynamic Engage allows the user to create, edit and view coupon templates.
User can select one of the below coupon types and define template's parameters:
| Coupon type | Description |
|---|---|
| Non-serialized preprinted | A preprinted coupon on paper or other print material with a fixed coupon ID, no serial number, multi-redemption is possible, only a validity check. |
| Non-serialized digital | A coupon with a fixed coupon ID for different distribution channels (SMS, mail, mobile wallet). No serial number, multi-redemption is possible, only a validity check. |
| Non-serialized printed on receipt | A paper coupon with a fixed coupon ID printed on POS. No serial number, multi-redemption is possible, only a validity check. |
| Serialized pre-printed | A preprinted coupon on paper or other print material with serial number. Validity check and one-time redemption. |
| Serialized digital | A coupon with serial number for different distribution channels (SMS, mail, mobile wallet). Validity check and one-time redemption. |
| Serialized printed on receipt | A paper coupon with a serial number printed on POS. Validity check and one-time redemption. |
The retailer issues a Coupon from a template, and then reserves and redeems the Coupon. It is not possible to redeem a Coupon which has already been used. The user can also release the Coupon after reservation. In this scenario, it is possible to reserve and redeem a previously released Coupon.
Mass Coupon Issue feature supports marketing campaigns and enables Retailers to issue multiple personalized coupon codes from a given template.
Mass Coupon Redemption feature enables Retailers to import already redeemed coupons from another system into CCVM.
Features
The Coupons API provides the following features to manage different types of coupons on the POS system:
- GET/coupons/{couponCode} endpoint - used to retrieve coupon details based on the specified barcode.
- PUT/coupons/issues/reservation/{couponCode} endpoint - enables coupon reservation and places it under ReservationId.
- DELETE/coupons/issues/reservation/{couponCode} endpoint - used to cancel coupon reservation by ReservationId.
- POST /coupons/templates/{couponTemplateId}/issues endpoint - issues a coupon from a given template (couponTemplateId).
- PUT/coupons/redemptions endpoint - used to manage a collection of coupons, redeem coupons by Redemptions.CouponCode and Redemptions.Date, cancel coupon reservation by ReleaseReservationFor, and redeem coupons previously reserved by reservationId.
- POST /coupons/templates - enables to create a coupon template.
- GET /coupons/templates/search - used to search and order coupon templates based on various parameters (name, creation date, validity period, status, type, Id, etc.)
- GET /coupons/customers/{customerId} - used to retrieve a collection of serialized digital coupons by Customer Id assigned to a coupon.
- POST /coupons/massIssueJob, GET /coupons/massIssueJob/{id}, GET /coupons/massIssueJob/search, GET /coupons/massIssueJob/result/{id} and GET /coupons/massIssueJob/resultAsCsv/{id} endpoints - used to create a Coupon Mass Issue job, retrieve a collection of a Coupon Mass Issue job by Id, search for Coupon Mass Issue jobs based on various parameters, retrieve a Coupon Mass Issue job result, and retrieve a Coupon Mass Issue job results as a .CSV file.
- POST /coupons/couponMassRedemptionJob, GET /coupons/couponMassRedemptionJob/{id} and GET /coupons/couponMassRedemptionJob/search endpoints - used to create a Coupon Mass Redemption job, retrieve a collection of a Coupon Mass Redemption job by Id, and search for Coupon Mass Redemption jobs based on various parameters.
- GET /healthCheck - enables the API client to check the status of the dependent backend service. On the 200 response, the client receives the overall status information: healthy, degraded, unhealthy.
Benefits
The Coupons API enhances the customer journey by offering different types of coupons to customers. Retailers can offer their customers a more engaging and personalized shopping experience, while also improving customer retention and loyalty.
Security
The Coupons API supports OAuth 2.0 for authentication purposes.
The supported protocol for the Coupons API is HTTPS.