Redeem customer points for rewards

POST /api/external/redeem-points

Redeem customer points for rewards

cURL

curl --request POST \
  --url https://loyalty-admin.appstle.com/api/external/redeem-points \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --data '
{
  "redeemRuleId": 5
}
'

200

{
  "availablePoints": 150,
  "pendingPoints": 0,
  "creditedPoints": 500,
  "spentAmount": 1250.99,
  "storeCreditBalance": 0,
  "currentVipTier": "Gold",
  "rewards": [
    {
      "id": 12346,
      "discountCode": "LOYALTY15OFF",
      "discountType": "PERCENTAGE",
      "discountValue": 15,
      "status": "UNUSED",
      "expiryDate": "2025-06-30T23:59:59Z",
      "pointsRedeemed": 100,
      "createAt": "2025-01-29T10:30:00Z"
    }
  ],
  "customerStatus": "ACTIVE"
}

Headers

X-API-Key · string · required

API key for authentication

Body

application/json

Redemption request with customer ID/email, redeem rule ID, points to redeem

redeemRuleId · integer<int64> · required

ID of the redemption rule to use. Determines what reward the customer receives. Use GET /api/external/point-redeem-rules to get available redemption options. Must be an active redemption rule configured in your loyalty program. Example: 5

Example:

5

customerId · integer<int64> | null

Shopify customer ID (numeric). Identifies which customer is redeeming points. Provide either customerId OR customerEmail, not both. Example: 67890

Example:

67890

customerEmail · string | null

Customer's email address. Alternative to customerId for identifying the customer. Provide either customerId OR customerEmail, not both. Must be a valid email address that exists in your Shopify store. Example: [e-mail]

Example:

"[e-mail]"

points · number<double> | null

Number of points to redeem. Must be positive. If not provided, uses the default points value from the redemption rule. Customer must have at least this many available points. Example: 100.0

Example:

100

variantId · integer<int64> | null

Shopify product variant ID. Required when redeeming for product-specific rewards (free product). Not required for discount codes or store credit rewards. Must be a valid variant ID from your Shopify catalog. Example: 12345678

Example:

12345678

Response

200

application/json

Points successfully redeemed and reward generated

availablePoints · number<double>

pendingPoints · number<double>

creditedPoints · number<double>

spentAmount · number<double>

storeCreditBalance · number<double>

achievableTierId · integer<int64>

currentVipTier · string

vipTierExpiredAt · string<date-time>

createAt · string<date-time>

rewardedForFacebook · boolean

rewardedForPinterest · boolean

rewardedForTwitter · boolean

rewardedForInstagram · boolean

rewardedForYoutube · boolean

rewardedForTiktok · boolean

rewardedForNewsLetter · boolean

rewardedForSms · boolean

referredCompleted · integer<int64>

referralLink · string

customerStatus · enum<string>

Available options: ACTIVE, INACTIVE, EXCLUDED, EXCLUDED_BY_CUSTOMER

dob · string<date>

rewards · object[]

Show child attributes

rewardedForCreatingAccount · boolean

rewardedForSharingOnFacebook · boolean

rewardedForSharingOnX · boolean

expiringPointsAmount · number<double>

pointsExpireAt · string<date-time>