getEarningRules

Retrieve the active earning rules a customer can see, with points already boosted for the logged-in customer’s VIP tier and any active bonus campaign. Use this to display how customers earn points. Pass the logged-in customer through the app proxy and the response reflects their personalized earning rates; for guests it returns base rates.

Usage

MageSDK.getEarningRules().then(function(resp) {
  if (resp.success) {
    resp.data.earningRules.forEach(function(rule) {
      // `points` is the final award after tier and campaign boosts
      console.log(rule.name, rule.points);
    });
  }
});

Response

boolean

Whether the request was successful.

array

List of active earning rules.

Show Earning rule properties

string

The earning rule ID.

string

Internal name of the rule.

string

Description of how points are earned, reflecting the boosted value.

string

The trigger action (e.g. "purchase", "birthday", "follow_on_instagram").

string

Rule category (e.g. "purchase", "social", "engagement").

boolean

Whether the rule is currently active.

number

The final award after tier and campaign boosts. Display this value.

number

The unboosted base award configured for the rule.

number

The configured base award (same source as basePoints).

number | null

The VIP tier multiplier applied to this rule for the customer, or null if no tier boost applies.

number | null

The active bonus-campaign multiplier applied to this rule, or null if none.

number | null

Points awarded for a photo review, when the rule supports reviews.

number | null

Points awarded for a video review, when the rule supports reviews.

string | null

Label to display to customers.

string | null

Configured call-to-action URL, or null.

string | null

The resolved, ready-to-use call-to-action URL.

object | null

The customer’s specific earning record for this rule, or null if they haven’t triggered it.

string

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

string

The shop’s ISO currency code.

object | null

Banner context when the customer’s tier boosts earning, or null.

Show tierInfo properties

number

The tier’s earning multiplier.

string

The tier name, e.g. "Gold".

string

The multiplier mode.

object | null

Banner context for an active bonus campaign ({ name, id }), or null.

Sample response

{
  "success": true,
  "data": {
    "earningRules": [
      {
        "id": "rule_abc",
        "name": "Points for purchase",
        "description": "Earn 15 points per £1 spent",
        "action": "purchase",
        "category": "purchase",
        "isActive": true,
        "points": 15,
        "basePoints": 10,
        "pointsToGive": 10,
        "tierBoost": 1.5,
        "campaignBoost": null,
        "photoReviewPoints": null,
        "videoReviewPoints": null,
        "customerFacingLabel": "Earn points on every order",
        "callToActionUrl": null,
        "fullCallToActionUrl": null,
        "customerEarningRule": null
      }
    ],
    "loyaltyMode": "points",
    "currency": "GBP",
    "tierInfo": {
      "multiplier": 1.5,
      "name": "Gold",
      "mode": "all"
    },
    "campaignInfo": null
  }
}

JavaScript SDK

Methods

Usage

Response

Sample response

​Usage

​Response

​Sample response

Usage

Response

Sample response