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

Merchant's 24-character tenant ID

x-fabric-channel-id
string

The sales channel ID.

x-client-id
string

The platform where the request is made.

x-fabric-request-id
string

A unique request ID.

Path Parameters

couponId
string
required

A 24-character system-generated coupon ID.

Body

application/json
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
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