Newer Version Available

This content describes an older version of this product. View Latest

Coupon Usage Decrease

Decrease the usage count of a list of coupons.

Example

Resource
1/services/data/vXX.X/global-promotions-management/coupons/usage-decrease
Examples
1https://yourInstance.salesforce.com/services/data/vXX.X
2/global-promotions-management/coupons/usage-decrease
1https://yourInstance.salesforce.com/services/data/vXX.X
2/global-promotions-management/coupons/usage-decrease
Available version
62.0
Requires Chatter
No
HTTP methods
POST
Request body for POST
The request body is available in version 62.0 and later.
JSON example
1{
2  "couponCodeList": [
3    "QWERTY",
4    "ABCD"
5  ],
6  "activityDateTime": "2024-10-05T12:45:19Z",
7  "externalTransactionNumber": "0lVxx000000006T",
8  "customerId": "0lMxx0000000001"
9}
Properties
Name Type Description Required or Optional Available Version
couponCodeList List<String> The codes of the list of coupons for which the usage must be increased or decreased. Required 62.0
activityDateTime DateTime The date and time at which the customer redeemed the coupon. Required 62.0
externalTransactionNumber String The externally generated unique identifier of cart for which the customer redeemed the coupon. This ID must be the same in both the decrease and increase usage APIs so that the API can correctly track coupon usage for the originating transaction. Required 62.0
customerId String The ID of either the contact, the account, or the loyalty program member who redeemed the coupon. Required 62.0
Response body for POST
Coupon Usage Result