Loyalty Management Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Get Promotions Based on Transaction Journal
Retrieve active promotions that are eligible for a transaction journal.
The action can process accrual or redemption transactions.
For more information about how the getLoyaltyPromotion action filters eligible promotions, see Get a List of Promotions Applicable for a Transaction in Salesforce Help.
This action is available in API version 53.0 and later for users in orgs where either B2C - Loyalty, B2C - Loyalty Plus, Loyalty Management - Growth, or Loyalty Management - Advanced license is enabled.
Supported REST HTTP Methods
- URI
- /services/data/vXX.X/actions/standard/getLoyaltyPromotion
- Formats
- JSON, XML
- HTTP Methods
- POST
- Authentication
- Authorization: Bearer token
Inputs
| Input | Details |
|---|---|
| JournalId |
|
Outputs
| Output | Details |
|---|---|
| PromotionRecords |
|
Example
Sample Request
{
"inputs": [ {
"JournalId":"0lVxx000000016GMAQ"
} ]
}Sample Response
[ {
"actionName" : "getLoyaltyPromotion",
"errors" : null,
"isSuccess" : true,
"outputValues" : {
"PromotionRecords" : [ {
"attributes" : {
"type" : "Promotion",
"url" : "/services/data/v53.0/sobjects/Promotion/0c8T10000004CBEIA2"
},
"Id" : "0c8xx0000004CBEIA2",
"OwnerId" : "005xx000000HwDoIAK",
"IsDeleted" : false,
"Name" : "Sample Promotion",
"CreatedDate" : "2021-07-21T04:13:15.000+0000",
"CreatedById" : "005xx000000HwDoIAK",
"LastModifiedDate" : "2021-07-21T04:13:15.000+0000",
"LastModifiedById" : "005xx000000HwDoIAK",
"SystemModstamp" : "2021-07-21T04:13:15.000+0000",
"LastViewedDate" : "2021-07-21T04:15:21.000+0000",
"LastReferencedDate" : "2021-07-21T04:15:21.000+0000",
"StartDate" : "2021-07-20",
"IsActive" : true,
"LoyaltyPromotionType" : "Cumulative",
"IsEnrollmentRequired" : false,
"CumulativeUsageTarget" : 100,
"FulfillmentAction" : "CreditPoints",
"LoyaltyProgramId" : "0lpxx00000000HWIAY",
"TotalRewardPoints" : 100,
"LoyaltyProgramCurrencyId" : "0lcxx00000000XeIAI",
"TransactionJournalType" : "Accrual",
"IsPointsWithFactor" : false
} ]
}
} ]