redeemReward

Redeem a fixed-cost reward for the currently logged-in customer. Deducts the reward’s cost from their balance and generates a Shopify discount code.

This method is for fixed rewards. For flexible rewards (where the customer chooses an amount) use redeemFlexible. On store-credit shops fixed-cost redemption is disabled, so redeemFlexible is the only redemption path. See Loyalty modes.

Usage

MageSDK.redeemReward('reward_abc').then(function(resp) {
  if (resp.success) {
    console.log('Discount code:', resp.data.discountCode);
  } else {
    console.log('Error:', resp.error);
  }
});

Parameters

string

required

The ID of the reward to redeem. You can get reward IDs from getShopRewards.

Response

boolean

Whether the redemption was successful.

string

The generated Shopify discount code.

object

A summary of the redeemed reward.

Show Reward properties

string

Name of the reward.

string | null

Type of discount applied, or null.

object

The full customer reward record that was created, including id, status, expiresAt, and the discount code. Same shape as an entry from getCustomerRewards.

Errors

Error	Cause
`"Customer not found"`	Customer is not logged in or not enrolled
`"Insufficient points"`	Customer does not have enough balance
`"Reward not found"`	The reward ID is invalid
`"This reward cannot be redeemed in store credit mode"`	The shop runs on store credit. Use redeemFlexible

Example: Redeem button

<button id="redeem-btn" data-reward-id="reward_abc">
  Redeem 500 points for £5 off
</button>

<script>
  document.getElementById('redeem-btn').addEventListener('click', function() {
    var rewardId = this.getAttribute('data-reward-id');
    MageSDK.redeemReward(rewardId).then(function(resp) {
      if (resp.success) {
        alert('Your discount code: ' + resp.data.discountCode);
      } else {
        alert('Error: ' + resp.error);
      }
    });
  });
</script>

JavaScript SDK

Methods

Usage

Parameters

Response

Errors

Example: Redeem button

​Usage

​Parameters

​Response

​Errors

​Example: Redeem button

Usage

Parameters

Response

Errors

Example: Redeem button