Transaction Journal Execution API

After a customer selects the promotions that they want to use for their cart and places their order, the Transaction Journal Execution API provides the customer the non-pricing rewards of the promotions.

The API takes the customer’s promotion rewards as input and creates a transaction journal record. You can execute the API for contacts, accounts, and loyalty program members. If your company uses person accounts to manage customers, specify the Contact ID that's associated with the customer's person account.

When the API is executed for a loyalty program member's order, the member's Loyalty Program Member record is associated with the transaction journal. If the API is executed for a customer who isn't a loyalty program member, the customer's Contact record or Account record is associated with the transaction journal as an associated individual.

The API response contains the details of the pricing and non-pricing rewards that are provided to the customer for their order. To learn more about the Transaction Journal Execution API, see Transaction Journal Execution.

Important The resource of the Transaction Journal Execution API requires the name of a loyalty program. If the API is executed to reward members of your loyalty program, specify the name of the loyalty program that the member belongs to in the resource. If the API is executed to reward contacts or accounts, execute the API with the name of one of the loyalty programs available in the org. If you don't have a loyalty program in the org and want to reward contacts or accounts, create a placeholder loyalty program to execute the API.

The Transaction Journal Execution API can be executed to provide these rewards based on the customer type.

• Accounts and contacts:
  • Discounts
  • Vouchers
  • Games
• Loyalty program members:
  • Discounts
  • Points
  • Vouchers
  • Games
  • Badges

The Transaction Journal Execution API also creates or updates the promotion’s related usage record based on the parameters present in the API request.

Promotion limit usage records help track the usage of each promotion reward against the promotion’s limits. Promotion party usage records help track the usage of each promotion reward by customers against the promotion’s customer-level limits.

To enforce limits, call the Eligible Promotions List (POST)to check eligibility, then run the Transaction Journal Execution API to apply promotions. Alternatively, use the Unified Execution API to handle both steps together.

When the API is executed to reward a customer, the value of the Usage Count field in the customer's promotion party usage is incremented by 1.

If the Transaction Journal Execution API input consists of multiple pricing discounts, the first discount amount is saved in the transaction journal that the API creates. The subsequent discounts are saved in individual promotion party usage detail record. The API creates the promotion party usage detail records. Each promotion party usage detail record stores the discount amount and the record is associated with the promotion that provided the discount and the transaction journal that the API created.

Tip Apart from a promotion’s voucher and points limit, the marketing manager can add other limits for the promotion. You can set up a process to update the promotion’s usage or the promotion’s customer usage for the other promotion limits as well.

Transaction Journal Execution API for Promotions with Coupons

When you run the API, specify the coupon code that the customer used for their order. The coupon code uniquely identifies the promotion that the customer used for their order.

The API consists of the shouldCheckCouponUsageLimit parameter. If you already increased the usage of the coupon, set the parameter to False. If you want to use the Transaction Journal Execution API to check whether the coupon is available for redemption and then increase the coupon usage count, set the parameter to True.

Note

The shouldCheckCouponUsageLimit parameter and the Coupon Usage Increase API perform similar functions. To avoid potential conflicts, don't use them simultaneously.