Skip to content
👥 Storefront APIs
/
/
Submit product review

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

Sync customer metafield data

Request

Synchronizes the authenticated customer's metafield data with Shopify. This endpoint triggers an immediate sync of customer loyalty information (points, tier, etc.) to Shopify metafields. Useful when customer data needs to be refreshed in Shopify for theme display or other integrations.

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

Responses

Customer data synchronized successfully

Submit product review

Request

Submits a product review and potentially awards loyalty points.

Two ways to submit reviews:

1. Order-linked review (recommended):

  • Include uniqueId in request (unique identifier for purchased product)
  • Product details auto-filled from order
  • Verifies customer actually purchased the product
  • More trustworthy for other customers

2. General review:

  • Omit uniqueId
  • Manually provide productId, productTitle, productImage
  • Customer can review any product
  • May not qualify for "verified purchase" points

Required fields:

  • rating: 1-5 stars (integer)
  • title: Review headline (string)
  • body: Review content (string)
  • Either uniqueId OR (productId + productTitle)

Optional fields:

  • productImage: URL to product image
  • reviewerName: Override customer name (defaults to account name)
  • images: Array of review image URLs
  • carouselStatus: Feature in carousel widget (boolean)
  • pinnedStatus: Pin to top of reviews (boolean)

Point earning:

  • Points awarded based on "Product Review" earn rule
  • Points may be pending approval or immediate
  • Only first review per product typically earns points
  • Some merchants require review approval before points
  • Points processed asynchronously after submission

Review moderation:

  • Reviews are published immediately by default
  • Can be configured to require admin approval
  • Check your loyalty settings for moderation rules
  • publishedStatus field controls visibility

Image support:

  • Customers can attach images to reviews
  • Images must be publicly accessible URLs
  • Recommended to upload to your CDN first
  • Multiple images supported (array)

Review display features:

  • carouselStatus=true: Shows in rotating carousel widget
  • pinnedStatus=true: Appears at top of product reviews
  • Both useful for highlighting exceptional reviews

Authentication: Requires customer JWT token. The authenticated customer is the review author.

Validation rules:

  • Rating must be 1, 2, 3, 4, or 5
  • Title and body cannot be empty
  • Product must exist in catalog
  • If uniqueId provided, must be from customer's orders
  • Customer cannot review same product multiple times (configurable)

Processing flow:

  1. Validate review data
  2. Create review record in database
  3. Publish review (or queue for approval)
  4. Trigger async process for point calculation
  5. Award points if eligible
  6. Send confirmation email (if configured)
  7. Update product review statistics

Response: Returns success message immediately. Points may take a few seconds to appear in account due to async processing.

Best practices:

  1. Use uniqueId when available for verified purchases
  2. Encourage customers with point incentives
  3. Display point reward amount before review form
  4. Validate form data client-side before submission
  5. Show success message with expected point amount
  6. Explain points may take a moment to appear
  7. Provide preview of how review will look

Example review submission flow:

1. Customer views "Write a Review" page for product
2. Form shows: "Earn 50 points for reviewing this product!"
3. Customer fills out rating, title, body
4. Optionally uploads images
5. Clicks "Submit Review"
6. Call this endpoint
7. Show success: "Thank you! Your review has been submitted and 50 points will be added to your account shortly."
8. Redirect to product page or review confirmation page

Error handling:

  • 400: Invalid data (missing fields, invalid rating, etc.)
  • 401: Not authenticated
  • 500: Server error (retry or contact support)
