You are here:
Workflow to Run Pricing Promotions
Review the workflow for how multiple APIs work together to show customers the promotions their carts are eligible for and to apply the promotions that customers use for their orders. The workflow differs depending on whether your company's promotions use coupons or not.
Required Editions
| Available in: Lightning Experience |
| Available in: Enterprise, Unlimited, and Developer Editions with Real-Time Offer Management |
Run Pricing Promotions
| sequence | API | api USE |
|---|---|---|
| 1 | Eligible Promotions API | Provides customers a list of promotions that are eligible for their carts. |
| 2 | Promotion Evaluation and Execution API The API is used only when Promotion Evaluation and Execution is enabled |
Evaluates cart details and returns the adjusted price of cart and line items after applying eligible promotions based on the selected promotion evaluation and execution method. |
| 3 | Promotion Reward Application API | Processes non-pricing rewards for customers after they select promotions and place their orders. |
Run Pricing Promotions with Coupons
| sequence | API | api USE | Considerations |
|---|---|---|---|
| 1 | Eligible Promotions API | Provides customers the details of the active coupons for their cart's eligible promotions. | N/A |
| 2 | Coupon Usage Increase API | Increases the overall usage count and the customer's usage count of the coupon | If the customer deselects the coupon after selecting it for their cart, use the Coupon Usage Decrease API to revert the coupon usage count. You can also use the Coupon Usage Decrease API for scenarios where a coupon must be reversed for failed or canceled transactions. |
| 3 | Promotion Evaluation and Execution API | Evaluates cart details and returns the adjusted price of cart and line items after applying eligible promotions based on the selected promotion evaluation and execution method. | The API is used only when Promotion Evaluation and Execution is enabled. |
| 4 | Promotion Reward Application API | Processes non-pricing rewards for customers after they select promotions and place their orders. | You can choose to not run the Coupon Usage Increase API. In this scenario, set the shouldCheckCouponUsageLimit parameter to True in the Promotion Reward Application API. The API checks the coupon's usage limit and then increases the coupon's usage. |
If you provide a member's details along with their related contact details, the APIs are run in the context of the member and not their contact.
