Create redemption

Enables you to create a redemption record

Authorizations

Authorization

string

header

required

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

Headers

x-site-context

string

required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Body

application/json

orderId

string

required

Order ID of this purchase

promoId

string

required

fabric database objectId of the promotion to redeem, received from promotion structure

email

string

Email address of the user who redeem the promotion

promoCode

string | null

promoCode of the coupon that is redeemed, could be null if no promoCode available

userId

string | null

ID of the user who redeem the promotion, could be null if no user ID available

Response

200 - application/json

_id

string

fabric internal ID

createdAt

string

Creation date of the record

email

string

Email address of the user who redeem the coupon

orderId

string

Order ID of this purchase

promoCode

string

promoCode of the coupon that is redeemed

promoId

string

fabric database objectId of the promotion to redeem

updatedAt

string

Last updated date of the record

userId

string

ID of the user who redeem the coupon