Skip to main content

​
Loyalty & Rewards API overview

The public REST API is available at /api/public/v1/*. Endpoints require a tenant-bound API key. API access is available on the Scale plan and above.

​
Authentication

Include the API key in the X-API-Key header:
Set APP_ORIGIN to the app origin shown with your API key in the app settings, without a trailing slash.
  • Invalid or cross-shop keys return 401.
  • Authenticated keys missing an endpoint scope return 403.
  • Custom-event ingestion requires an API key with the events:write scope.

​
Customers

​
Points

​
Credits (store credit)

​
Rewards and redemption

​
Earning rules

​
Events (custom events)

​
Analytics and insights

​
Customer management

​
B2B and households

​
Transaction history

​
Widget labels

​
Storefront proxy API

The signed app proxy at /apps/loyalty/* (forwarded to /api/loyalty/*) provides:
  • Customer visit tracking, self-enrollment, loyalty status updates.
  • Points history, redemption, referral data, social action claims.
  • Review submission and product review details.
  • Apple Wallet and Google Wallet pass delivery.
  • SSE notifications for real-time updates.
  • Household management.
  • Transaction history by shop.
  • B2B company endpoints.

​
SDK and integrations

  • JavaScript SDK — TypeScript SDK for headless storefronts (@shopify-loyalty/sdk).
  • Hydrogen helpers — server-side API client for Shopify Hydrogen stores.
  • Shopify Flow — 10 triggers and 6 actions for points, tier, and reward automation.

​
Health check

Returns HTTP 200 when the app is healthy. Pcnaid Documentation › Shopify Ecosystem › Loyalty & Rewards › Developer › API › Loyalty & Rewards API overview