Promotion Reward Application API

After an order is placed, the API takes the cart's applied promotion and reward details as input. You can execute the API for contacts and accounts. If your company uses person accounts to manage customers, specify the Contact ID that's associated with the customer's person account.

The API response contains the details of the pricing and non-pricing rewards provided to the customer for their order. The Promotion Reward Application API can be executed to provide these rewards:

• Discounts
• Vouchers
• Games

The Promotion Reward Application 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.

The Promotion Reward Application API automatically manages these limits.

• Promotion limits:
  • Points
  • Vouchers
• Customer limits:
  • Points
  • Vouchers
  • Use per Customer

You must set up processes to manage the per cart, per line item, liability, and total use limits.

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

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.

Promotion Reward Application 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. To use the 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.