Bodyapplication/jsonrequired
idinteger(int64)
shopstringrequired
titlestring
bodystring
ratinginteger(int32)
publishedStatusboolean
reviewerNamestring
reviewerEmailstring
productIdinteger(int64)
pinnedboolean
archivedboolean
createAtstring(date-time)required
replayBodystring
replayDatestring(date-time)
productTitlestring
productHandlestring
productImagestring
originalReviewTitlestring
originalReviewBodystring
uniqueIdstring(uuid)
customerIdinteger(int64)
reviewEditReasonstring
carouselboolean
reviewSourcestring
Enum"WEB_PAGE""API""IMPORT"
curl -i -X POST \
  https://loyalty-admin.appstle.com/loyalty/cp/api/submit-review \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 0,
    "shop": "string",
    "title": "string",
    "body": "string",
    "rating": 0,
    "publishedStatus": true,
    "reviewerName": "string",
    "reviewerEmail": "string",
    "productId": 0,
    "pinned": true,
    "archived": true,
    "createAt": "2019-08-24T14:15:22Z",
    "replayBody": "string",
    "replayDate": "2019-08-24T14:15:22Z",
    "productTitle": "string",
    "productHandle": "string",
    "productImage": "string",
    "originalReviewTitle": "string",
    "originalReviewBody": "string",
    "uniqueId": "a1e12d74-d756-40d1-9bb3-519def353f44",
    "customerId": 0,
    "reviewEditReason": "string",
    "carousel": true,
    "reviewSource": "WEB_PAGE"
  }'

Responses

Review submitted successfully. Points will be awarded asynchronously if eligible.

Bodyapplication/json
string
Response
application/json
"Review successfully submitted; it will reflect shortly."

Send customer referral email

Request

Sends a referral invitation email to a friend on behalf of the authenticated customer.

How referrals work:

  1. Customer sends referral email to friend
  2. Friend receives email with unique referral link
  3. Friend clicks link and creates account/makes purchase
  4. Both customer (referrer) and friend (referee) may receive rewards
  5. Rewards based on referral rule configuration

Request body:

  • email: Friend's email address (required, must be valid)
  • Can include additional fields like name, message (check your configuration)

Email content:

  • Contains customer's unique referral link
  • Describes referral rewards (e.g., "You get $10 off, they get $10 off")
  • Uses your configured email template
  • Branded with your store logo and colors
  • Includes call-to-action button

Rate limiting:

  • Default limit: 500 emails per shop per day
  • Prevents spam and abuse
  • 429 error if limit exceeded
  • Limit resets daily
  • Contact support to adjust limits if needed

Activity logging:

  • Each send is logged for analytics
  • Track referral email performance
  • Monitor for fraudulent activity
  • View in admin dashboard

Referral tracking:

  • Unique referral link embedded in email
  • Tracks when friend clicks link
  • Attributes purchase to referrer
  • Shows in customer's referral history

Authentication: Requires customer JWT token. The authenticated customer is the referrer.

Validation:

  • Email address format validation
  • Duplicate email checking (optional)
  • Customer must be enrolled in loyalty program
  • Referral program must be active
  • Customer not excluded from program

Best practices:

  1. Allow customers to preview email before sending
  2. Show referral incentives clearly
  3. Provide email template customization
  4. Track success rate and optimize messaging
  5. Consider social sharing alternatives
  6. Display referral link prominently for manual sharing
  7. Limit sends per customer to prevent spam

Example UI flow:

1. Customer enters friend's email
2. Optional: Add personal message
3. Preview email content
4. Click "Send Invitation"
5. Call this endpoint
6. Show success message
7. Update referral count display
8. Add to "Sent Invitations" list

Error scenarios:

  • Invalid email format: 400 error
  • Rate limit exceeded: 429 error (show retry time)
  • Customer not enrolled: 400 error
  • Referral program inactive: 400 error
  • Email service failure: 500 error (retry)

Success response: Returns 200 with no body. Email sent successfully.

Alternative sharing methods: Instead of email, customers can also:

  • Copy referral link directly (GET referral URL first)
  • Share on social media
  • Use QR code
  • Share via SMS (if configured)
Bodyapplication/jsonrequired
emailstring
curl -i -X POST \
  https://loyalty-admin.appstle.com/loyalty/cp/api/send-customer-referral-url \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string"
  }'

Responses

Referral email sent successfully

Response
No content