Public Methods

These methods only require an SDK Key. No customer login needed.

appyStamp.shop()

Returns shop configuration and branding settings.

appyStamp.shop().then(function (data) {
  console.log(data);
});

Returns:

{
  "program_name": "Loyalty Rewards",
  "stamp_branding_plural": "stamps",
  "stamp_card_value": 10,
  "currency": "USD",
  "currency_symbol": "$"
}

The result is cached after the first call. Subsequent calls return the cached data without making another request.

---

appyStamp.earnRules(opts)

Returns active earning rules. These are the ways customers can earn stamps.

// Get all rules
appyStamp.earnRules().then(function (data) {
  console.log(data.items);
});

// With pagination
appyStamp.earnRules({ page: 1 }).then(function (data) {
  console.log(data.items);
  console.log(data.has_more);  // true if more pages exist
  console.log(data.next_page); // next page number, or null
});

Parameters:

Name	Type	Default	Description
page	number	(all)	Page number. Omit to return all rules in one request.

Returns:

{
  "items": [
    {
      "id": 1,
      "name": "Place an Order",
      "icon_url": "https://storage.googleapis.com/.../place-order.svg",
      "step": 1,
      "multiplier": 1.0,
      "type": "shopify_online_order",
      "reward_value_type": "variable"
    }
  ],
  "has_more": false,
  "next_page": null
}

has_more and next_page are only present when you pass a page parameter.

---

appyStamp.rewards(opts)

Returns available reward products that customers can redeem stamps for.

// Get all rewards
appyStamp.rewards().then(function (data) {
  console.log(data.items);
});

// With pagination
appyStamp.rewards({ page: 1 }).then(function (data) {
  console.log(data.items);
});

Parameters:

Name	Type	Default	Description
page	number	(all)	Page number. Omit to return all rewards in one request.

Returns:

{
  "items": [
    {
      "id": 42,
      "name": "$5 discount code",
      "price": 50,
      "price_label": "50 stamps",
      "exchange_type": "fixed",
      "icon_url": "https://..."
    }
  ]
}

The price_label is pre-formatted with the correct unit. For card-based rewards it shows “1 card” instead of “1 stamps”.

When a customer is authenticated (the SDK has called customer() and has a token), rewards include additional fields:

{
  "id": 42,
  "name": "$5 discount code",
  "price": 50,
  "price_label": "50 stamps",
  "exchange_type": "fixed",
  "icon_url": "https://...",
  "can_afford": true,
  "stamps_needed": 0,
  "stamps_needed_label": "0 more stamps needed"
}

Field	Type	Description
can_afford	boolean	Whether the customer has enough stamps to redeem this reward
stamps_needed	number	How many more stamps the customer needs (0 if affordable)
stamps_needed_label	string	Pre-formatted label like “8 more stamps needed”

For card-based rewards, the calculation converts the card price to stamps automatically. A reward costing 1 card on a 10-stamp card requires 10 stamps, not 1.

These fields are only present when a customer is authenticated. For logged-out visitors, only the base reward fields are returned.

---

appyStamp.vipTiers()

Returns VIP tier definitions, ordered by milestone.

appyStamp.vipTiers().then(function (data) {
  console.log(data.items);
});

Returns:

{
  "items": [
    {
      "id": 1,
      "name": "Bronze",
      "milestone": 0,
      "icon_url": null,
      "benefits": "Free shipping on orders over $50"
    },
    {
      "id": 2,
      "name": "Gold",
      "milestone": 100,
      "icon_url": "https://...",
      "benefits": "10% off all orders, free shipping"
    }
  ]
}

When a customer is authenticated, each tier includes an is_current field:

{
  "id": 2,
  "name": "Gold",
  "milestone": 100,
  "icon_url": "https://...",
  "benefits": "10% off all orders, free shipping",
  "is_current": true
}

This field is only present when a customer is logged in. Use it to highlight the customer’s current tier without needing to cross-reference with customer().vip_tier_id.

---

appyStamp.beacons()

Returns active beacons (promotional messages).

appyStamp.beacons().then(function (data) {
  console.log(data.items);
});

Returns:

{
  "items": [
    {
      "id": 1,
      "name": "Welcome Bonus",
      "message": "Sign up and earn 50 bonus stamps!",
      "icon": "product_bonus",
      "active": true
    }
  ]
}