POST
/
v1
/
redeem
/
member-reward
curl --request POST \
  --url https://vanilla-dev02-loyalty.fabric.zone/api/v1/redeem/member-reward \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "profileId": "67460e74-02e3-11e8-b443-00163e990bdb",
  "redemptionCode": "04c229d7-03cb-421f-9d77-1c0ff1fc2641",
  "locationExternalReference": "Company_Club",
  "redeemAuditUser": "Joe"
}'
{
  "status": 200,
  "message": "Redeem Member Reward succeed.",
  "errors": {},
  "data": "<any>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Reward details

​
redemptionCode
string
required

Redemption code. This code must be specified. Redemption code is generated in the response of the Issue Variable Rewards (POST /api/v1/redeem/reward/issue) endpoint.

Example:

"04c229d7-03cb-421f-9d77-1c0ff1fc2641"

​
locationExternalReference
string
required

Represents the store where the rewards are being redeemed. Each store (online, physical or POS) has a unique locationExternalReference name or ID.

Minimum length: 1
Example:

"Company_Club"

​
profileId
string

Profile ID of the member. In an ecosystem, it acts as a primary ID to keep the various systems (apps, websites, etc.) in sync.

Example:

"67460e74-02e3-11e8-b443-00163e990bdb"

​
redeemAuditUser
string

Representative who is issuing the reward redemption.

Minimum length: 1
Example:

"Joe"

Response

200
application/json
OK

Response (metadata) of redeemed rewards

​
status
integer

Status of the call

Example:

200

​
message
string
default:Exception message

Message corresponding to the call

Minimum length: 1
Example:

"Redeem Member Reward succeed."

​
errors
object

Error details, if applicable

Example:
{}
​
data
any

Reward details, if applicable

Was this page helpful?

Issue RewardCancel Rewards