Get Program

This endpoint is used to retrieve the details of the loyalty program sponsored by the store, as well as offer prizes and discounts to attract and retain customers.

TIP

The get program endpoint has been implemented in the Loyalty Web Component , and It's all setup to save developer's time and effort.

Response

Success

Error

loyalty.getProgram.success

Usage

To perform the action of getting a program details, the method order() may be called as below, with the id of the order to be rated.

Events

This endpoint may trigger two events, the onProgramFetched and onProgramNotFetched events.

onProgramFetched

This event is triggered when fetching the loyalty program is done without having any errors coming back from the backend.

onProgramNotFetched

This event is triggered when fetching the loyalty program is not completed and an error has occurred.

Response#

Usage#

Events#

onProgramFetched#

onProgramNotFetched#

Response

Usage

Events

onProgramFetched

onProgramNotFetched