Reward Points Pro User Guide

From MageWorld Wiki
(Redirected from RewardPointsPro-user-guide)
Jump to: navigation, search

Contents

Configuration

From the backend panel, the administrator can easily configure the Reward Points Pro module at System => Configuration => Mage World => Reward Points Pro or Promotions => Reward Points Pro => Configuration

General

  • Enable the module by selecting "Yes" in the Enable Reward Points Pro field
  • In the Points/Currency Exchange Rate field, insert a value with the type of x/y to define the exchange rate.
  • In the Redeem points in increments of field, the default number is 1. You can insert any integer which will be used for spending points on cart.
  • In the Calculate Reward Points Earned field (Before Discount/ After Discount), allow rewarding points before or after the discount.
  • In the Calculate Reward Points Earned field (Before Tax, After Tax), allow rewarding points before or after the Tax.
  • In the Calculate to TAX field, allow to calculate TAX before or after redeem points.
  • In the Extend shopping cart page to display reward point block field, select “Yes” for the cart page to be extended. In case you have any other module work on the cart page, you can insert the code manually (Please see more details at Display Reward Points in Shopping cart page in the Theme integration section)
  • In the Allow using reward points and coupon code at the same time field, select “Yes” if you want to use both reward points and coupon code at the same time.
  • In the Minimum points required to be redeemed per purchase field, the default number is 0. You can define the minimum points which customers can use for each purchase (enter 0 or leave it empty if no limitation).
  • In the Maximum points allowed per account field, the default number is 0. You can set number of maximum points that an account can have. If a customer’s balance reaches this value, he/she cannot earn points anymore (enter 0 or leave it empty if no limitation).
  • In the Add reward points to account balance when order status is field, choose the status of the order. If the order is switched to this status, the points will be added to the account balance.
  • In the Subtract earned points when order is refunded field, select “Yes” for automatically subtracting points when the order is refunded.
  • In the Restore redeemed points when order is refunded field, select “Yes” for automatically restoring redeemed points back to balance on refunded orders.
  • In the Default Comment when importing points from CSV file field, insert a note that will be used as a comment for the transaction of importing points from CSV file.
  • In the Default Reward Point Expiration (in days) field, insert an integer (enter 0 or leave the field empty if the Reward Points will not expire).


caption

Display Configuration

caption
  • You can choose to display Unit names of reward points, Reward points Icon on the frontend.
caption
  • In the Reward Icon field, you can upload a reward icon and specify the link that it will direct to in the Link Reward Icon to field.
  • Select "Yes" for the Add option to show credit info field to display the amount of money, which is equivalent to the number of points customers have.
caption

Share Reward Points

caption

In the Allow sending points to friends field, select "yes" to allow customers to send points to their friends
In the Sending point transaction to expire after (set hours) if not accepted by friend field, enter the expiration time for the sent points back to the sender’s account, if the friend has not registered after that time yet.

Facebook Configuration

The Reward Points Pro extension allows shop owners to reward customers for clicking the "Like" button. Please enter the Application ID and Key into this field:

caption

Email Notification

The Reward Points Pro offers email templates for notifying customers of balance changes and sending point transactions. The administrator can enable this feature in the Enable notifications field.

