Returns the customizations as configured in the BonifiQ admin panel

Returns the customizations as configured in the BonifiQ admin panel

This method returns two types of rewards: Discounts (Value Discounts and Percent Discounts) or Cashback. Altough not commom, it is possible to have all types of rewards active at the same time.

Main properties

• ProgramName The name of the loyalty program. This could be different from the store name. Eg: "MyStore Rewards"
• WidgetIconUrl: The URL of the icon used as reference in the loyaty program. Used in widget an landing pages. If null, the default icon should be used
• HaveIconUrl: if true the icon URL is set and should be used. If false, the default icon should be used
• WidgetColor: if HaveIconUrl is false, this color should be used in the widget.
• MainColor: the hexadecimal color used as a main theme color for the program.
• Logo: The URL of the store. This is usually used in the e-mails sent do customers.
• Url: The URL of the store or loyalty landing page. It could be useful when communicating with the customer for sending him to the store.
• CompanyName: Name of the store or company. Can be used in communications.

Defining Loyalty Program Icon

The Loyalty Programa usually have an unique visual identification, as a logo or icon. This icon is used in the widget and landing pages to identify the program.

If the WidgetIconUrl is null them the logo is not set and a default icon should be used instead. The rule therefore should be:

• If HaveIconUrl is true use the WidgetIconUrl as the icon as a link to an image
• If HaveIconUrl is false display the default widget icon. Usually it is the giftcard icon from Material UI. Use this link for instructios on how to use it
• If using the default icon, use WidgetColor to set the icon color as set in the BonifiQ admin configuration.