Sign in

v1

latestOpenAPI 3.0.12026-07-21161785.3 KB
Redemptions & Discount Codes

Redeem customer points for rewards

post/api/external/redeem-points

Headers

X-API-Keystring required

API key for authentication

Request body

customerEmailstring nullable

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

customerIdinteger nullable

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

pointsnumber double nullable

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

redeemRuleIdinteger 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

variantIdinteger nullable

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 request

{
  "customerId": 67890,
  "points": 100,
  "redeemRuleId": 5,
  "variantId": 12345678
}

Response

Points successfully redeemed and reward generated

achievableTierIdinteger
availablePointsnumber double
createAtstring date-time
creditedPointsnumber double
currentVipTierstring
customerStatus'ACTIVE' | 'INACTIVE' | 'EXCLUDED' | 'EXCLUDED_BY_CUSTOMER'
dobstring date
expiringPointsAmountnumber double
pendingPointsnumber double
pointsExpireAtstring date-time
referralLinkstring
referredCompletedinteger
rewardedForCreatingAccountboolean
rewardedForFacebookboolean
rewardedForInstagramboolean
rewardedForNewsLetterboolean
rewardedForPinterestboolean
rewardedForSharingOnFacebookboolean
rewardedForSharingOnXboolean
rewardedForSmsboolean
rewardedForTiktokboolean
rewardedForTwitterboolean
rewardedForYoutubeboolean
spentAmountnumber double
storeCreditBalancenumber double
storeCreditCurrencystring
vipTierExpiredAtstring date-time
vipTierSpentAmountnumber double