Get started with Appstle Loyalty API

Create an API key, retrieve a customer’s loyalty profile with points and VIP tier, then credit points to their account — all in under five minutes.

This guide walks you through the three steps needed to make your first Appstle Loyalty API calls: getting a key, reading a customer’s loyalty data, and adding points. By the end you will have a working integration you can build on.

Prerequisites

• An active Appstle Loyalty subscription on your Shopify store
• Access to the Appstle admin panel
• A Shopify customer ID to test with (find one in your Shopify admin under Customers)

Step 1 — Get your API key

1. Open API Key Management

   In your Appstle admin panel, go to Settings → API Key Management.

2. Create a key

   Click Create New Key. Give it a name like Quickstart test, then click Save.

3. Copy the key

   Copy the displayed key immediately. It is only shown once. Store it as an environment variable:

   export APPSTLE_API_KEY="apst_your-api-key-here"
   export SHOP="your-store.myshopify.com"
   

Never put your API key in client-side code. All requests must be made from a server you control.

Step 2 — Retrieve customer loyalty data

Call GET /api/external/customer-loyalty with your store domain and a Shopify customer ID. Replace 12345 with a real customer ID from your store.

curl

curl -X GET \
  "https://loyalty-admin.appstle.com/api/external/customer-loyalty?shop=${SHOP}&customer_id=12345" \
  -H "X-API-Key: ${APPSTLE_API_KEY}"

A successful response looks like this:

{
  "availablePoints": 1250,
  "pendingPoints": 150,
  "creditedPoints": 1400,
  "storeCreditBalance": 25.0,
  "currentVipTier": "Gold",
  "customerStatus": "ACTIVE"
}

Field	Description
availablePoints	Points the customer can redeem right now
pendingPoints	Points earned but not yet approved
creditedPoints	Total lifetime points ever credited
storeCreditBalance	Monetary store credit balance
currentVipTier	Active VIP tier name, or empty string if none
customerStatus	ACTIVE or INACTIVE

If you get a 404, the customer is not yet enrolled in the loyalty program. See Step 3 of the integration guide to enroll them first.

Step 3 — Add points to the customer

Call POST /api/external/add-points to credit points. Include a note so the transaction is clearly labeled in the customer’s history.

curl

curl -X POST \
  "https://loyalty-admin.appstle.com/api/external/add-points" \
  -H "X-API-Key: ${APPSTLE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "shop": "your-store.myshopify.com",
    "customerId": 12345,
    "points": 100,
    "note": "Quickstart test credit"
  }'

Call GET /api/external/customer-loyalty again and you will see availablePoints increased by 100.

What to build next

Full integration guide

Every endpoint: point management, customer enrollment, rewards, store credits, and program configuration.

Webhooks

Receive real-time notifications for points earned, VIP tier changes, and referral completions.

Shopify Flow

Trigger loyalty actions from any Shopify Flow workflow without writing API code.