Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.mageloyalty.com/llms.txt

Use this file to discover all available pages before exploring further.

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.pointsRequired);
    });
  }
});

​
Response

​
success
boolean
Whether the request was successful.
​
data.tiers
array
List of VIP tiers ordered by points required.
​
data.entryMethod
string
How customers qualify for tiers (e.g. "points", "spend", "purchases").
​
data.currencySymbol
string
The shop’s currency symbol.
​
data.pointsMultiplierMode
string | null
The multiplier mode, or null if not configured.

​
Sample response

{
  "success": true,
  "data": {
    "tiers": [
      {
        "id": "tier_bronze",
        "name": "Bronze",
        "description": "Welcome to the loyalty program!",
        "pointsRequired": 0,
        "pointsMultiplier": 1.0,
        "badgeImageUrl": null,
        "badgeColor": "#CD7F32",
        "rewards": []
      },
      {
        "id": "tier_gold",
        "name": "Gold",
        "description": "Our most valued customers",
        "pointsRequired": 500,
        "pointsMultiplier": 1.5,
        "badgeImageUrl": null,
        "badgeColor": "#FFD700",
        "rewards": [
          {
            "id": "reward_gold_1",
            "name": "Free shipping",
            "discountType": "free_shipping",
            "pointsCost": 200,
            "discountAmount": null,
            "isActive": true
          }
        ]
      }
    ],
    "entryMethod": "points",
    "currencySymbol": "\u00a3",
    "pointsMultiplierMode": null
  }
}