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 /v1/redeem/reward/issue

Issue Reward

cURL

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,
  "tierDiscountValue": 0,
  "issueAuditUser": "Joe"
}
'

import requests

url = "https://vanilla-dev02-loyalty.fabric.zone/api/v1/redeem/reward/issue"

payload = {
    "profileId": "67460e74-02e3-11e8-b443-00163e990bdb",
    "locationExternalReference": "Company_Club",
    "amountToRedeem": 50,
    "tierDiscountValue": 0,
    "issueAuditUser": "Joe"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    profileId: '67460e74-02e3-11e8-b443-00163e990bdb',
    locationExternalReference: 'Company_Club',
    amountToRedeem: 50,
    tierDiscountValue: 0,
    issueAuditUser: 'Joe'
  })
};

fetch('https://vanilla-dev02-loyalty.fabric.zone/api/v1/redeem/reward/issue', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://vanilla-dev02-loyalty.fabric.zone/api/v1/redeem/reward/issue",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'profileId' => '67460e74-02e3-11e8-b443-00163e990bdb',
    'locationExternalReference' => 'Company_Club',
    'amountToRedeem' => 50,
    'tierDiscountValue' => 0,
    'issueAuditUser' => 'Joe'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://vanilla-dev02-loyalty.fabric.zone/api/v1/redeem/reward/issue"

	payload := strings.NewReader("{\n  \"profileId\": \"67460e74-02e3-11e8-b443-00163e990bdb\",\n  \"locationExternalReference\": \"Company_Club\",\n  \"amountToRedeem\": 50,\n  \"tierDiscountValue\": 0,\n  \"issueAuditUser\": \"Joe\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://vanilla-dev02-loyalty.fabric.zone/api/v1/redeem/reward/issue")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"profileId\": \"67460e74-02e3-11e8-b443-00163e990bdb\",\n  \"locationExternalReference\": \"Company_Club\",\n  \"amountToRedeem\": 50,\n  \"tierDiscountValue\": 0,\n  \"issueAuditUser\": \"Joe\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://vanilla-dev02-loyalty.fabric.zone/api/v1/redeem/reward/issue")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"profileId\": \"67460e74-02e3-11e8-b443-00163e990bdb\",\n  \"locationExternalReference\": \"Company_Club\",\n  \"amountToRedeem\": 50,\n  \"tierDiscountValue\": 0,\n  \"issueAuditUser\": \"Joe\"\n}"

response = http.request(request)
puts response.read_body

200

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

{
  "message": "Error message string",
  "errors": {
    "ExceptionString": [
      "Invalid Field"
    ]
  },
  "data": null,
  "status": 400
}

{
  "detail": "Authentication Failed"
}

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

profileId · string<uuid> · required

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"

locationExternalReference · string · required

External reference ID (or name) of the location where the points are being redeemed.

Minimum string length: 1

Example:

"Company_Club"

amountToRedeem · number<float> · required

Dollar amount being redeemed. Maximum amount which can be redeemed (or the reward limit) is configurable. When a member has $100 in their loyalty account and the store has a reward limit of $50, they can use two rewards certificates to redeem the amount fully.

Example:

50

tierDiscountValue · number<float> · required

Tier-based discounts can be offered by attaching members to different tiers, such as silver, gold, platinum, etc. Discount percentage or discount amounts can be customized.

Example:

0

issueAuditUser · string

Name of the representative who is issuing the reward.

Minimum string length: 1

Example:

"Joe"

Response

200

application/json

OK

status · integer<int32>

Status of the call

Example:

201

message · string · default: Exception message

Message corresponding to the call

Example:

"Created"

errors · any

Error details, if applicable

Example:

{}

data · object

Details of the points issued as reward.

Show child attributes