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 Programs API allows you to activate and customize your loyalty program.
With the Loyalty Programs API, you can:
- Activate your loyalty program.
- Customize the name of the program, as well as the name and icon of the loyalty points unit.
To use the Loyalty Programs API, import { programs } from the wix-loyalty.v2 module.
javascript | Copy Codeimport { programs } 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.
Terminology
- Program name: Customizable name of the loyalty program.
- Point: The collectible unit of the program. Use
pointDefinitionto customize the name and icon of these loyalty points. The default name”Points”translates and adjusts to singular based on context. Since a customized name doesn’t adjust based on context it is recommended to use the plural, for example”Stars”.
Was this helpful?