Loyalty Engine Input
Input representation of the Loyalty Engine Runtime API.
<loyaltyEngineInput>
Some of the API request fields contain field names that are interchangeable. For information on the list of interchangeable field names, see Loyalty Management Connect API Interchangeable Request Fields.
Here’s a sample request to pass loyalty engine runtime details.
To enforce promotion limits, include the appliedPromotions array inside each transaction journal entry in the request. Promotion limits are not evaluated if this array is absent. Use the Eligible Promotions List (POST) resource to retrieve the list of promotions that haven’t reached their limit, and pass the result as appliedPromotions. For coupon-based promotions with usage limits, also set shouldCheckCouponUsageLimit to true at the top level of the request.
Provide contactId to retrieve rewards related to a Person Account.
Using the transaction journal ID:
Sample payload to retrieve rewards assigned to accounts.
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
shouldCheckCouponUsageLimit | Boolean | Indicates whether the coupon usage limit check is enabled. | Required | 62.0 |
transactionJournals | Loyalty Engine Input Map | Represents the transaction journals records to process. | Required | 54.0 |
runSetting | Loyalty Engine Run Settings Input | Loyalty runtime setting to run the simulation on the transaction journals. | Required for simulation, otherwise optional | 55.0 |