redeemPointsForCoupon( )

Redeems a customer's loyalty points for a loyalty reward and creates a loyalty coupon.

Creating a loyalty coupon also creates a corresponding "reference" coupon with the Coupons API (SDK | REST). The customer receives the reference coupon, which they can apply to their order. The loyalty coupon and its corresponding reference coupon are linked and the loyalty coupon's status reflects the current state of the reference coupon.

Check which loyalty rewards a site has available with List Rewards in the Loyalty Rewards API.

Authentication
  • When developing websites or building an app with Blocks, this method may require elevated permissions, depending on the identity of the user calling it and the calling user's permissions.
  • When building apps without Blocks or for headless projects, you can only call this method directly when authenticated as a Wix app or Wix user identity. When authenticated as a different identity, you can call this method using elevation.
  • Elevation permits users to call methods they typically cannot access. Therefore, you should only use it intentionally and securely.
Permissions
Manage Restaurants - all permissions
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
rewardIdstringRequired

ID of the loyalty reward to redeem. See the Loyalty Rewards API for more information.

optionsRedeemPointsForCouponOptionsRequired
Returns
Return Type:Promise<RedeemPointsForCouponResponse>
Errors

This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.

Did this help?