Unlock Discount Basket (Redemptions 2.0)
When reward locking is enabled in the Punchh Platform, the guest's discount basket must be locked. An external ID will be required to lock the discount basket to prevent other channels from creating simultaneous transactions or modifying the discount basket. In this mode, the guest's discount basket must be locked when discounts are applied to a transaction, using a unique identifier external_uid specific to the transaction generated by your application.
The external_uid ensures that no modifications or updates are allowed by any channel (e.g., POS terminals/devices, mobile, etc.) except the application that initially locked the discount basket with the external_uid. Contact your Punchh representative to update this Punchh platform configuration setting.
In some scenarios, such as where a transaction is cancelled or when the guest modifies the order after the basket is locked, the guest's discount basket needs to be unlocked so that transactions can be processed for the guest via other channels (e.g., POS terminals/devices, mobile, etc.). To unlock the discount basket, the external_uid must be passed in the API request along with the user-level access_token of the guest.
- Type: string
Accept requiredAdvertises which content types the client is able to understand
- Type: string
Authorization requiredYou may pass the access_token instead of the authentication_token in Online Ordering endpoints to authorize the request. It must be supplied as
Bearer ACCESS_TOKEN_GOES_HERE. Note: When authentication is performed using Advanced Authentication, you must include theid_tokenin theid-tokenheader and theaccess_tokenin theAuthorizationheader. See Access Punchh APIs Using Access and ID tokens - Type: string
Content - Type requiredSet this header to application/json.
- Type: string
User - Agent requiredFor details, see User Agent.
- Type: string
x -pch -digest requiredThe signature for the API call
- Type: string
id -token A token that contains identity information about the authenticated user. It is used to verify the user’s identity and is required only when authentication is performed using Advanced Authentication. This token alone does not grant access to Punchh APIs. To access the APIs, you must include the
id_tokenin theid-tokenheader and theaccess_tokenin theAuthorizationheader. See Access Punchh APIs Using Access and ID tokens
- Type: string
client requiredClient key of the business
- Type: string
external _uid requiredUnique identifier generated by the system to lock the discount basket to prevent duplicate transactions
200 OK - Discount Basket is unlocked successfully.
- Type: object
404 - Type: object
422