POST
/
api-offers
/
redemption

Authorizations

Authorization
string
headerrequired

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
promoId
string
required

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

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

email
string

Email address of the user who redeem the promotion

orderId
string
required

Order ID of this purchase

Response

200 - application/json
_id
string

fabric internal ID

promoId
string

fabric database objectId of the promotion to redeem

promoCode
string

promoCode of the coupon that is redeemed

userId
string

ID of the user who redeem the coupon

email
string

Email address of the user who redeem the coupon

orderId
string

Order ID of this purchase

createdAt
string

Creation date of the record

updatedAt
string

Last updated date of the record

Was this page helpful?

OverviewDelete specific redemption record