Use the Coupon Usage APIs to accurately track the usage of coupons by customers. When
customers select a coupon for their cart, use the Coupon Usage Increase API to increase the coupon
usage count. If a customer removes a selected coupon from their cart, use the Coupon Usage
Decrease API to revert the coupon usage count.
Required Editions
Available in: Lightning Experience
Available in: Enterprise, Unlimited,
and Developer Editions with Real-Time Offer Management
Coupon Usage Increase API
The API manages coupon redemptions by tracking the overall usage and per customer usage of
each coupon.
When a customer selects a coupon that they want to apply to their cart for a promotion, run
the Coupon Usage Increase API to redeem the selected coupon for the customer. The API increases
the overall usage count of the coupon and the customer's usage count of the coupon.
The API response provides detailed information about the coupon including the updated usage
count, the coupon's redemption limit, and the remaining number of redemptions available for the
coupon and the customer.
Coupon Usage Decrease API
Use the Coupon Usage Decrease API to reduce the usage count of coupons when customers deselect
a coupon from their cart. The Coupon Usage Decrease API can also be used to decrease the coupon
usage count when a transaction fails or is canceled.
The API response provides detailed information about the coupon for which the usage count has
been decreased. The information also includes the coupon's updated redemption limit and the
remaining number of redemptions available for the coupon and the customer.
Example The marketing managers at Cloud Kicks have created a promotion
for Sneakerheads, offering a US$50 discount on sneakers with a minimum purchase of $100 at the
store. The coupon for this promotion can be redeemed up to 15,000 times in total, with a limit of
5 redemptions per customer. When a customer successfully makes a purchase by using the coupon,
use the Coupon Usage Increase API to update the redemption count for the coupon.
The SNEAKER50 coupon was initially selected but the customer removed it from their
cart later. Use the Coupon Usage Decrease API to revert the count. The result shows that there
are still 13,448 redemptions left overall and 3 remaining for this particular
customer.
We use three kinds of cookies on our websites: required, functional, and advertising. You can choose whether functional and advertising cookies apply. Click on the different cookie categories to find out more about each category and to change the default settings.
Privacy Statement
Required Cookies
Always Active
Required cookies are necessary for basic website functionality. Some examples include: session cookies needed to transmit the website, authentication cookies, and security cookies.
Functional Cookies
Functional cookies enhance functions, performance, and services on the website. Some examples include: cookies used to analyze site traffic, cookies used for market research, and cookies used to display advertising that is not directed to a particular individual.
Advertising Cookies
Advertising cookies track activity across websites in order to understand a viewer’s interests, and direct them specific marketing. Some examples include: cookies used for remarketing, or interest-based advertising.