Issue Reward

Issues a reward certificate based on the member’s request or when the points in the member’s account reach a configurable threshold.
Note - A single reward is issued at a time.
When the redemptionChoice is set to ‘auto’, the points are automatically converted to rewards. When the redemptionChoice is ‘bank,’ the points are converted based on the member’s request.
Response of this endpoint includes a redemptionCode, which is required to redeem the reward in the future.

POST

redeem

reward

issue

curl --request POST \
  --url https://vanilla-dev02-loyalty.fabric.zone/api/v1/redeem/reward/issue \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "profileId": "67460e74-02e3-11e8-b443-00163e990bdb",
  "locationExternalReference": "Company_Club",
  "amountToRedeem": 50,
  "issueAuditUser": "Joe",
  "tierDiscountValue": 0
}'

{
  "status": 201,
  "message": "Created",
  "errors": "<any>",
  "data": {
    "rewardPointCost": 0.5,
    "rewardValue": 100,
    "rewardName": "Demo Reward",
    "redemptionCode": "c48e8827-2a72-4a0f-a4d2-2347b11b4f34"
  }
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Details needed to issue a variable reward

Response

200

application/json

The response is of type object.

Rewards History Redeem Rewards

curl --request POST \
  --url https://vanilla-dev02-loyalty.fabric.zone/api/v1/redeem/reward/issue \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "profileId": "67460e74-02e3-11e8-b443-00163e990bdb",
  "locationExternalReference": "Company_Club",
  "amountToRedeem": 50,
  "issueAuditUser": "Joe",
  "tierDiscountValue": 0
}'

{
  "status": 201,
  "message": "Created",
  "errors": "<any>",
  "data": {
    "rewardPointCost": 0.5,
    "rewardValue": 100,
    "rewardName": "Demo Reward",
    "redemptionCode": "c48e8827-2a72-4a0f-a4d2-2347b11b4f34"
  }
}