# Earnings

Table of Contents

1. [LOYALTY PROGRAMS](#loyalty-programs)
   1. Introduction
   2. Accessing the Loyalty Programs
   3. Creating a Loyalty Program
   4. Viewing & Managing Loyalty Programs
   5. Switching Views & Filters
   6. Tips
2. [LOYALTY HISTORY](#loyalty-history)
   1. Introduction
   2. Accessing the Loyalty History
   3. Viewing & Managing the Loyalty History
   4. Managing a Loyalty Transaction
   5. Switching Views & Filters
   6. Tips
3. [PRODUCT HISTORY](#product-history)
   1. Introduction
   2. Accessing the Product History
   3. Managing the Product History
   4. Viewing (Filters) & Managing a Product
   5. Tips
4. [ADJUST REASONS](#adjust-reasons)

## <mark style="color:blue;">LOYALTY PROGRAMS</mark>

<mark style="color:blue;">Home page > Settings > Loyalty > Earnings> Programs</mark>

### <mark style="color:blue;">Introduction</mark>

From simple point systems to personalized experiences, loyalty programs drive brand affinity and sustained growth. Here is a step-by-step user guide for admins or managers to create and view loyalty programs within this module.

### <mark style="color:blue;">Accessing the Loyalty Programs</mark>

* On the left-hand menu, hover over and click **'Settings'**.
* From the submenu, select **'Loyalty'**, click on '**Earnings**' and then **'Programs'**.
* The **Loyalty Programs** screen will open.

### <mark style="color:blue;">Creating a Loyalty Program</mark>

1. **Click on the plus “Add Program” Button -** This opens the loyalty program creation form.
2. **Start filling in the Program Details -** Some fields are mandatory, marked with a red asterisk '\*'. Complete these required fields before clicking the **Next** button on the top right. Let's begin with the first tab of the loyalty program creation form:

   1. **Loyalty** Tab

      * **Program Title**: Enter a user-friendly program name (e.g., *Gold Rewards*, *Anniversary Delight*).
      * **Program Code**: Enter a program code manually as per your internal policies or naming system, OR simply click the **Generate Code** button to automatically assign a code.
      * **Program Status**: Select from 'Active', 'Inactive' or 'Scheduled'.
      * **Loyalty Program Category**: Choose a program category from the drop down list.
      * **Set Campaign Period**: Set the start and end dates and times, applicable to this program.
      * **Media**: Upload an image or video appropriate for this program.
      * **Description**: Enter a description of the program.
      * **Terms & Conditions**: Enter any program terms.
      * Check your inputs on this page and once ready, click the **Next** button on the top right. Going back later on may require you to re-enter your inputs, so ensure you have completed all the fields and entered the correct information.

      <figure><img src="https://1181763860-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQvn8AaDGFgPJrQpDhaWn%2Fuploads%2FnWzBlxAClvxoZTnMeOGm%2Fimage.png?alt=media&#x26;token=6c703910-572b-4571-a875-5b0f5ab5dff3" alt=""><figcaption><p>Create Loyalty Program form - Loyalty tab</p></figcaption></figure>
   2. **Trigger** Tab

      * **Trigger Category**: Pick a category from the drop down list, for instance *Transactional*.
      * **Trigger Type**: Choose one (e.g., *QR Scan-Product*.).
      * **Rewards On**: Select one from Product, Product Category & Product Brand. As an example, we select *Product*. Next, click on either the **Click to Upload** button (for multiple products) or **Add Product** button (to add 1 product at a time), to add products to this program. The added products will appear at the bottom. Check your inputs on this page and once ready, click the **Next** button on the top right.&#x20;

      <figure><img src="https://1181763860-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQvn8AaDGFgPJrQpDhaWn%2Fuploads%2FCmenJ4k19lH8bSdTQV5K%2FScreenshot-Create%20Loyalty%20Program-Trigger%20tab.png?alt=media&#x26;token=802a2d62-4123-41b2-af2d-2ba429594188" alt=""><figcaption><p>Create Loyalty Program form - Trigger tab</p></figcaption></figure>
   3. **Rewards** Tab

      * **Reward Receiver Type**: We will select *Person* from the drop down list.
      * **Reward Type**: Choose *Coins*, of the available options.
      * **Calculation Type**: Select the calculation type from Percentage or Fixed. For this example we will choose *Fixed*.
      * **Tier**: If there are benefits for multiple tiers, select the applicable tiers. All the selected tiers will be eligible to receive rewards under this program.&#x20;
      * **Tier Specific Value**: In the respective tiers, specify the fixed values that each of the selected tiers will be eligible to receive.
      * **Hierarchy**: Select the hierarchies that will be eligible to receive rewards under this program. Leave it blank if hierarchies are not eligible to receive rewards here.
      * **Hierarchy Benefits Value**: If you select a hierarchy in the previous field, specify the value(s) that each of the selected hierarchies will be eligible to receive.
      * **Base Price Type**: The value on which the applicable rewards will be calculated. This field is relevant in the case of percentage based loyalty programs.
      * **Validity**: Set the time period for the validity of the program, in number of days or by a specific date.

      <figure><img src="https://1181763860-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQvn8AaDGFgPJrQpDhaWn%2Fuploads%2FeWdSVYTFuKK99f9JVTcX%2Fimage.png?alt=media&#x26;token=03dc5054-638a-4e43-a6fc-8e4664aa4992" alt=""><figcaption><p>Create Loyalty Program - Rewards tab</p></figcaption></figure>

   <figure><img src="https://1181763860-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQvn8AaDGFgPJrQpDhaWn%2Fuploads%2FJYR6OwIMlp84i4afMOlA%2Fimage.png?alt=media&#x26;token=e045935e-5939-4dd7-bf38-986ee978f2ac" alt=""><figcaption><p>Create Loyalty Program - Rewards tab (contd..)</p></figcaption></figure>
3. **Audience** Tab:

   * **Audience**: From the list, select the groups or entities eligible for this particular loyalty program. Use the search bar to narrow down the selection or find a specific recipient.

   <figure><img src="https://1181763860-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQvn8AaDGFgPJrQpDhaWn%2Fuploads%2Fptwm43XtgfOofRu4RpHY%2Fimage.png?alt=media&#x26;token=45b565ff-fd00-4e61-bc89-a284d9852742" alt=""><figcaption><p>Create Loyalty Program - Audience tab</p></figcaption></figure>
4. **Review & Save**\
   After all configurations, click the “**Submit**” button. Your program is now created and will appear in the Loyalty Programs listing screen. You can use the search bar above the list, towards the right, to  find a specific loyalty program.

### <mark style="color:blue;">**Viewing & Managing Loyalty Programs**</mark>

**Viewing a Loyalty Program**

On the **Loyalty Programs** screen, click on any existing program to view it's details. The details will appear on the right hand side of the page, as a pop up window. This information can also be accessed by clicking the 3 dot More menu next to the desired loyalty program, and selecting "**View Details**".

**Managing or Editing a Loyalty Program**

Click on the 3 dot More menu next to the desired loyalty program, and then "**Edit**". This will open the Edit Loyalty Program form. Use the **Next** button on the top right to access the subsequent pages. After making the desired changes click on the **Submit** button to finish making changes. To simply cancel the editing, click the **Cancel** button.

### <mark style="color:blue;">Switching Views & Filters</mark>

**Views**:

Next to the **Create** button on the right, there is a **Toggle Button** - use this to switch between:

* **Table View**: Displays leads in a tabular format.
* **List View**: Displays leads in a more detailed list format.

**Using the Search Bar**:

Using the Search bar will help you find a program faster. Type in the program name in the search bar, the possible results will appear in a list below.

**Using Filters**:

On the left, locate the **Filters**, which may be used to display the loyalty programs on the basis of several listed criteria. Use the filters on the left hand side, to display specific loyalty programs:

1. **Program Status & Timing**: Here you may choose to display on the basis of Status, and Programs Date Range.
2. **Program Type & Category**: The loyalty filter may be used to display leads that belong to a particular Program Type, Program Category, Trigger Type or Trigger Category.
3. **Audience/Segment**: Filter programs by Audience or Segment.

Use the **Apply** button at the bottom of the filters to apply selected filters, and the **Clear All** button on the top, to clear applied filters. Clear selected filters first, in order to apply any new filters.

### <mark style="color:blue;">Tips</mark>

Here are some tips for creating and managing loyalty programs:

* **Provide Comprehensive Details** – While some fields are optional, filling in details helps create a professional and detailed program, minimising the risk of creating duplicate or incomplete programs which may affect its impact.
* **Double-Check Mandatory Fields** – Before submitting the form, ensure that all required fields (marked with an asterisk \*) are completed to avoid any errors in creating the program.
* **Go over the page, before proceeding -** clicking the **Next** button on the top right will lead you to the next screen in the program creation form. In case you click **Next** and then wish to make changes in the previous screen, your selections and data may be reset. Hence, before proceeding to the next screen, go over your inputs carefully. In case you do need to go back, double check your inputs before proceeding (you may need to fill some fields again).

## <mark style="color:blue;">LOYALTY HISTORY</mark>

<mark style="color:blue;">Home page > Settings > Loyalty > Earnings> Loyalty History</mark>

### <mark style="color:blue;">Introduction</mark>

The Loyalty History page is critical and informative, as it will give you valuable information regarding the use of your Loyalty Programs. Here you can see various statistics such as Total Earned Coins, Redeemed Coins, as well as each loyalty related transaction.

### <mark style="color:blue;">Accessing the Loyalty History</mark>

* On the left-hand menu, hover over and click **'Settings'**.
* From the submenu, select **'Loyalty'**, click on '**Earnings**' and then **'Loyalty History'**.
* The **Loyalty History** screen will open.

### <mark style="color:blue;">Viewing & Managing the Loyalty History</mark>

On the **Loyalty History** screen, click on any existing loyalty transaction to view it's details. The Loyalty Usage details will appear on the right hand side of the page, as a pop up window. This information can also be accessed by clicking the 3 dot More menu next to the desired loyalty program, and selecting "**View Details**".

### <mark style="color:blue;">**Managing a Loyalty Transaction**</mark>

Next to a specific loyalty transaction, click on the 3 dot More menu and select "**Transaction History**". A pop up window will appear on the right with a list of the loyalty transactions of this particular user.&#x20;

Clicking on the 3 dot More menu next to a loyalty program, and then "**Adjust Points**" will allow you to grant points as a goodwill gesture, subject to your company policies. Simply fill in the small form by selecting the Adjustment Type and entering the Points with Reason for this adjustment. Click the **OK** button to apply the changes.

### <mark style="color:blue;">Switching Views & Filters</mark>

**Views**:

Next to the **Search bar** on the right, there is a **Toggle Button** - use this to switch between:

* **Table View**: Displays loyalty transactions in a tabular format.
* **List View**: Displays loyalty transactions in a more detailed list format.

**Using the Search Bar**:

Using the Search bar will help you find a loyalty transaction faster. Type in the program name or user name in the search bar, the possible results will appear in a list below.

**Using Filters**:

On the left, locate the **Filters**, which may be used to display the loyalty programs on the basis of several listed criteria. Use the filters on the left hand side, to display specific loyalty programs:

1. **Loyalty Information**: Here you may choose to display on the basis of Loyalty Program, Transaction type (earn or redeem) or Channel (Web, Mobile App or In-Store).
2. **Date Range**: Transactions will be filtered as per the dates you enter.
3. **Customer Information**: Filter transactions by Company Name, Customer Name, Mobile no, etc.
4. **Location Information**: You can filter by Longitude, Latitude.
5. **Trigger Information**: Choose a filter under Trigger Information to view transactions specific to a trigger type (birthday, anniversary, etc.) or Status.

Use the **Apply** button at the bottom of the filters to apply selected filters, and the **Clear All** button on the top, to clear applied filters. Clear selected filters first, in order to apply any new filters

### <mark style="color:blue;">Tips</mark>

Here are some tips for loyalty usage:

* **Provide Comprehensive Details** – A quick way to view a partner or influencer's transaction history is: next to any of their own loyalty transactions, click on the 3 dot More menu and select "**Transaction History**".&#x20;
* **Use filters** - Filters allow you to personalize your dashboard.

## <mark style="color:blue;">PRODUCT HISTORY</mark>

<mark style="color:blue;">Home page > Settings > Loyalty > Earnings> Product History</mark>

### <mark style="color:blue;">Introduction</mark>

The Product History page will give you details about your Products.&#x20;

### <mark style="color:blue;">Accessing the Product History</mark>

* On the left-hand menu, hover over and click **'Settings'**.
* From the submenu, select **'Loyalty'**, click on '**Earnings**' and then **'Product History'**.
* The **Product History** screen will open.

### <mark style="color:blue;">Managing the Product History</mark>

On the **Product History** screen, click on any existing product to view it's details. The Product details will appear on the right hand side of the page, as a pop up window. The first tab **About** will contain product information and the second tab **Earners** will display a list of Earners from this product. This information can also be accessed by clicking the 3 dot More menu next to the desired loyalty program, and selecting "**View Details**".

### <mark style="color:blue;">**Viewing (Filters) & Managing a Product**</mark>

**Sorting Products**: Using the up and down arrow button next to the Search bar will allow you to sort the products on the screen in ascending or descending order.

**Using the Search Bar**:Using the Search bar will help you find a loyalty transaction faster. Type in the program name or user name in the search bar, the possible results will appear in a list below.

**Using Filters**: On the left, locate the **Filters**, which may be used to display the loyalty programs on the basis of several listed criteria. Use the filters on the left hand side, to display specific loyalty programs:

1. **Product Information**: Here you may choose to display on the basis of a specific product name or product ID.
2. **Date Range**: Products will be filtered as per the dates you enter.
3. **Scan Metrics**: Filter transactions by Units, Value or Coins Earned.

Use the **Apply** button at the bottom of the filters to apply selected filters, and the **Clear All** button on the top, to clear applied filters. Clear selected filters first, in order to apply any new filters.

### <mark style="color:blue;">Tips</mark>

Here are some tips for viewing products:

* To see a list of Earners for a specific product, click the product itself and the earners will appear under the second tab **Earners**.&#x20;

## <mark style="color:blue;">ADJUST REASONS</mark>

<mark style="color:blue;">Home page > Settings > Loyalty > Earnings> Adjust Reasons</mark>

There are times when loyalty points for a customer need an adjustment. This could be a simple correction or even acase of bonus points awarded for special promotions or events. The reasons for adjustment of loyalty points can be set, and will appear on this page under 2 tabs:<br>

* Positive Adjustments: Reasons for adding bonus loyalty points.
* Negative Adjustments: Reasons for reducing loyalty points.
