You need to define a set of activities that will earn loyalty points for your customers. This document explains how those activities should be configured in ShopSocially's loyalty program.


Please follow the steps given below:


1. Log in to Merchant Centre.

2. Click Loyalty tab. By default the Activities tab is displayed which shows list of activities configured.

3. Click Add Activity tab. Refer to Figure: Configure Activity. No two activities can have the same name.


Figure: Configure Activity


Activities can be classified into two types:

  • Predefined activities: You will find a list of activities already created in your loyalty program. With the exception of Made a Purchase, all these activities happen through ShopSocially Apps and hence points can be awarded for those without any additional setup on the merchant's site.
  • Custom activities: Apart from the defined activities, you can create any number of custom activities that will earn points for your users. Custom activities are those that happen on the merchant site, independent of ShopSocially's Apps. So merchant needs to make an API call to award points whenever the said action occurs.


List of Predefined activities


Customers are rewarded when they take actions which match with the predefined activities. Below is a list of predefined activities:

  • Became a Twitter Follower: Someone gets points for following you on Twitter.
  • Became an Email Subscriber: Someone gets points after becoming an email subscriber.
  • Shared via Email: Someone gets points after sharing via email.
  • Connected via Facebook: Someone gets points after becoming an email subscriber.
  • Shared on Twitter: Someone gets points after sharing via Twitter.
  • Shared Photo via Mobile or Desktop: Someone gets points after sharing photo via mobile or desktop with Photomonial App.
  • Special Award: Through this activity you can manually award special points to user. This does not show up in earning opportunities on the user Loyalty Dashboard.
  • Made a Purchase: Though this is a predefined activity, this happens on the merchant's site and you need to make an API call to award points through this. For this activity, we have a built-in check to reject duplicate transactions for the same order ID. Duplicate transactions may occur if the user refreshes the 'Thank You' page leading to a repeat API call.

To award points for successful referrals through Refer-A-Friend program, you will need to set up activities with any of the Activity IDs mentioned below. You need to choose the activity based on when you wish to award the points to the referrer. This should also match what you communicate to your customers in the Refer-A-Friend program.

Table 1: Loyalty Activity IDs

Activity ID

Function

ss_referral_click_email

Award points for referral click through email share.   
ss_referral_click_facebook

Award points for referral click through Facebook post.

ss_referral_click_twitter

Award points for referral click through Twitter post.

ss_referral_click_pinterest

Award points for referral click through Pinterest post.

referral_purchase For awarding points for a successful referral purchase.


Please note: It is mandatory to use Activity IDs as is, mentioned above.  You can give Activity name of your choice.
Configuring an activity

Below example explains how to configure a custom activity. The example shows how to configure Made a Purchase activity.


Please follow steps given below:


1. In Loyalty, in Activities, click Made a Purchase  activity and provide:

  • Activity Name: Activity name which will be seen in the list of activities. Refer to Figure: Custom Activity 2, and Figure: Customer Loyalty Dashboard 2.
  • Activity ID: This field cannot be edited for predefined activities. 
  • Activity Description: Add a brief description of the activity here. This will be helpful when you review the activity in the future. Refer to Figure: Custom Activity 2, and Figure: Customer Loyalty Dashboard 2.
  • Type of Points Award: In this you can select whether you want to award 'Fixed Points' or 'Bonus Multiplier'. For fixed points, select 'Fixed Points' and number of enter points awarded for this activity. For bonus multiplier, select 'Bonus Multiplier'. Figure: Custom Activity 2. For example you may want to award 10 points for every $100 worth of purchases. To do so, you should select the 'Bonus Multiplier' option and enter 0.1 as the multiplier.
  • Qualified for Level change?: Select 'Qualified for Level change?' check box if you want the points earned through this activity to be considered for level change. 
  • Points Frequency: Define the frequency of points to be awarded. For example, points can be awarded 5 times a day, or 5 times a month, or 5 times a year or 5 times in a life time. This can act as a spam check. Figure: Custom Activity 2.
  • When Awarded: You can decide whether you want to award points immediately, manually, or after 30 days of the activity. Typically the period is after 30 days. These points are kept in Que for 30 days, so that if the user returns the product, the transaction is cancelled.
  • Points Earning URL:  This the URL where the customers/ visitors will be taken to see their points earned when they click on Earn Now. Refer to Figure: Custom Activity 2, and Figure: Customer Loyalty Dashboard 2.
  • Activity Image (36 X 36 px): Refer to Figure: Custom Activity 2, and Figure: Customer Loyalty Dashboard 2.
  • Show Activity in User Dashboard: Select this check box if you want to show this activity under Earn Points in the user's Loyalty Dashboard. For example, if you want to show activity “Make a Purchase” under “Earn Points” in the user's Loyalty Dashboard. Refer to Figure: Earn Points.

