Redemptions & Discount Codes
Return an unused reward for its points
Cancels one of the authenticated customer’s redeemed discount codes and credits the redeemed points back.
Only available when the merchant enabled “Let customers return unused rewards” in Advanced Settings. The reward must belong to the authenticated customer, be UNUSED, not expired, bought with points (not store credit or a gifted VIP/birthday/referral reward), and Shopify must report the code was never used. The discount code is removed from Shopify before the points are credited.
Returns the updated customer loyalty details, like redeem-points.
POST
/
loyalty
/
cp
/
api
/
return-reward
/
{rewardId}
Return an unused reward for its points
curl --request POST \
--url https://{storeDomain}/apps/loyalty/cp/api/return-reward/{rewardId}import requests
url = "https://{storeDomain}/apps/loyalty/cp/api/return-reward/{rewardId}"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://{storeDomain}/apps/loyalty/cp/api/return-reward/{rewardId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://{storeDomain}/apps/loyalty/cp/api/return-reward/{rewardId}';
const options = {method: 'POST'};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{storeDomain}/apps/loyalty/cp/api/return-reward/{rewardId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{storeDomain}/apps/loyalty/cp/api/return-reward/{rewardId}"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://{storeDomain}/apps/loyalty/cp/api/return-reward/{rewardId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"achievableTierId": 123,
"availablePoints": 123,
"createAt": "2023-11-07T05:31:56Z",
"creditedPoints": 123,
"currentVipTier": "<string>",
"customerStatus": "ACTIVE",
"dob": "2023-12-25",
"dobYearProvided": true,
"expiringPointsAmount": 123,
"pendingPoints": 123,
"pointsExpireAt": "2023-11-07T05:31:56Z",
"referralLink": "<string>",
"referredCompleted": 123,
"rewardedForCreatingAccount": true,
"rewardedForFacebook": true,
"rewardedForInstagram": true,
"rewardedForNewsLetter": true,
"rewardedForPinterest": true,
"rewardedForSharingOnFacebook": true,
"rewardedForSharingOnX": true,
"rewardedForSms": true,
"rewardedForTiktok": true,
"rewardedForTwitter": true,
"rewardedForYoutube": true,
"rewards": [
{
"createAt": "2023-11-07T05:31:56Z",
"customerId": 123,
"discountCode": "<string>",
"shop": "<string>",
"status": "USED",
"activeFrom": "2023-11-07T05:31:56Z",
"amount": 123,
"description": "<string>",
"discountCodeId": "<string>",
"expireDate": "2023-11-07T05:31:56Z",
"id": 123,
"lastExpiryReminderSentDate": "2023-11-07T05:31:56Z",
"orderId": 123,
"orderName": "<string>",
"pointRedeemRuleId": 123,
"pointTransactionId": 123,
"productData": "<string>",
"rewardType": "STORE_CREDIT",
"usageCount": 123,
"usedAt": "2023-11-07T05:31:56Z",
"variantId": 123
}
],
"spentAmount": 123,
"storeCreditBalance": 123,
"storeCreditCurrency": "<string>",
"vipTierExpiredAt": "2023-11-07T05:31:56Z",
"vipTierSpentAmount": 123
}{
"achievableTierId": 123,
"availablePoints": 123,
"createAt": "2023-11-07T05:31:56Z",
"creditedPoints": 123,
"currentVipTier": "<string>",
"customerStatus": "ACTIVE",
"dob": "2023-12-25",
"dobYearProvided": true,
"expiringPointsAmount": 123,
"pendingPoints": 123,
"pointsExpireAt": "2023-11-07T05:31:56Z",
"referralLink": "<string>",
"referredCompleted": 123,
"rewardedForCreatingAccount": true,
"rewardedForFacebook": true,
"rewardedForInstagram": true,
"rewardedForNewsLetter": true,
"rewardedForPinterest": true,
"rewardedForSharingOnFacebook": true,
"rewardedForSharingOnX": true,
"rewardedForSms": true,
"rewardedForTiktok": true,
"rewardedForTwitter": true,
"rewardedForYoutube": true,
"rewards": [
{
"createAt": "2023-11-07T05:31:56Z",
"customerId": 123,
"discountCode": "<string>",
"shop": "<string>",
"status": "USED",
"activeFrom": "2023-11-07T05:31:56Z",
"amount": 123,
"description": "<string>",
"discountCodeId": "<string>",
"expireDate": "2023-11-07T05:31:56Z",
"id": 123,
"lastExpiryReminderSentDate": "2023-11-07T05:31:56Z",
"orderId": 123,
"orderName": "<string>",
"pointRedeemRuleId": 123,
"pointTransactionId": 123,
"productData": "<string>",
"rewardType": "STORE_CREDIT",
"usageCount": 123,
"usedAt": "2023-11-07T05:31:56Z",
"variantId": 123
}
],
"spentAmount": 123,
"storeCreditBalance": 123,
"storeCreditCurrency": "<string>",
"vipTierExpiredAt": "2023-11-07T05:31:56Z",
"vipTierSpentAmount": 123
}{
"achievableTierId": 123,
"availablePoints": 123,
"createAt": "2023-11-07T05:31:56Z",
"creditedPoints": 123,
"currentVipTier": "<string>",
"customerStatus": "ACTIVE",
"dob": "2023-12-25",
"dobYearProvided": true,
"expiringPointsAmount": 123,
"pendingPoints": 123,
"pointsExpireAt": "2023-11-07T05:31:56Z",
"referralLink": "<string>",
"referredCompleted": 123,
"rewardedForCreatingAccount": true,
"rewardedForFacebook": true,
"rewardedForInstagram": true,
"rewardedForNewsLetter": true,
"rewardedForPinterest": true,
"rewardedForSharingOnFacebook": true,
"rewardedForSharingOnX": true,
"rewardedForSms": true,
"rewardedForTiktok": true,
"rewardedForTwitter": true,
"rewardedForYoutube": true,
"rewards": [
{
"createAt": "2023-11-07T05:31:56Z",
"customerId": 123,
"discountCode": "<string>",
"shop": "<string>",
"status": "USED",
"activeFrom": "2023-11-07T05:31:56Z",
"amount": 123,
"description": "<string>",
"discountCodeId": "<string>",
"expireDate": "2023-11-07T05:31:56Z",
"id": 123,
"lastExpiryReminderSentDate": "2023-11-07T05:31:56Z",
"orderId": 123,
"orderName": "<string>",
"pointRedeemRuleId": 123,
"pointTransactionId": 123,
"productData": "<string>",
"rewardType": "STORE_CREDIT",
"usageCount": 123,
"usedAt": "2023-11-07T05:31:56Z",
"variantId": 123
}
],
"spentAmount": 123,
"storeCreditBalance": 123,
"storeCreditCurrency": "<string>",
"vipTierExpiredAt": "2023-11-07T05:31:56Z",
"vipTierSpentAmount": 123
}Path Parameters
ID of the customer's reward to return
Response
Reward cancelled and points returned
Available options:
ACTIVE, INACTIVE, EXCLUDED, EXCLUDED_BY_CUSTOMER Show child attributes
Show child attributes
⌘I
Return an unused reward for its points
curl --request POST \
--url https://{storeDomain}/apps/loyalty/cp/api/return-reward/{rewardId}import requests
url = "https://{storeDomain}/apps/loyalty/cp/api/return-reward/{rewardId}"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://{storeDomain}/apps/loyalty/cp/api/return-reward/{rewardId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const url = 'https://{storeDomain}/apps/loyalty/cp/api/return-reward/{rewardId}';
const options = {method: 'POST'};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{storeDomain}/apps/loyalty/cp/api/return-reward/{rewardId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{storeDomain}/apps/loyalty/cp/api/return-reward/{rewardId}"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}require 'uri'
require 'net/http'
url = URI("https://{storeDomain}/apps/loyalty/cp/api/return-reward/{rewardId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"achievableTierId": 123,
"availablePoints": 123,
"createAt": "2023-11-07T05:31:56Z",
"creditedPoints": 123,
"currentVipTier": "<string>",
"customerStatus": "ACTIVE",
"dob": "2023-12-25",
"dobYearProvided": true,
"expiringPointsAmount": 123,
"pendingPoints": 123,
"pointsExpireAt": "2023-11-07T05:31:56Z",
"referralLink": "<string>",
"referredCompleted": 123,
"rewardedForCreatingAccount": true,
"rewardedForFacebook": true,
"rewardedForInstagram": true,
"rewardedForNewsLetter": true,
"rewardedForPinterest": true,
"rewardedForSharingOnFacebook": true,
"rewardedForSharingOnX": true,
"rewardedForSms": true,
"rewardedForTiktok": true,
"rewardedForTwitter": true,
"rewardedForYoutube": true,
"rewards": [
{
"createAt": "2023-11-07T05:31:56Z",
"customerId": 123,
"discountCode": "<string>",
"shop": "<string>",
"status": "USED",
"activeFrom": "2023-11-07T05:31:56Z",
"amount": 123,
"description": "<string>",
"discountCodeId": "<string>",
"expireDate": "2023-11-07T05:31:56Z",
"id": 123,
"lastExpiryReminderSentDate": "2023-11-07T05:31:56Z",
"orderId": 123,
"orderName": "<string>",
"pointRedeemRuleId": 123,
"pointTransactionId": 123,
"productData": "<string>",
"rewardType": "STORE_CREDIT",
"usageCount": 123,
"usedAt": "2023-11-07T05:31:56Z",
"variantId": 123
}
],
"spentAmount": 123,
"storeCreditBalance": 123,
"storeCreditCurrency": "<string>",
"vipTierExpiredAt": "2023-11-07T05:31:56Z",
"vipTierSpentAmount": 123
}{
"achievableTierId": 123,
"availablePoints": 123,
"createAt": "2023-11-07T05:31:56Z",
"creditedPoints": 123,
"currentVipTier": "<string>",
"customerStatus": "ACTIVE",
"dob": "2023-12-25",
"dobYearProvided": true,
"expiringPointsAmount": 123,
"pendingPoints": 123,
"pointsExpireAt": "2023-11-07T05:31:56Z",
"referralLink": "<string>",
"referredCompleted": 123,
"rewardedForCreatingAccount": true,
"rewardedForFacebook": true,
"rewardedForInstagram": true,
"rewardedForNewsLetter": true,
"rewardedForPinterest": true,
"rewardedForSharingOnFacebook": true,
"rewardedForSharingOnX": true,
"rewardedForSms": true,
"rewardedForTiktok": true,
"rewardedForTwitter": true,
"rewardedForYoutube": true,
"rewards": [
{
"createAt": "2023-11-07T05:31:56Z",
"customerId": 123,
"discountCode": "<string>",
"shop": "<string>",
"status": "USED",
"activeFrom": "2023-11-07T05:31:56Z",
"amount": 123,
"description": "<string>",
"discountCodeId": "<string>",
"expireDate": "2023-11-07T05:31:56Z",
"id": 123,
"lastExpiryReminderSentDate": "2023-11-07T05:31:56Z",
"orderId": 123,
"orderName": "<string>",
"pointRedeemRuleId": 123,
"pointTransactionId": 123,
"productData": "<string>",
"rewardType": "STORE_CREDIT",
"usageCount": 123,
"usedAt": "2023-11-07T05:31:56Z",
"variantId": 123
}
],
"spentAmount": 123,
"storeCreditBalance": 123,
"storeCreditCurrency": "<string>",
"vipTierExpiredAt": "2023-11-07T05:31:56Z",
"vipTierSpentAmount": 123
}{
"achievableTierId": 123,
"availablePoints": 123,
"createAt": "2023-11-07T05:31:56Z",
"creditedPoints": 123,
"currentVipTier": "<string>",
"customerStatus": "ACTIVE",
"dob": "2023-12-25",
"dobYearProvided": true,
"expiringPointsAmount": 123,
"pendingPoints": 123,
"pointsExpireAt": "2023-11-07T05:31:56Z",
"referralLink": "<string>",
"referredCompleted": 123,
"rewardedForCreatingAccount": true,
"rewardedForFacebook": true,
"rewardedForInstagram": true,
"rewardedForNewsLetter": true,
"rewardedForPinterest": true,
"rewardedForSharingOnFacebook": true,
"rewardedForSharingOnX": true,
"rewardedForSms": true,
"rewardedForTiktok": true,
"rewardedForTwitter": true,
"rewardedForYoutube": true,
"rewards": [
{
"createAt": "2023-11-07T05:31:56Z",
"customerId": 123,
"discountCode": "<string>",
"shop": "<string>",
"status": "USED",
"activeFrom": "2023-11-07T05:31:56Z",
"amount": 123,
"description": "<string>",
"discountCodeId": "<string>",
"expireDate": "2023-11-07T05:31:56Z",
"id": 123,
"lastExpiryReminderSentDate": "2023-11-07T05:31:56Z",
"orderId": 123,
"orderName": "<string>",
"pointRedeemRuleId": 123,
"pointTransactionId": 123,
"productData": "<string>",
"rewardType": "STORE_CREDIT",
"usageCount": 123,
"usedAt": "2023-11-07T05:31:56Z",
"variantId": 123
}
],
"spentAmount": 123,
"storeCreditBalance": 123,
"storeCreditCurrency": "<string>",
"vipTierExpiredAt": "2023-11-07T05:31:56Z",
"vipTierSpentAmount": 123
}