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.
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.
Admin Method
This function requires elevated permissions and runs only on the backend and on dashboard pages.
Method Declaration
Copy
Method Parameters
rewardIdstringRequired
ID of the loyalty reward to redeem.
optionsRedeemPointsForCouponOptionsRequired
Returns
Return Type:Promise<RedeemPointsForCouponResponse>
Was this helpful?
Yes
No