Skip to main content
POST
/
api-offers
/
redemption
Create redemption
curl --request POST \
  --url https://live.copilot.fabric.inc/api-offers/redemption \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "promoId": "614b58924e92f6861ac91234",
  "orderId": "1590-2016-12345",
  "promoCode": "BESTSUMMER",
  "userId": "614b58924e92f61234567890",
  "email": "[email protected]"
}
'
{
  "_id": "614b58924e92f6861ac9d43b",
  "promoId": "614b58924e92f6861ac91234",
  "promoCode": "BESTSUMMER",
  "userId": "614b58924e92f61234567890",
  "email": "[email protected]",
  "orderId": "1590-2016-12345",
  "createdAt": "2020-12-14T12:15:43.646Z",
  "updatedAt": "2021-12-14T12:15:43.646Z"
}

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.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json
​
promoId
string
required

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

Example:

"614b58924e92f6861ac91234"

​
orderId
string
required

Order ID of this purchase

Example:

"1590-2016-12345"

​
promoCode
string | null

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

Example:

"BESTSUMMER"

​
userId
string | null

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

Example:

"614b58924e92f61234567890"

​
email
string

Email address of the user who redeem the promotion

Example:

"[email protected]"

Response

OK

​
_id
string

fabric internal ID

Example:

"614b58924e92f6861ac9d43b"

​
promoId
string

fabric database objectId of the promotion to redeem

Example:

"614b58924e92f6861ac91234"

​
promoCode
string

promoCode of the coupon that is redeemed

Example:

"BESTSUMMER"

​
userId
string

ID of the user who redeem the coupon

Example:

"614b58924e92f61234567890"

​
email
string

Email address of the user who redeem the coupon

Example:

"[email protected]"

​
orderId
string

Order ID of this purchase

Example:

"1590-2016-12345"

​
createdAt
string<date-time>

Creation date of the record

Example:

"2020-12-14T12:15:43.646Z"

​
updatedAt
string<date-time>

Last updated date of the record

Example:

"2021-12-14T12:15:43.646Z"