Get all redemption details
Use this endpoint to get a list of redemption records. You can also filter the records by using different parameters, such as coupon code, user ID, email address, order ID, store ID, and more.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Merchant's 24-character tenant ID
The sales channel ID.
The platform where the request is made.
A unique request ID.
Query Parameters
The maximum number of records per page.
Specifies the record from which the search will start, effectively skipping all records before this point.
Promotion ID for which you want to get the redemption records
Coupon code for which you want to get the redemption records
ID of the user for whom you want to get the redemption records
Email address of the user for whom you want to get the redemption records
Order ID associated with the redemption records
Comma-separated IDs of the stores for which you want to get the redemption records
Status by which you want to filter the redemption records. The options are:<br>ACTIVE: Refers to the created redemption records.<br>INACTIVE: Refers to the redemption records that are generated but are inactive due to order cancellations.
ACTIVE, INACTIVE If specified, it returns the redemption records that are created from this specific date
If specified, it returns the created redemption records till this specific date
If specified, it returns the redemption records that are updated from this specific date
If specified, it returns the updated redemption records till this specific date
Additional attributes to filter redemption records
Promotion-specific additional attributes to filter redemption records
Promotion name by which you want to filter the redemption records
This boolean query parameter is used to filter for redemptions associated with either implicit or non-implicit promotions. If the filter is not provided, the response will include all redemptions.
Filter that indicates if the redemptions will belong to SINGLE or MULTI use coupon. If not sent, all redemptions will be returned.
SINGLE_USE, MULTI_USE Response
The pagination details.
Redemptions list
Was this page helpful?