POST

Redeem Points For Coupon


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.

Endpoint
POST
https://www.wixapis.com/loyalty-coupons/v1/coupons

Body Params
rewardIdstringRequiredformat GUID

ID of the loyalty reward to redeem.


loyaltyAccountIdstringRequiredformat GUID

ID of the loyalty account of the customer redeeming points.

Response Object
couponCoupon

Created loyalty coupon.

Redeem points for coupon
Request
cURL
curl -X POST \ 'https://www.wixapis.com/loyalty-coupons/v1/coupons' \ -H 'Authorization: <AUTH>' \ -H 'Content-Type: application/json' \ --data-raw '{ "rewardId": "960d1ef4-80b8-4c87-8301-cda0c35b6b8d", "loyaltyAccountId": "bf14421a-0ccb-4656-a91f-84119e8fc994" }'
Response
JSON
{ "coupon": { "id": "c90918b2-e9a5-4147-b4a4-953e235b9ddd", "accountId": "bf14421a-0ccb-4656-a91f-84119e8fc994", "memberId": "e64eee9f-ec4e-4c8a-b015-eb3be0b2761b", "couponReference": { "couponId": "e48b4b92-3481-40bf-943d-c9324ae3cd6d", "code": "6Q1LC0K4KHSL", "name": "Free shipping", "specification": { "type": "FREE_SHIPPING", "freeShipping": true } }, "status": "PENDING", "rewardName": "Free shipping", "revision": "1", "createdDate": "2024-04-18T15:07:53.639Z", "updatedDate": "2024-04-18T15:07:53.639Z" } }
Errors

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

Event TriggersThis method triggers the following events:
Did this help?