POST
/
coupons
/
{couponId}
/
redemptions

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id
string
required

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.

Required string length: 24
x-fabric-channel-id
string

x-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.

x-client-id
string

A unique identifier obtained from Copilot for the System app in the fabric ecosystem, essential for OpenID Connect authentication flows.

x-fabric-request-id
string

A unique request ID.

Path Parameters

couponId
string
required

A 24-character system-generated coupon ID.

Body

application/json

Coupon redemption details

couponCode
string
required

Coupon code to be redeemed

orderId
string
required

Purchase order ID associated with the coupon redemption

userId
string | null

ID of the user who redeems the coupon

email
string | null

Email address of the user who redeems the coupon

Response

201 - application/json

Coupon's redemption details

id
string
required

A 24-character system-generated redemption ID.

couponId
string
required

A 24-character system-generated coupon ID.

couponCode
string
required

Coupon code to redeem

orderId
string
required

Purchase order ID associated with the coupon redemption

userId
string

ID of the user who redeems the coupon

email
string | null

Email address of the user who redeems the coupon

createdAt
string

Redemption's creation time

updatedAt
string

Redemption's last updated time

Was this page helpful?

OverviewCreate redemption