Code Redemption Callback
Overview
The Uniqodo redemption callback functionality is an extension to the Code Redemption API in that it enables an external endpoint to be called in real time whenever a code is redeemed using the Redemption API. This is particularly useful for notifying your marketing technology partners or any third-party system about a code redemption so that they can update their data in real time.
You do not need to integrate this extension, you simply supply the endpoint details to Uniqodo and your chosen data items will be sent to the endpoint when one of your promo codes is redeemed. You may need to build the endpoint into your backend systems if you do not already have one that can process such data.
Example Endpoint Details
https://myexample.endpoint.com/
POST https://myexample.endpoint.com
Content-Type: application/x-www-form-urlencoded
Host: myexample.endpoint.com
Content-Length: 73
code=<THE_REDEEMED_CODE>&orderId=<ORDER_ID>
e.g. code=45THD2L34K&orderId=447518457
Using the example above, a call will be made to https://myexample.endpoint.com/ with the parameters code=45THD2L34K&orderId=447518457 when the code 45THD2L34K is redeemed against the order ID 447518457.
Both POST and GET requests are supported. You can ask us to send any data item to the endpoint from the list of available redemption data shown in the table below. You also have the flexibility of deciding the parameter names in the request to your endpoint.
Available Redemption Data
Item | Description | Example |
id | A unique ID for the code redemption. | 126478 |
offerId | The ID of the offer/promotion associated with this code. | 1256 |
merchantId | The ID of the merchant redeeming the code. | 56 |
distributorId | The ID of the distributor that issued the code to the shopper. | 23 |
code | The code redeemed via the API call. | XY23T4DF |
orderValue | The value of the transaction excluding VAT. | 219.99 |
orderId | The id passed with the order value in the api call | ABC123456 |
currency | The currency of the transaction. | USD |
redeemedAt | The UTC date and time that the code redemption occurred. | 2015-05-29T10:39:17+0000 |
Code Distributors
Please contact clientsuccess@uniqodo.com to find out more.
