Introduction
Developer Preview
APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.
APIs in Developer Preview are subject to change and are not intended for use in production.
Send us your suggestions for improving this API. Your feedback is valuable to us.
The Loyalty API allows you to manage a customized loyalty program that lets customers earn loyalty points.
With the Loyalty API, you can:
- Activate and manage a loyalty program.
- Create new loyalty accounts for customers.
- Adjust points in individual loyalty accounts.
- Manage the loyalty rewards and loyalty coupons that points can be redeemed for.
- Manage loyalty tiers and update the global settings for a tiers program.
For more information, see Wix Loyalty Program: An Overview.
To use the wix-loyalty API, import wixLoyalty from the wix-loyalty.v2 module.
javascript | Copy Codeimport wixLoyalty from 'wix-loyalty.v2';
Before you begin
It’s important to note the following points before starting to code:
- A Wix Loyalty Program must first be installed through your dashboard or the Wix App Market before the Loyalty APIs can be used.
- A loyalty program only works with certain apps, such as Wix Bookings, Wix Events, Wix Pricing Plans, Wix Restaurants, or Wix Stores. One of those must be installed on your site before the loyalty program can be used.
- A customer with a loyalty account can’t earn or redeem points while the loyalty program is in
"DRAFT"status. You can change the program’s status to"ACTIVE"through your dashboard or with theactivateLoyaltyProgram()function.
Was this helpful?