Skip to content
👥 Storefront APIs
/
/
Enable loyalty program fo...

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

Enroll customer in loyalty program

Request

Enrolls the authenticated customer in the loyalty program and optionally assigns them to a specific VIP tier. This endpoint activates all loyalty features for the customer, allowing them to earn and redeem points. If a VIP tier is specified, the customer is automatically placed in that tier upon enrollment. Creates necessary customer records and triggers any welcome rewards configured in the system.

Bodyapplication/jsonrequired
vipTierstring
curl -i -X POST \
  https://loyalty-admin.appstle.com/loyalty/cp/api/enroll-customer \
  -H 'Content-Type: application/json' \
  -d '{
    "vipTier": "string"
  }'

Responses

Customer enrolled successfully

Bodyapplication/json
string
Response
application/json
"Customer added successfully."

Enable loyalty program for customer

Request

Enables the loyalty program for the authenticated customer, allowing them to earn and redeem points. This is a simplified version of the enroll-customer endpoint that doesn't require any request body. Useful for quick customer opt-in flows without tier assignment.

curl -i -X POST \
  https://loyalty-admin.appstle.com/loyalty/cp/api/enable-loyalty-program

Responses

Loyalty program enabled successfully

Bodyapplication/json
string
Response
application/json
"Customer added successfully."

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