Loyalty Management Connect API Interchangeable Request Fields
The Loyalty Management Business API supports interchangeable fields in JSON requests.
For some of the request fields, you can use either an ID, number, or name. For example, if you
don’t want to store and use Salesforce IDs when accessing Loyalty Management-related data from
an external system, simply use names and numbers instead.
Here’s a list of Loyalty Management object fields that are interchangeable with alternative field names.
Field Name | Alternative Field Name |
---|---|
MemberId | MembershipNumber |
VoucherId |
VoucherCode or VoucherNumber Ensure that the voucher code is unique among all active vouchers. |
LoyaltyProgramId | LoyaltyProgramName |
JournalTypeId | JournalTypeName |
JournalSubTypeId | JournalSubTypeName |
PromotionId |
PromotionName Ensure that the promotion name is unique among all active promotions. |
ProductId |
ProductCode or ProductName Ensure that the product name or code is unique among all active products. |
ProductCategoryId |
ProductCategoryName Ensure that the product name or code is unique among all active products. |
PartnerId | PartnerName |
- JSON example with IDs
-
{ "MemberId":"0lMT10000004CfA", "JournalTypeId":"0lET10000004CQp", "JournalSubTypeId":"0pQS10000005CQm", "VoucherId":"0kdxx000000000B245", "ProductId":"0lVxx00000000cj", "ProductCategoryId":"0c8RM0000004DnXYAU", "PromotionId":"0c8xx00000000BJEAY", "LoyaltyProgramId":"0lpT10000004CdN" }
- JSON example with names and numbers
-
{ "MembershipNumber":"Member123", "JournalType":"Accrual", "JournalSubType":"Social", "VoucherCode":"15OFF", "ProductName":"Nike", "ProductCategoryName":"Apparel", "PromotionName":"Flat20", "LoyaltyProgramName":"NTO" }