Skip to content
👥 Storefront APIs
/
/
Claim social media reward...

Storefront APIs

Download OpenAPI description
storefront-api-swagger.json
storefront-api-swagger.yaml
Languages
Servers
https://loyalty-admin.appstle.com

Storefront APIs

Customer-facing loyalty program APIs for storefront operations. These endpoints allow customers to manage their loyalty account, earn and redeem points, submit reviews, handle referrals, and track their rewards. All endpoints require customer authentication via JWT token.

Operations

Track customer store visit

Request

Records a customer store visit and potentially awards loyalty points based on the shop's visit reward rules. This endpoint is typically called when a customer visits the storefront or specific pages. Includes rate limiting protection to prevent abuse - customers can only earn visit points up to a configured limit per day/period. The endpoint enforces a request limit (default 500) to prevent excessive API calls.

curl -i -X POST \
  https://loyalty-admin.appstle.com/loyalty/cp/api/customer-visit-store

Responses

Store visit recorded successfully

Claim social media reward points

Request

Allows a customer to claim loyalty points for social media engagement (Facebook like, Instagram follow, etc.) based on the specified earn rule. Each social media action can typically only be claimed once per customer. The system tracks which social media rewards have been claimed to prevent duplicate claims.

Bodyapplication/jsonrequired
earnRuleIdinteger(int64)
curl -i -X POST \
  https://loyalty-admin.appstle.com/loyalty/cp/api/claim-social-media-points \
  -H 'Content-Type: application/json' \
  -d '{
    "earnRuleId": 0
  }'

Responses

Social media points claimed successfully

Generate customer referral URL

Request

Creates and stores a short referral URL for the authenticated customer to share with potential referrals. The referral link is typically generated once and then can be shared via email, social media, or other channels. When new customers use this link, both the referrer and referee may receive rewards.

curl -i -X POST \
  https://loyalty-admin.appstle.com/loyalty/cp/api/add-customer-referral-url

Responses

Referral URL generated successfully