Previous Topic	Next Topic
Online Ordering Module 5: Redemptions Overview	Online Ordering Module 5b: Manage Items in the Discount Basket (Redemptions 2.0)

Online Ordering API Certification Tutorial - Module 5a: Process an Auto-Redemption (Redemptions 2.0)

Goal

Redemptions 2.0 - Add a discount to the discount basket automatically.

Prerequisites

In the Punchh platform, multiple redemptions must enabled for each business location:

1. Your Punchh representative enables and configures the Multiple Redemptions settings in the Punchh platform.

2. Go to Store Locations > All Store Locations and then choose the location(s).

3. Enable the Allow Location for Multiple Redemption option.

4. Click the Update button.

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.

Use Cases and Context

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. Redemptions 2.0 uses 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.

Note: Only one active basket will be associated with the guest at a time.

Auto-redemption is the capability to automatically add discounts to the basket so that the guest does not have to manually select the discounts. This allows rewards and subscription discounts to be redeemed without guest interaction. No other discount type can be auto redeemed. This means discounts will be queued up and, depending on the available limit of discounts, auto-applicable discounts will be added. If not set to a lower limit, the discount limit is a maximum of 10 redemptions for a single transaction. The auto-redemption feature must be enabled for the business in the Punchh platform, and the business can configure the auto-redemption strategy.

Note: Auto-redemption currently supports only subscriptions and non-points-based rewards.

Applicable API Endpoints


Endpoint Name/Path	Relevant Request Parameters	Relevant Response Parameters
Auto Redemption POST {server-name}/api/auth/discounts/auto_select	client access_token subtotal_amount transaction_no receipt_amount receipt_datetime The parameters under the line_items object: - item_name - item_qty - amount - item_type - item_id - item_family - item_group - serial_number	redemption_ref locked These parameters under the discount_basket_items object list the attributes of each discount in the active discount basket: - discount_type - discount_id - discount_value - discount_basket_item_id - created_at - discount_details object

Workflow

The Auto Redemption API call returns a detailed list of discount basket items that have been automatically added to the discount basket based on the configuration settings for the business. For each item in the discount basket, the discount_details response parameter includes information such as the item ID, item name, number of points, etc. A unique ID associated with the discount basket is stored in the redemption_ref parameter in the API response. Save this in your system for future reference. You will need the redemption_ref if you want to void the discount basket.

Note: Only one active basket will be associated with the guest at a time.

Best Practices

We do not recommend sending the D (discount), T (tax), and P (payment) values in the item_type parameter for Redemptions 2.0 API calls. Instead, send them in check-in API calls, such as Create Loyalty Check-in and Update Loyalty Check-in.

For example, if a business offers a $2 discount on a $10 burger, send the burger as $8 ($10 - $2) in the API request. Send the discount as a line item in the Check-in API call.

If you must send D, T, and P menu item types, you must configure an exclusion qualification criterion (QC) for the offer in the Punchh platform. Create an exclusion filter using item types D, T, and P to ensure they are properly excluded. See the Qualification Criteria article on the Support Portal.

Note: To view the Punchh product documentation on the Punchh Support Portal, you must log in to a Punchh platform production environment. If you already have access to a production environment, follow the instructions here to access the Punchh Support Portal.