Get all redemption details
Use this endpoint to retrieve a list of redemption records. You can filter the records using parameters, such as couponCode, userId, email, orderId, or storeId.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.
24x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.
A unique identifier obtained from Copilot for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.
A unique request ID.
Query Parameters
The maximum number of records per page.
1 < x < 100Specifies the record from which the search will start, effectively skipping all records before this point.
1000Promotion 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:
ACTIVE: Refers to the created redemption records.INACTIVE: Refers to the redemption records that were 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 isn't 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 Was this page helpful?