Create redemption
Creates a redemption for a specific promotion using the corresponding promotionId value in the request body.
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.
Body
Redemption details
ID of the promotion to which the coupon code belongs
Purchase order ID associated with the redemption
Coupon code to be redeemed
ID of the user who redeems the coupon
Email address of the user who redeems the coupon
ID of the store where the coupon is redeemed
The timestamp in UTC format for when the coupon was redeemed.
Merchant-specified attributes associated with the redemption
Response
Coupon's redemption details
System-generated redemption ID
ID of the promotion to which the coupon code belongs
Purchase order ID associated with the redemption
The timestamp in UTC format of when the coupon redemption was created.
The timestamp in UTC format of when the coupon redemption was last updated.
Redeemed coupon code
ID of the user who redeems the coupon
Email address of the user who redeems the coupon
ID of the store where the coupon is redeemed
The timestamp in UTC format for when the coupon was redeemed.
The following are redemption statuses:
ACTIVE: Represents created redemption records.INACTIVE: Represents redemption records that were created but became inactive due to order cancellation.
INACTIVE, ACTIVE Merchant-specified attributes associated with the redemption
Merchant-specified attributes associated with the related promotion. This value is automatically populated according to the attributes of the related promotion.
Promotion name by which you want to filter the redemption records
Was this page helpful?