blob1476366105604.png

Figure: Earn Points


2. Click Create. Refer to Figure: Custom Activity 2.


blob1476366006103.png

Figure: Custom Activity 2


Refer to Figure: Customer Loyalty Dashboard 2 which depicts how the customers/ visitors will see their Loyalty dashboard.


Figure: Customer Loyalty Dashboard 2


Once the activity is configured, you need to program your website to call ShopSocially's API whenever a customer has to be awarded loyalty points for the particular custom activity. 

  • The API you have to call is:
ss_mi.award_loyalty_points (activity_id, points)
Where activity_id is the ID of the activity created in the loyalty dashboard. Please note: Points are mandatory for purchase activity. For all other custom activities, points are optional.
 

  • This JavaScript API will have success and callback handler with names:

window.ssmi_loyalty_award_success_handler(award_info) window.ssmi_loyalty_award_failure_handler(response).

  • In the success handler, the award_info consists of a json object with following structure:

{

"points" : "100",

"user_dashboard_url":"https://shopsocially.com/loyalty/dashboard/wonderblossoms"

"activity_name":"Made a purchase"

}

You should use this information to configure a notification widget which pops up and informs the customer about the loyalty points won.


  • In case of failure handler, the response will contain a json object with following structure:

{

"success":"false"

"reason" : "Internal server error"

}


Edit, Activate, and Pause an Activity

You can edit, activate or pause an activity. Please follow steps given below:

  • Edit: Click on the Actions tab available against a specific activity if you want to edit the activity. Edit activity and click Save. Refer to Figure: Actions 1.
  • ActivateClick on the Actions tab available against a specific activity if you want to activate the activity. Click Activate. Refer to Figure: Actions 1.

Figure: Actions 1


  • Pause: Click on the Actions tab available against a specific activity if you want to pause the activity. Click Pause. Refer to Figure: Actions 2.

Figure: Actions 2


Points Expiration Settings

This is the points expiration feature. To go to Points Expiration Settings, in Activities tab, click Settings. Refer to Figure: Points Expiration Settings.


Figure: Points Expiration Settings


The points expiration feature can be implemented in one of the two ways explained below. Please Note: By default, the feature will be set to 'No Expiration'. Also, in the Loyalty User Dashboard, in the transaction line-items, the expiration date is displayed in that line item.


1. Fixed Period Expiration: In this type of expiration, you will be able to configure the time period (in number of months) after which points for a particular activity will expire. For example, if 'Made a Purchase' activity has been configured to expire its points after 3 months, points earned for Purchase activity on October 1, 2015 will expire on January 1, 2016, points earned for Purchase activity on October 25, 2015 will expire on January 25, 2016, and so on. Please follow steps given below:

1. In Points Expiration Settings, select Fixed Period Expiration check box and provide:

Expiration Period

Activities whose points expire after a fixed period: Select activities from drop down. Refer to Figure: Fixed Period Expiration.

Click Save.


Figure: Fixed Period Expiration


2. Inactivity Based Expiration: In this type of expiration, you will be able to configure the inactivity period (in number of months) during which if there is absence of any activity that is supposed to keep the account active, all the available points will expire. For example, if you configure the inactivity period as 6 months, and specify 'Made a Purchase' activity as the activity that will keep the account active. If a user earns points for 'Became an Email Subscriber' on October 1, 2015, the points will expire on April 1, 2016. If the user comes back on October 20, 2015 and earns points for 'Wrote a Review', all the user's available points will still expire on April 1, 2016. However, if the user earns points for 'Made a Purchase' on November 10, 2015, 'Made a Purchase' being an activity that keeps the account active, the expiration date for all the available points will be reset to May 10, 2016, and so on. Please follow steps given below:

1. In Points Expiration Settings, select Inactivity Based Expiration check box.

2. Inactivity period

3. Activities that keep an account active: Select activities from drop down. Select activities from drop down. Refer to Figure: Inactivity Based Expiration.


Figure: Inactivity Based Expiration


Refer to Figure: Points Expiration User Loyalty Dashboard, which depicts how the user will see the points expiration date in Points Activity on the user's Loyalty Dashboard.

Figure: Points Expiration User Loyalty Dashboard


Edit Points Expiration Settings


You can edit Points Expiration Settings


Please follow steps given below:


1. If you want to edit and set all the activities to No Expiration, in Points Expiration Settings, select No Expiration check box.

2. Alternatively, if you wish to edit points expiration settings for specific activities, select Fixed Period Expiration, or Inactivity Based Expiration check box, where you want to make changes. Select or clear check box against required activities and click Save.