getShopVipTiers

Retrieve all VIP tiers for the shop, including their requirements and point multipliers.

Usage

MageSDK.getShopVipTiers().then(function(resp) {
  if (resp.success) {
    resp.data.tiers.forEach(function(tier) {
      console.log(tier.name, tier.threshold);
    });
  }
});

Response

boolean

Whether the request was successful.

array

List of VIP tiers ordered by threshold.

Show Tier properties

string

The tier ID.

string

Display name of the tier.

string | null

Description of the tier, or null if not set.

number

The tier ranking value, mirroring the requirement for the shop’s primary entry method.

number | null

Points requirement, set when points is a primary or extra entry criterion.

number | null

Spend requirement, set when spend is a primary or extra entry criterion.

number | null

Orders requirement, set when orders is a primary or extra entry criterion.

number

Points earning multiplier for this tier.

string | null

URL of the tier badge image, or null if not set.

string | null

Hex color code for the tier badge, or null if not set.

array

Active rewards associated with this tier.

Show Reward properties

string

The reward ID.

string

Display name of the reward.

string | null

Type of discount applied.

number

Cost to redeem, in the shop’s loyalty unit.

number | null

The discount amount.

boolean

Whether the reward is currently active.

boolean

Whether this reward is granted automatically on reaching the tier.

number | null

Number of days before the reward expires, or null if it does not expire.

string

How customers qualify for tiers (e.g. "points", "spend", "orders").

string | null

A second entry method when the shop combines two criteria, or null.

string

"AND" or "OR", describing how entryMethod and entryMethodExtra combine.

string

The shop’s currency symbol.

string | null

The multiplier mode, or null if not configured.

string

"points" or "store_credit". See Loyalty modes.

string | null

The shop’s ISO currency code, or null.

Sample response

{
  "success": true,
  "data": {
    "tiers": [
      {
        "id": "tier_bronze",
        "name": "Bronze",
        "description": "Welcome to the loyalty program!",
        "threshold": 0,
        "thresholdPoints": 0,
        "thresholdSpend": null,
        "thresholdOrders": null,
        "pointsMultiplier": 1.0,
        "badgeImageUrl": null,
        "badgeColor": "#CD7F32",
        "rewards": []
      },
      {
        "id": "tier_gold",
        "name": "Gold",
        "description": "Our most valued customers",
        "threshold": 500,
        "thresholdPoints": 500,
        "thresholdSpend": null,
        "thresholdOrders": null,
        "pointsMultiplier": 1.5,
        "badgeImageUrl": null,
        "badgeColor": "#FFD700",
        "rewards": [
          {
            "id": "reward_gold_1",
            "name": "Free shipping",
            "discountType": "free_shipping",
            "pointsCost": 200,
            "discountAmount": null,
            "isActive": true,
            "isEntryReward": false,
            "expiryDays": null
          }
        ]
      }
    ],
    "entryMethod": "points",
    "entryMethodExtra": null,
    "entryLogic": "AND",
    "currencySymbol": "£",
    "pointsMultiplierMode": null,
    "loyaltyMode": "points",
    "currency": "GBP"
  }
}

JavaScript SDK

Methods

Usage

Response

Sample response

​Usage

​Response

​Sample response

Usage

Response

Sample response