Loyalty Management Developer Guide

Loyalty Management Standard Objects
Loyalty Management Fields on Standard Objects
Coupon Objects in Loyalty Management
Loyalty Management Associated Objects
Apex Reference
Loyalty Management Business APIs
REST Reference
Resources
Request Bodies
Cart Input
Account Identifier Input
Contact Identifier Input
Enrollment Details Input
Enrollment Input
Offer Identifier Input
Promotion Identifier Input
Cart Input Map
Channel Input
Clone Promotion Input
Club Member Enrollment Input
Club Membership Renewal Input
Corporate Member Enrollment Input
Coupon Usage Input
Eligible Clubs Input
Eligible Coupon Input
Eligible Enrollment Period Input
Eligible Loyalty Tiers Input
Events Detail Input
Individual Member Enrollment Input
Link Program Member Partner Input
Loyalty Engine Input
Loyalty Engine Input Map
Loyalty Engine Run Settings Input
Loyalty Account Input
Loyalty Contact Input
Loyalty Process Input
Loyalty Process Input Options
Loyalty Process Parameter Map Input
Loyalty View Transaction Journal History Input
Name and ID Input
Product Details
Promotion Eligible Channel Input
Promotion Eligibility Input
Promotion Input
Promotion Limit Input
Promotion Recommendation Input
Redeem Voucher Input
Related Promotion Records Input
Unified Promotions Input
Unified Promotion Template Input
Unlink Program Member Partner Input
Promotion Reward Application Input
Response Bodies
Loyalty Management Connect API Interchangeable Request Fields
Loyalty Management Standard Invocable Actions
Loyalty Management Custom Invocable Actions
Loyalty Management Metadata API Types
Loyalty Management Tooling API Objects
Loyalty Management Mobile SDK
Gamification Mobile SDK
Data Processing Engine, Batch Management, and Monitor Workflow Services
StandardValueSet Names and Standard Picklist Fields for Loyalty Management
PDF

Coupon Usage Input

Input representation of coupon usage.
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
activity​DateTime DateTime The date and time at which the customer redeemed the coupon. Required 62.0
external​Transaction​Number 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