Skip to main content
POST
Redeem customer loyalty points

Body

application/json

Point redemption request details including redeem rule ID, points to redeem, and optional variant ID for product rewards

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

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: customer@example.com

Example:

"customer@example.com"

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

points
number<double> | null

Number of points to spend. Only DYNAMIC_DISCOUNT rewards use it: the customer chooses how many points to spend and gets the rule's discount for every redeemPoints points. Required and must be positive for those rewards, and the customer must have at least this many available points. Every other reward type (STORE_CREDIT, DISCOUNT_CODE, PRODUCT_DISCOUNT, COLLECTION_DISCOUNT, FREE_PRODUCT, FREE_SHIPPING) ignores it and spends the rule's own redeemPoints for its fixed reward. Example: 100.0

Example:

100

variantId
integer<int64> | null

For a FREE_PRODUCT or PRODUCT_DISCOUNT reward, the id of the product or variant the customer picked, from the rule's productData. Optional. For a FREE_PRODUCT reward that lists a whole product, the id of one of that product's variants is also accepted, and the code still covers the whole product. Any other id returns 400. Example: 12345678

Example:

12345678

Response

Points redeemed successfully, returns updated customer loyalty information with new reward

achievableTierId
integer<int64>
availablePoints
number<double>
createAt
string<date-time>
creditedPoints
number<double>
currentVipTier
string
customerStatus
enum<string>
Available options:
ACTIVE,
INACTIVE,
EXCLUDED,
EXCLUDED_BY_CUSTOMER
dob
string<date>
dobYearProvided
boolean
expiringPointsAmount
number<double>
pendingPoints
number<double>
pointsExpireAt
string<date-time>

The customer's short referral link, on https://referral.appstle.com/ or the merchant's custom referral domain. Its last part is the customer's referral token, which Accept referral offer takes as token. The link redirects to the store's primary domain with appstle_referral=true and appstle_referral_code={token} in the query string.

Example:

"https://referral.appstle.com/abc123def456ghij"

referredCompleted
integer<int64>
rewardedForCreatingAccount
boolean
rewardedForFacebook
boolean
rewardedForInstagram
boolean
rewardedForNewsLetter
boolean
rewardedForPinterest
boolean
rewardedForSharingOnFacebook
boolean
rewardedForSharingOnX
boolean
rewardedForSms
boolean
rewardedForTiktok
boolean
rewardedForTwitter
boolean
rewardedForYoutube
boolean
rewards
object[]
spentAmount
number<double>
storeCreditBalance
number<double>
storeCreditCurrency
string
vipTierExpiredAt
string<date-time>
vipTierOrderCount
integer<int32>
vipTierSpentAmount
number<double>