About Loyalty Program

The loyalty program API allows a site owner to activate their site's loyalty program and manage its details, like the point name and point icon. The loyalty program must be ACTIVE to start creating customer loyalty accounts and tracking their point balances.

With the loyalty program API, you can:

  • Activate a loyalty program.
  • Update the name and icon for the program's points.
  • Retrieve a loyalty program.

Note: In order to use the loyalty program API, the Wix site owner must first install the Wix Loyalty Program app to their site. A site owner can install the app through their dashboard or the Wix App Market.

Was this helpful?
Yes
No

Program Object

Attributes
namestringminLength 2maxLength 50
Program name.

pointDefinitionobject
Details about the program's collectible unit.

statusstringRead-only
4 supported values:
UNKNOWNDRAFTACTIVEPAUSED
Program status. Customers can only earn or redeem points while the program is "ACTIVE". Default: "DRAFT"

createdDatestringRead-onlyformat date-time
Date and time the program was created.

updatedDatestringRead-onlyformat date-time
Date and time the program was updated.
Was this helpful?
Yes
No

GetGet Loyalty Program

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Retrieves the loyalty program.

Permission Scopes

For app development, you must have one of the following permission scopes:
Read Loyalty
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

GET
https://www.wixapis.com/loyalty-programs/v1/program

Was this helpful?
Yes
No

PatchUpdate Loyalty Program

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Updates the loyalty program.

You cannot activate the loyalty program using this endpoint. To do so, use the Activate Loyalty Program endpoint.

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Loyalty
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

PATCH
https://www.wixapis.com/loyalty-programs/v1/program

Event Triggers

This method triggers the following events:
Was this helpful?
Yes
No

PostActivate Loyalty Program

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Activates a loyalty program.

When a loyalty program is installed it starts in "DRAFT" status. Customers cannot earn or redeem points while the program is not "ACTIVE".

Permission Scopes

For app development, you must have one of the following permission scopes:
Manage Loyalty
Learn more about permission scopes.Authorization header required - pass the OAuth Access Token

Syntax

POST
https://www.wixapis.com/loyalty-programs/v1/program/activate

Event Triggers

This method triggers the following events:
Was this helpful?
Yes
No

Loyalty Program Updated

Developer Preview - This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Triggered when a loyalty program is updated.

Permissions

LOYALTY.READ_PROGRAM
Learn more about permissions.

Event Body

Event Body Event data is received as a JSON Web Token (JWT). It may be delayed. Be sure to verify the data was sent by Wix.
Event Data
idstring
Unique event ID. Allows clients to ignore duplicate webhooks.

entityFqdnstring
Fully qualified domain name of the entity associated with the event. Expected wix.loyalty.v1.program.

slugstring
Event name. Expected updated.

entityIdstring
ID of the entity associated with the event.

eventTimestringformat date-time
Event timestamp.

triggeredByAnonymizeRequestboolean
Whether the event was triggered as a result of a privacy regulation application (for example, GDPR).

originatedFromstring
If present, indicates the action that triggered the event.

updatedEventobject
Event information.
Was this helpful?
Yes
No