In the Reminder email sent before points expire (in # of day) field, you can define the time of notification . Before a period of time that the points , customer will receive a reminder email.

caption

Earning Rules

To give customers the ability to earn points, please create earning rules at Promotions => => Reward Points Pro => Earning Rules.
The earning rules include four types: catalog rules, product reward points, shopping cart rules and customer behavior rules.

Catalog earning rule

The administrator can use catalog rules to reward points on a single product.

Add new catalog rules

From the Admin Panel, go to Promotions => Reward Points Pro =>Earning Rules => Catalog Earning Rules; click the button <Add a new rule>.

  • A catalog rule includes three tabs: rule information, conditions and actions.
caption
  • Set the name, description, executing priority, status, store view, customer group and active time for the rule at the rule information tab.
  • Set conditions to apply rewarded points for particular items at the conditions tab.
caption
  • Set the number of points will be rewarded on items that meet the condition.
caption
  • Stop further rules processing: will be explained in the Note for multiple rules part.

Reward points will be visible on the catalog page and product detail page of the products that satisfy the catalog reward rules. (To show points on these pages please see the Theme Integration section)


caption

For Example:
We have three rules as follows:
Rule 1: Reward 99 points for products with the attribute set “Cell Phone”. (The Priority is 1)
Rule 2: Reward with the rate of 1/4 (buy $4 got 1 point) for products with the price of being equal to or greater than $200. Select Yes in the Stop further rule processing field. (The Priority is 2)
Rule 3: Reward 15 points for all products. (The Priority is 3)
If the Stop further rules processing field is selected "Yes", the next rules will not be applied. Therefore, let’s consider the product Sony Ericson with the prices of $399, which satisfies 3 rules above. When a customer buys this product, he will receive 99 points for the first rule, 100 points for the second rule and the third rule will not be applied.

Individual Reward Points

The administrator can add reward points for particular products by inserting manually or importing points via CSV.
From the Admin Panel, go to Promotions => Reward Points => Earning Rules => Individual Reward Points.

caption

Insert points into the Reward Points Earned column, then save products or click on Import product reward points to upload the CSV file.

Here is a sample of CSV file (attached in the package, named rewardpoints_product.csv).

caption

Shopping cart earning rule

The Shopping cart rules tab allows the administrator to reward points based on the Magento shopping cart rules (reward points on the order).

Add a new rule
From the Admin Panel, go to Promotions => Reward Points => Earning Rules => Shopping Cart Earning Rules, click on Add a new rule.

A shopping cart rule includes three tabs: rule information, conditions and actions.
Set the name, description, execute priority, status, store view, customer group and active time for a rule at the rule information tab.

caption

Set conditions to apply rewarded points for particular items at the conditions tab.

caption

Set the total number of points rewarded on the cart (Fixed Reward Points – for a single item, Fixed Reward Points for the Whole Cart, Spend Y get X Reward Points and Spend Y get X Reward Points for Whole Cart ).

caption

Reward Points will be visible on the shopping cart page (the total number of rewarded points for the whole order).

caption

Customer behavior rules

From the backend page, go to Promotions => Reward Points => Earning Rules => Customer Behavior Rules

caption

Add a new rule

caption

There are 14 defined rules, basing on customer behaviors.

You can set the Reward Points Expire time for every reward behavior rule. If you want to use Expire Time of the default configuration, tick on the check box Use default point expiration time.

Custom Reward

Shop owner can also create a custom reward. With Custom Reward rule, Shop owner can reward customers by using Referral Link or Coupon Code.
When you select this behavior, please click on <Save and continue edit> to see the Referral Link, which is generated automatically. You can send this link to customers for them to earn points within this rule. In case the customer has not registered, he/she can sign up and receive points as normal.

Shop owner can enter the Coupon and reward customers. Custmers use the Coupon to get points at My Account -> My Reward Points

caption

Spending Rules

The administrator can manage flexible spending rules. Those rules decide which products at the cart page can be spent on and how many points can be used on the whole order or a single product.

Add a new rule

From the Admin Panel, go to Promotions => Reward Points => Spending Rules, click on Add a new rule.

  • A spending rule includes three tabs: rule information, conditions and actions.
  • Set the name, description, execute priority, status, store view, customer group and active time for a rule at the rule information tab.
  • Set conditions to apply spent points for the whole cart or particular items at the conditions tab.
caption
  • The Action tab allows setting the maximum number of points to be applied on the cart. There are four values to select: fixed points, buy X allow using Y, unlimited points and not allow using points.
  • Spending rules will be displayed at Use your rewarded points area on the shopping cart page.
caption

Adding/Subtracting points by the administrator

From the Admin Panel, go to Promotions => Reward Points => Customer Accounts, you can see lists of customers and their balances.

caption

The administrator can add or subtract points for the customers manually or import points via CSV.

Add/Subtract points for the customers manually

  • Select a customer by double-clicking the mouse.
caption
  • Insert a value for the Amount field and select the necessary action.
  • The comment that you inserted will be updated in the transaction history as well.

Also, you can check the customer’s transaction details by navigating to the Transaction History tab.

caption

Add/Subtract points for the customers Via CSV

From the Admin Panel, go to Promotions => Reward Points => Customer Reward Points

caption

Click the button “Import Reward Points”, upload the CSV file, and then click the button “Import”.

caption

A sample of the CSV file (attached in the package – rewardpoints.csv):

caption

Sell Product In Points

To set points as price for products, go to Promotions => Reward Points => Sell Products in Points

caption

Frontend overview

caption

All Transaction History

From the Admin page, go to Promotions => Reward Points Pro => All Transaction History, this page lists all transaction history.

caption

Reports

The administrator can follow all activities of reward points and redeemed points at Promotions => Reward Points Pro => Reports.

Reports tab includes 4 sub-tabs: Overview, All transactions, Rewarded points, Redeemed points.

caption

Overview

The report can be displayed in different time ranges “Last 24h, Last week, Last month, Last 7 days, Last 30 days or Custom”

caption

In the dropdown of Date Range fields, select one of the predefined periods for report data aggregating:
+ Last 24h
+ Last week
+ Last month
+ Last 7 days
+ Last 30 days
+ Custom

=> Click on the Refresh button.
- Line Chart displays total rewarded points and total redeemed points by in chosen time range.
- Pie Chart presents percentages of rewarded points by in chosen time range for the following 7 groups of rewarded activities:

+ Purchase
+ Account Signup
+ Writing Review
+ Referral
+ Newsletter subscription
+ Customer’s birthday
+ Others (voting poll, special events, tagging product, custom reward, facebook like or share, rewarded by admin)

- Statistics box on the right side shows: Total rewarded points, total redeemed points, average rewarded points per customer, average rewarded points per order and average redeemed points per order in chosen time range.
- Top Customers box on the right side shows 5 top customers who have highest rewarded point balances.

All transactions

In the From and To fields, use calendar icon to specify the starting and ending dates of the period for report data aggregating.
In dropdown of the Show By field, select type of showing by Day, Month, and Year.

=> Click on the Refresh button

The system shows detail information about: Total Rewarded, Total Redeemed, Number of Orders, Number of Sign Ups (Account Registering), and Number of Customers by in chosen time range.

caption

In the Export to field, select the CSV or Excel option and click on the Export button to export the report information.

Rewarded points

In the From and To fields, use calendar icon to specify the start and end dates for of the period for report data aggregating.
In dropdown of the Show By field, select type of showing by Day, Month, Year.

=> Click on the Refresh button
The system shows detailed information about: Total Rewarded points, Rewarded on Purchase, Rewarded on Sign-Ups, Rewarded on Subscribers (Newsletter subscription), Rewarded on Reviews, Rewarded on Birthday, Rewarded on Referrals, Others Rewarded, and Total Transactions.

caption

In the Export to field, select the CSV or Excel option and click on the Export button to export the report information.

Redeemed Points

In the From and To fields, use calendar icon to specify the start and end dates for of the period for report data aggregating.
In dropdown of the Show By field, select type of showing by Day, Month, Year.

=> Click on the Refresh button
The system shows detail information about: Total Redeemed points, Number of Orders, Average Redeemed per Order, Total Sales, Total Discounts.

caption

In the Export to field, select the CSV or Excel option and click on the Export button to export the report information.

Theme Integration

Display points in Create an account page

caption

Please go to 2 files:

app/design/frontend/default_package/your_theme/template/customer/form/register.phtml
or 
app/design/frontend/default_package/your_theme/template/persistent/customer/form/register.phtml

Find the syntax code below:

<div class="account-create">
<--! INSERT CODE HERE-->
Copy the code below into the section 
<--! INSERT CODE HERE-->:
<?php echo Mage::helper('core/mwrewardpoints')->pointsCreateAccountRewardPoints(); ?>

Display points in Product reviews form

caption

Please go to the file:

app/design/frontend/default_package/your_theme/template/review/form.phtml

Find the syntax code below:

<?php if ($this->getAllowWriteReviewFlag()): ?>
<--! INSERT CODE HERE-->
Copy the code below into the section 
<--! INSERT CODE HERE-->:
<?php echo Mage::helper('core/mwrewardpoints')->pointsProductReviewRewardPoints(); ?>

Display points in Submit polls block

caption

Please go to the file:

app/design/frontend/default_package/your_theme/template/poll/active.phtml

Find the syntax code below:

<button type="submit" title="<?php echo $this->__('Vote') ?>" class="button">
   <span><span><?php echo $this->__('Vote') ?></span></span>
</button>
<--! INSERT CODE HERE-->
Copy the code below into the section 
<--! INSERT CODE HERE-->:
<?php echo Mage::helper('core/mwrewardpoints')->pointsSubmitPollRewardPoints(); ?>

Display points in Subscribe to the newsletter form

caption

Please go to 2 files:

app/design/frontend/default_package/your_theme/template/customer/form/register.phtml
or
app/design/frontend/default_package/your_theme/template/persistent/customer/form/register.phtml

Find the syntax code below:

<?php if ($this->isNewsletterEnabled()): ?>
<--! INSERT CODE HERE-->
Copy the code below into the section 
<--! INSERT CODE HERE-->:
<?php echo Mage::helper('core/mwrewardpoints')->pointsSignUpNewLetterRewardPoints(); ?>

Display points in Category pages

caption

Please go to the file:

app/design/frontend/default_package/your_theme/template/catalog/product/list.phtml

- In List mode (Only use for Magento Community Edition(CE) 1.8.X and earlier versions , with CE 1.9.X then skip this part)

Find the syntax code below:

- In List mode
<?php if($_product->isSaleable()): ?>
 <p>
   <button type="button" title="<?php echo $this->__('Add to Cart') ?>" class="button btn-cart" 
   onclick="setLocation('<?php echo $this->getAddToCartUrl($_product) ?>')">
   <span><span><?php echo $this->__('Add to Cart') ?></span></span>
   </button>
 </p>
 <?php else: ?>
 <p class="availability out-of-stock"><span><?php echo $this->__('Out of stock') ?></span></p>
 <?php endif; ?>
<--! INSERT CODE HERE-->
- In Grid mode
<?php echo $this->getPriceHtml($_product, true) ?>
<--! INSERT CODE HERE-->
Copy the code below into the section 
<--! INSERT CODE HERE-->:
<?php echo Mage::helper('core/mwrewardpoints')->pointsProductListRewardPoints($_product); ?>

Display points in Products Pages

Please go to the file:
app/design/frontend/default_package/your_theme/template/catalog/product/view.phtml

Find the syntax code below:

<?php if ($_product->getShortDescription()):?>
<--! INSERT CODE HERE-->
Copy the code below into the section 
<--! INSERT CODE HERE-->:
<?php echo Mage::helper('core/mwrewardpoints')->pointsProductDetailRewardPoints($_product); ?>

Display Reward Points in Shopping cart page

For the cart.phtml, you can automatically rewrite it by going to Admin/ Reward Points Pro/Configuration , and selecting “Yes” in the Extend shopping cart page to display reward points block field

caption

In case that you want to do this manually (avoid conflicts with other modules that also rewrite cart.phtml), you can follow these directions:

Please go to the file:

app/design/frontend/default_package/your_theme/template/checkout/cart.phtml

Find the syntax code below:

<?php echo $this->getChildHtml('coupon') ?>
<!--INSERT CODE HERE -->
Copy the code below into the section 
<--! INSERT CODE HERE-->:
<?php echo Mage::helper('core/mwrewardpoints')->formRewardShoppingCartRewardPoints(); ?>


Display the redeemed points in review part in Checkout process

Display the redeemed reward points in the review order part at the checkout page.

caption

- For Magento Community Edition (CE) 1.8.X and earlier versions:

Please go to the file:

app/design/frontend/default_package/your_theme/template/checkout/onepage/review/totals.phtml

- For Magento Community Edition (CE)1.9.X :

app\design\frontend\base\default\template\checkout\onepage\review/totals.phtml

1/Find the syntax code below:

<?php $_colspan = $this->helper('tax')->displayCartBothPrices() ? 5 : 3; ?>
<!--INSERT CODE HERE -->
Copy the code below into the section 
<--! INSERT CODE HERE-->:
<?php echo Mage::helper('core/mwrewardpoints')->earnPointsOnepageReviewRewardPoints(); ?>

2/Find the syntax code below:

<?php echo $this->renderTotals(null, $_colspan); ?>
<!--INSERT CODE HERE -->
Copy the code below into the section 
<--! INSERT CODE HERE-->:
<?php echo Mage::helper('core/mwrewardpoints')->totalPointsRedeemOnepageReviewRewardPoints(); ?>

Display points in My Account

caption

Please go to the file:

app/design/frontend/default_package/your_theme/template/page/template/links.phtml

Find the code:

<!--INSERT CODE HERE -->
<?php echo $_link->getAfterText() ?>
Copy the code below into the section 
<--! INSERT CODE HERE-->:
<?php echo Mage::helper('core/mwrewardpoints')->pointsTopLinkRewardPoints($_link); ?>


Show point balance on my reward points menu

caption

Please go to the file:

app/design/frontend/default_package/your_theme/template/customer/account/navigation.phtml

Find the code:

echo $_link->getLabel()
And replace it by the code:
echo $_link->getLabel().Mage::helper('core/mwrewardpoints')->pointsMyAccountRewardPoints($_link);

Display facebook like and share button in product detail page

You can reward points for your customers, after you created a Facebook Like or Share Behavior Rule.
Open the file

app/design/frontend/default_package/your_theme/template/catalog/product/view.phtml

Find the code below

<?php if ($_product->getShortDescription()):?>
<--! INSERT CODE HERE-->:
Copy the code below into the 
<--! INSERT CODE HERE--> section:
<?php echo Mage::helper('core/mwrewardpoints')->showFacebookRewardPoints(); ?>

At the frontend you will see as below


caption

Display earned points in mini cart

Note : Only use for Magento Community Edition (CE)1.8.X and earlier versions, CE 1.9.X then skip this part.

Open the file:

app/design/frontend/default_package/your_theme/template/checkout/cart/sidebar.phtml

Find the syntax below

<--! INSERT CODE HERE-->
<?php endif ?>
<?php if($_cartQty && $this->isPossibleOnepageCheckout()): ?>
Copy the code below to the section 
<--! INSERT CODE HERE-->:
<?php echo Mage::helper('core/mwrewardpoints')->pointsMiniCartRewardPoints(); ?>


Display the Reward Points form on one page check out

Magento Default
Open the file:

app/design/frontend/default_package/your_theme/template/checkout/onepage/payment.phtml

Find the syntax below <--! INSERT CODE HERE-->

<form action="" id="co-payment-form">
Copy the code below to the section 
<--! INSERT CODE HERE-->:
<?php echo Mage::helper('core/mwrewardpoints')->formRewardOnepageCheckoutRewardPoints(); ?>


Mage World one step check out
Open the file:

app/design/frontend/default_package/your_theme/template/mw_onestepcheckout/daskboard/onepage/payment.phtml

Find the syntax below

<--! INSERT CODE HERE-->
<div  id="co-payment-form">
Copy the code below to the section 
<--! INSERT CODE HERE-->:
<?php echo Mage::helper('core/mwrewardpoints')->formRewardOnepageCheckoutRewardPoints(); ?>

And
Edit the file ( If you are using the OneStepCheckout 3.30 above, you can ignore this file)

app/design/frontend/default_package/your_theme/template/mw_onestepcheckout/daskboard.phtml

Find the code below:

after code: (in the function updateShippingMethod() )
<--! INSERT CODE HERE-->:
<?php if(Mage::getStoreConfig('onestepcheckout/ajax_update_other/ajax_shipping_payment')):?>
	updatePaymentType();
<?php endif;?>
Copy the code below to the section 
<--! INSERT CODE HERE-->:
if($MW_Onestepcheckout('#mw-checkout-payment-rewardpoints').length)
{
	updateRewardpointsForm();
}
caption

Display the invitation block

The Reward Point Pro supports importing contacts from popular email services.
We provide a syntax code for adding to the template that you want to show:

<?php echo Mage::helper('core/mwrewardpoints')->showInvitationRewardPoints(); ?>

Web services API

Overview

The Reward Points Pro extension allows accessing data via Web services API, so you can intergrate Reward Points Pro with a third party system. You can allow any one (your affiliates, your suppliers…) to have the permission to access the API .

API Setup

To allow a person to access your site via the API, firstly you must define a role, then create an account to play this role.

From the backend, go to System => Web Services => SOAP/XML-RPC-Roles, and select Reward Points API in Role Resources

caption

From the backend, go to System => Web Services => SOAP/XML-RPC-Users

caption

API Documentation

1. Get Customer ID by Email
Description: Get Customer ID by e-mail and website id.
Name: getcustomeridbyemail
Parameter #1: Customers’ e-mail address, for example: john.doe@example.com
Parameter #2 : website id
Example code:

<?php 
    try {
		$client = new SoapClient('http://YOURSITEURL.COM/api/soap/?wsdl');
		$session = $client->login('USER_NAME', 'PASSWORD'); 
		// these are your API client credentials configured in the Magento back-end.
		$result = $client->call($session, 'rewardpoints.getcustomeridbyemail', array(array('CUSTOMER@EMAIL.COM'),WEBSITE_ID));
		echo $result;
		$client->endSession($session);
	
	}catch(Exception $e)
	{
    echo "Cannot connect to server. Please try again later.";
    return;
	}
	?>

2. Get balance by Customer ID
Description: Get a customer's point balance by Customer ID by e-mail and website id.
Name: getbalancebyid
Parameter #1: Customer ID
Example code:

<?php 
	try {
		$client = new SoapClient('http://YOURSITEURL.COM/api/soap/?wsdl');
		$session = $client->login('USER_NAME', 'PASSWORD');
		// these are your API client credentials configured in the Magento back-end.
		$result = $client->call($session, 'rewardpoints.getbalancebyid', array(CUSTOMER_ID));
		echo $result;
		$client->endSession($session);
	
	}catch(Exception $e)
	{
    echo "Cannot connect to server. Please try again later.";
    return;
	}
?>

3. Get balance by email
Description: Get a customer's point balance by customer’s E-mail and website id.
Name: getbalancebyemail
Parameter #1: Customer’s Email
Parameter #1: website id
Example code:

<?php 
	try {
		$client = new SoapClient('http://YOURSITEURL.COM/api/soap/?wsdl');
		$session = $client->login('USER_NAME', 'PASSWORD'); 
		// these are your API client credentials configured in the Magento back-end.
		$result = $client->call($session, 'rewardpoints.getbalancebyemail', array(array('CUSTOMER@EMAIL.COM',WEBSITE_ID))); 
		// track by customer email and store id - store that customer was registered in.
		//$result = $client->call($session, 'rewardpoints.getbalancebyemail', array('CUSTOMER@EMAIL.COM')); 
		// can use the customer email only
		echo $result;
		$client->endSession($session);
	
	}catch(Exception $e)
	{
    echo "Cannot connect to server. Please try again later.";
    return;
	}
?>

4. Update balance for a customer by customer ID
Description: Update (add, substract) a customer's point balance by Customer ID.
Name: getbalancebyemail
Parameter #1: Customer ID
Parameter #2: A number of points is added or subtracted. If subtracted, it must have ‘–‘.
For example: -100.
Parameter #3: Comment for this update
Example Code:

<?php 
	try {
		$client = new SoapClient('http://YOURSITEURL.COM/api/soap/?wsdl');
		$session = $client->login('USER_NAME', 'PASSWORD'); 
		// these are your API client credentials configured in the Magento back-end.
		$result = $client->call($session, 'rewardpoints.updatepoints', array(array(CUSTOMER_ID, POINTS,'REASON')));
		echo $result;
		$client->endSession($session);
	
	}catch(Exception $e)
	{
    echo "Cannot connect to server. Please try again later.";
    return;
	}
?>

For example:

Add 100 points for a customer having ID 1 with the reason “added by admin”

$result = $client->call($session, 'rewardpoints.updatepoints', array(array(1, 100,'added by admin')));

Subtract 100 points for a customer having ID 1 with the reason “subtracted by admin”

$result = $client->call($session, 'rewardpoints.updatepoints', array(array(1, -100,'subtracted by admin')));


From the client’s point of view

Manage reward points balance

The customer can view their balance and transaction history by going to My Account/ My Reward Points

caption

Refer a friend

From the frontend panel, go to My Account/My Invitation, the module offers sharing tools for customers to refer their friends via social networks, website or email.


caption

Use Points

caption
Personal tools
Namespaces

Variants
Actions
Navigation
General
Free Gift
Onestep Checkout Pro
Reward Points Pro
Reward Points Lite
Affiliate Pro
Affiliate Lite
Help Desk Pro
Daily Deal
Easy Banner
Cms Pro
Mega Menu
Follow Up Email
Easy Testimonial
Easy FAQ
Store Credit Pro
Ajax Cart Pro
Promobox
Delivery Schedule
Social Gifts
Toolbox