Skip to main content
Appstle Loyalty is a complete loyalty and rewards platform for Shopify stores. Once you install the app, Appstle exposes two REST API surfaces so you can build anything from simple points programs to multi-tier VIP schemes with referrals, reviews, and store credits on top of your loyalty data.

​
Available APIs

Appstle Loyalty exposes two REST API surfaces. Pick the one that matches where your code runs:
  • Admin API — server-side, authenticated with X-API-Key. For backend integrations, mobile apps, automation, and admin dashboards. Browse the full reference under Admin API in the sidebar.
  • Storefront API — customer-facing, accessed through Shopify App Proxy. For loyalty widgets and self-service portals on your storefront. Browse the full reference under Storefront API in the sidebar.

​
Which API should you use?

  • You are building a server-side integration (backend service, CRM connector, helpdesk plugin)
  • You are building a mobile app (iOS or Android)
  • You need to credit or debit points programmatically on behalf of merchants
  • You want to run bulk operations or scheduled automation
  • You are building an admin dashboard or reporting tool
  • Your code runs anywhere outside a customer’s browser on the storefront
Admin API requests require an X-API-Key header. Keys are created in the Appstle dashboard under Settings → API Key Management. Never expose keys in client-side code.

​
Key features

Point management

Credit and debit points for purchases, reviews, social actions, birthdays, and custom activities. Access full transaction history.

VIP tiers

Define spend or points thresholds for Bronze, Silver, Gold, Platinum, or any tier structure. Automatically promote and demote customers.

Referral program

Generate unique referral links, track accepted referrals, and reward both the referrer and the referred customer.

Product reviews

Let customers submit reviews and earn points. Display ratings via Shopify metafields compatible with native rich results.

Store credits

Issue monetary store credit as an alternative to discount codes. Balances are tracked separately from loyalty points.

Rewards & discounts

Convert points into Shopify discount codes. Validate and mark codes as used from your own checkout flow.

​
Key concepts

Points move through three states: pending (earned but awaiting approval), available (redeemable), and credited (total lifetime points earned). Your program configuration determines whether points are credited immediately or held in a pending state for review.
Tiers are assigned automatically when a customer crosses a configured spend or points threshold. Each tier can carry a name tag and any number of additional Shopify customer tags. Tags are swapped automatically on tier changes — there is always at most one active tier per customer.
Every enrolled customer receives a unique referral link. When a referred customer makes a qualifying purchase, both parties receive rewards as defined in your referral configuration. Referral relationships are recorded permanently as Shopify customer tags.
Store credits are a monetary balance separate from points. They are applied at checkout and tracked in storeCreditBalance on the customer loyalty profile. Credits can be issued via the Admin API or through Shopify Flow.
Third-party apps (helpdesks, CRMs, review platforms, email tools) can connect to Appstle Loyalty through the Partner Integration Framework. Partners receive a scoped API token per merchant with no manual key exchange. Merchants connect and disconnect with one click.

​
Base URL

All Admin API endpoints use: 
https://loyalty-admin.appstle.com
Storefront API endpoints are accessed through your store’s Shopify App Proxy — no separate base URL is needed.

​
HTTP status codes

All API responses use standard HTTP status codes.
CodeMeaning
200Success
201Resource created
400Bad request — invalid parameters
401Unauthorized — missing or invalid API key
403Forbidden — key lacks required permissions
404Not found
429Rate limit exceeded
500Server error
Error responses follow this shape: 
{
  "error": "Unauthorized",
  "message": "Invalid API key provided",
  "status": 401
}

​
Next steps

Authentication

Create API keys and learn how to authenticate every request.

Quickstart

Get your API key, make your first request, and add points in under five minutes.

Integration guide

Full walkthrough of every endpoint category with working curl examples.

Webhooks

Receive real-time notifications for points, tier changes, and referrals.