Skip to main content

Documentation Index

Fetch the complete documentation index at: https://appstleinc-aeca3e0a.mintlify.app/llms.txt

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

Appstle Loyalty is a complete loyalty and rewards platform for Shopify stores. It exposes two REST APIs — the Admin API for backend integrations, mobile apps, and automated workflows, and the Storefront API for customer-facing experiences delivered through Shopify’s App Proxy. Together they let you build anything from simple points programs to multi-tier VIP schemes with referrals, reviews, and store credits.

​
What you can build

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.

​
Choosing the right API

The Admin API is authenticated with an API key and called server-side. Use it for:
  • Backend integrations and automated workflows
  • Mobile applications (iOS and Android)
  • Admin dashboards and reporting tools
  • Bulk operations and third-party system integrations
  • Any request made outside your storefront
Base URL: https://loyalty-admin.appstle.comAuthentication: X-API-Key header
Never call the Admin API from client-side JavaScript or expose your API key in a browser. All Admin API requests must originate from a server you control.

​
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.

​
Response format

All API responses use standard HTTP status codes.
CodeMeaning
200Request completed successfully
201Resource created
400Invalid request parameters
401Missing or invalid API key
403API key lacks required permissions
404Resource not found
429Rate limit exceeded — use exponential backoff
500Server error
Error responses follow this structure: 
{
  "error": "Unauthorized",
  "message": "Invalid API key provided",
  "status": 401
}

​
Next steps

Quickstart

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

Authentication

Learn how to create and manage API keys and authenticate every request.

Integration guide

Full walkthrough of every endpoint category with working curl examples.

Webhooks

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