| Previous Topic | Next Topic |
|---|---|
| Online Ordering Module 4: Update User Profile | Online Ordering Module 6: Check-in |
Online Ordering API Certification Tutorial - Module 5: Redemptions Overview
When implementing redemptions for your business, you need to determine whether to use Redemptions 1.0 (legacy Punchh redemptions framework) or Redemptions 2.0 (new Punchh redemptions framework). Any new integration work involving redemptions should use Redemptions 2.0 unless there is a dependency integration (such as an existing POS integration) that does not currently support Redemptions 2.0. If such a dependency exists, you should use Redemptions 1.0.
Redemptions 2.0 enables several new Punchh features, such as multiple redemptions, single scan flow, auto-redemption, proportional discounting, stacked discounting, item qualifier recycling, and enhanced flexibility to redemption processing orders. The key differentiator with Redemptions 2.0 is support for multiple redemptions, enabling guests to apply multiple discounts on a single transaction. This enhanced flexibility for businesses to design and implement unique discounting structures provides guests with greater savings and a more personalized redemption journey.
The Redemptions 2.0 APIs use the concept of a discount basket, which is a persisted object created by web/mobile for selecting available rewards to redeem in the next transaction. The Redemptions 2.0 API that enables “batched” processing of redemptions is used for determining possible redemptions and for processing multiple redemptions based on the items in the discount basket.
The following tables list the tutorial modules for Redemptions 2.0 (new) and Redemptions 1.0 (legacy).
Note: The Redemptions 2.0 protocol is not backward compatible with the legacy Redemptions 1.0 endpoints. Configurations within the Punchh platform are required, so please contact your Punchh representative for help before starting development.
Redemptions 2.0 API (New) Tutorial Modules - Sequence and Goals
| Tutorial Modules - Redemptions 2.0 | Goal |
| Module 5a: Process an Auto-Redemption (Redemptions 2.0) | Add a discount to the discount basket automatically. |
| Module 5b: Manage Items in the Discount Basket (Redemptions 2.0) | Add items to or remove items from a guest’s discount basket. |
| Module 5c: Get the Active Discount Basket (Redemptions 2.0) | Get a list of discounts that have been selected by a guest. |
| Module 5d: Process/Create a Batch Redemption (Redemptions 2.0) | Process a batch redemption with the appropriate discount type(s). |
| Module 5e: Void the Discount Basket (Redemptions 2.0) | Void the complete discount basket. |
Redemptions 1.0 API (Legacy) Tutorial Modules - Sequence and Goals
| Tutorial Modules - Redemptions 1.0 | Goal |
| Module 5a: Process/Create Redemption (Redemptions 1.0) | Process redemptions with the appropriate reward type. |
| Module 5b: Show Applicable Offers (Redemptions 1.0) | Display available offers based on a user's current cart. |
| Module 5c: Voiding Redemptions (Redemptions 1.0) | Void a redemption that has already been processed/committed. |