Previous Topic	Next Topic
Online Ordering Module 5d: Process/Create a Batch Redemption (Redemptions 2.0)	Online Ordering Module 6: Check-in

Online Ordering API Certification Tutorial - Module 5e: Void the Discount Basket (Redemptions 2.0)

Goal

Redemptions 2.0 - Void the complete discount basket.

Prerequisites

You must have read the Online Ordering Module 5b: Manage Items in the Discount Basket, Online Ordering Module 5c: Get the Active Discount Basket, and Online Ordering Module 5d: Process/Create a Batch Redemption tutorials.

Use Cases and Context

A guest wants to cancel an order and return one or more processed redemptions applied on the check/cart after they have been committed. The rewards are returned to the guest account after the discount basket is voided successfully.

A guest submits an order but then decides to use a different reward for that submitted order. The guest can cancel the order while it is in flight, the Void Redemption API can be called to void the discount basket, and the user can create a new discount basket. Void Redemption is a real-time/synchronous call. Once the void is successful, the voided points/rewards can immediately be reused.

Note: The value of redemption_ref must be appended to the URL path of the Void Redemption API. You can get the redemption_ref value from the response of the Get Active Discount Basket API or the Batch Redemption Process API.

Applicable API Endpoints


Endpoint Name/Path	Relevant Request Parameters	Relevant Response Parameters
Void Redemption DELETE {server-name}/api/auth/batch_redemptions/{redemption_ref}	client access_token	N/A

Workflow

The Void Redemption API endpoint voids the complete discount basket using the redemption_ref and returns the offers tied to the discount basket to the loyalty guest’s account after the discount basket is voided successfully. Redemptions have no time limit and can be voided at any time.