redeemFlexible

Redeem a flexible reward, where the customer chooses how much of their balance to spend and the server generates a discount for that amount. This powers “choose your own discount” rewards in points mode, and it is the only redemption path on store-credit shops.

Usage

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

Parameters

rewardId

string

required

The ID of a flexible reward (one whose redemptionMode is "flexible"). Get reward IDs from getShopRewards.

pointsToRedeem

number

required

The amount to spend, in the shop’s loyalty unit (points, or minor currency units in store-credit mode). Must fall within the reward’s flexibleConfig.minPoints and flexibleConfig.maxPoints.

Response

success

boolean

Whether the redemption was successful.

data.customerReward

object

The created reward record.

Show Customer reward properties

string

The customer reward ID.

discountCode

string

The generated Shopify discount code.

data.discountAmount

number

The cash value of the generated discount, in major currency units.

data.pointsRedeemed

number

The amount deducted from the customer’s balance.

data.updatedPoints

number

The customer’s remaining balance after redemption.

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, or the reward is not flexible

Sample response

{
  "success": true,
  "data": {
    "customerReward": {
      "id": "cr_def456",
      "discountCode": "MAGE-FLEX-ABC"
    },
    "discountAmount": 3,
    "pointsRedeemed": 300,
    "updatedPoints": 150
  }
}

Example: Choose-your-own-amount slider

<input type="range" id="amount" min="100" max="500" step="100" value="300" />
<span id="preview"></span>
<button id="redeem-flex" data-reward-id="reward_abc">Redeem</button>

<script>
  document.getElementById('redeem-flex').addEventListener('click', function() {
    var rewardId = this.getAttribute('data-reward-id');
    var amount = Number(document.getElementById('amount').value);

    MageSDK.redeemFlexible(rewardId, amount).then(function(resp) {
      if (resp.success) {
        alert('Your discount code: ' + resp.data.customerReward.discountCode);
      } else {
        alert('Error: ' + resp.error);
      }
    });
  });
</script>

JavaScript SDK

Methods

Usage

Parameters

Response

Errors

Sample response

Example: Choose-your-own-amount slider

​Usage

​Parameters

​Response

​Errors

​Sample response

​Example: Choose-your-own-amount slider

Usage

Parameters

Response

Errors

Sample response

Example: Choose-your-own-amount slider