getShopRewards

Retrieve all rewards configured for the shop, split into regular rewards and tiered rewards (rewards locked behind VIP tiers). The response also carries the shop’s loyalty mode and currency so you can format costs correctly.

Usage

MageSDK.getShopRewards().then(function(resp) {
  if (resp.success) {
    console.log(resp.data.regularRewards);
    console.log(resp.data.tieredRewards);
  }
});

Response

boolean

Whether the request was successful.

array

Rewards available to all customers.

Show Reward properties

string

The reward ID.

string

Display name of the reward.

string

Description of what the reward provides.

array

Requirement lines to render under the description, each { type, text } (for example a minimum spend note).

number

Cost to redeem, in the shop’s loyalty unit. For flexible rewards this is the starting or minimum cost.

string

Reward category (e.g. "fixed", "percentage", "free_shipping").

string | null

Type of discount applied.

number | null

Raw discount value from the reward (fixed amount or percentage), or null for types without a scalar value.

string | null

URL of the reward icon, or null.

string

"fixed" (spend a set cost) or "flexible" (the customer chooses an amount). Flexible rewards redeem through redeemFlexible.

object | null

Present for flexible rewards. Defines the redemption bounds.

Show Flexible config properties

number

Cash discount produced per perPoints spent.

number

The points unit the conversionRate applies to.

number

Minimum amount the customer can redeem.

number

Maximum amount the customer can redeem.

string

"ONE_TIME", "SUBSCRIPTION", or "BOTH". Gates whether the reward can apply to a subscription.

number | null

For subscription discounts, the number of renewals the discount applies to. null means all renewals.

object | null

VIP tier required to redeem, or null if available to all.

string | null

Formatted minimum spend required to use the discount.

object | null

Product or collection metadata for free-product rewards, or null for non-product rewards.

array

Rewards restricted to specific VIP tiers. Same shape as regularRewards.

string

The shop’s currency symbol, e.g. "$".

string | null

The subscription app powering “apply to subscription”, or null when none is connected.

string

"points" or "store_credit". In store-credit mode pointsCost values are minor currency units. See Loyalty modes.

string

The shop’s ISO currency code.

Sample response

{
  "success": true,
  "data": {
    "regularRewards": [
      {
        "id": "reward_abc",
        "name": "£5 off your next order",
        "description": "£5 off your order",
        "descriptionRequirements": [],
        "pointsCost": 500,
        "category": "fixed",
        "discountType": "fixed",
        "discountAmount": 5,
        "iconUrl": null,
        "redemptionMode": "fixed",
        "purchaseType": "ONE_TIME",
        "recurringCycleLimit": null,
        "flexibleConfig": null,
        "tier": null,
        "minimumSpend": "£20"
      }
    ],
    "tieredRewards": [],
    "currencySymbol": "£",
    "subscriptionsProvider": null,
    "loyaltyMode": "points",
    "currency": "GBP"
  }
}

JavaScript SDK

Methods

Recipes

Usage

Response

Sample response

​Usage

​Response

​Sample response

Usage

Response

Sample response