FAfabric
Redemption

Create redemption

Enables you to create a redemption record

post/api-offers/redemption

Request

Headers

x-site-contextstring required
Example:{"date": "2023-01-01T00:00:00.000Z", "channel": 12, "account": "1234abcd5678efgh9ijklmno","stage":"production"}

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.

Request body

promoIdstring required

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

promoCodestring nullable

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

userIdstring nullable

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

emailstring

Email address of the user who redeem the promotion

orderIdstring required

Order ID of this purchase

Example request

{
  "promoId": "614b58924e92f6861ac91234",
  "promoCode": "BESTSUMMER",
  "userId": "614b58924e92f61234567890",
  "email": "john.doe@gmail.com",
  "orderId": "1590-2016-12345"
}

Response

OK

_idstring

fabric internal ID

promoIdstring

fabric database objectId of the promotion to redeem

promoCodestring

promoCode of the coupon that is redeemed

userIdstring

ID of the user who redeem the coupon

emailstring

Email address of the user who redeem the coupon

orderIdstring

Order ID of this purchase

createdAtstring date-time

Creation date of the record

updatedAtstring date-time

Last updated date of the record

Example response

{
  "_id": "614b58924e92f6861ac9d43b",
  "promoId": "614b58924e92f6861ac91234",
  "promoCode": "BESTSUMMER",
  "userId": "614b58924e92f61234567890",
  "email": "guest@gmail.com",
  "orderId": "1590-2016-12345",
  "createdAt": "2020-12-14T12:15:43.646Z",
  "updatedAt": "2021-12-14T12:15:43.646Z"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.