User Guide for Laravel eCommerce Reward Point

• Admin can add Category based rewards.
• Admin can add Product based rewards.
• Admin can add Cart based rewards.
• Admin can add Attribute based rewards.
• The reward is based on configured reward rules or the highest reward point prioritized (if no rules configured).
• Admin can view all the users and all the rewards based on the order.
• Admin will add reward redemption point rule.

• Unzip the respective extension zip and then merge “packages” and “public” folders into project root directory.

• Go to composer.json file and add following line under ‘psr-4’

"Webkul\\Rewards\\": "packages/Webkul/Rewards/src"

Run composer dump-autoload to autoload the files

composer dump-autoload

Go to bootstrap/providers.php file and add following line under ‘providers’

use Webkul\Rewards\Providers\RewardsServiceProvider;

inside return [...]

RewardsServiceProvider::class,

• Run the module installation command to setup the reward points module

php artisan rewards:install

php artisan optimize:clear

now execute the project on your domain.

After the successful installation of the module the admin needs to navigate to Rewards points>>General Settings as shown in the image below:-

Module Status:- The admin can enable or disable the module.

Reward When Customer Register:- Set the reward points allocated to a customer for registering themselves.

After How many days the Reward Point Expire on Customer Register:- Set the number of days after which the rewards on register will expire.

Reward For Customer Date Of Birth:- Customers can get reward points on their birthday.

After How many days the Reward Point Expire on Customer Date Of Birth:- Set the number of days after which the rewards on customer birthday will expire.

Reward when Product Reviewed:- Set the reward points allocated to a customer on product review.

After How many days the Reward Point Expire on Product Reviewed:- Set the number of days after which the rewards on product review will expire.

After how many days the Reward Point expires on Product Purchase:- Set the number of days after which the rewards on product purchase will expire.

After how many days the Reward Point expires on Product Category:- Set the number of days after which the rewards on product category (earned) will expire.
After how many days the Reward Point expires on Product Attribute:- Set the number of days after which the rewards on product attributes (earned) will expire.
After how many days the Reward Point expires on Cart Reward :- Set the number of days after which the rewards on earned on cart will expire.

Reward Point Used At One Time:- Maximum reward points can be used at purchase time.

Email Notifications:- Enable or Disable email notifications.

To enable the reward point on products just navigate to the Reward Points>>Reward Point on Product as shown in the image below:-

Reward Point on Product

To add the reward point on the product click on add product reward a page will generate that will look as shown in the image below:-

Enter Reward Points:- Here the admin needs to enter the reward points.

Select Products:- In this field, the admin needs to search the product from the search field.

Status:- From here the admin can also enable or disable the reward point on product.

Reward Point on Product for Specific time.

To add the reward point on the product for a specific time click on reward point on product for specific time a page will generate that will look as shown in the image below:-

Click on add product specific reward a page will generate that will look like shown below:-

• Enter Reward Points:- Here the admin needs to enter the reward points.
• Select Product:- Search the product from the search field.
• Start Date:- Select the Start Date.
• End Date:- Select the end date.
• Status:- Active or Inactive reward point from here.

Same as products the admin can also set the reward points for Category also as shown in the image below:-

The admin also needs to enter the reward points, Select the category and enable the status.

Admin can also set reward on the category based on the specific time just like for products as shown in the image below:-

The admin just needs to enter all the details like rewards points, select the category, and also the start date and end Date.

The admin can also set the reward point on the cart as shown in the image below:-

• Under the Add Cart Reward Point, there are several fields:-
• Enter Reward Points:- Enter the reward points here.
• Amount From:- Enter the initial amount here for the reward.
• Amount To:- Enter the final amount here for the reward.
• The admin also needs to enter the start date, and end date and also need to activate the status.

Attribute Reward Details

The admin can see all the attribute rewards as shown in the image below :-

• Click on “Create Reward Point on Attribute”.
• Enter Reward Points:- Enter the reward points here.
• Select Attribute from the available Attribute lists.
• Select status as active to enable the attribute reward.
• Save the reward to reflect it on the specified attribute products.

Reward Rules

Admin can see all the reward rules created as well as can create new reward rule based on conditions as shown below in the picture :-

Now clicking on “Create Reward Rules” will open a new page which will be used for creating rules as shown below in the picture :-

Reward Rule is a feature specially designed with meeting with the scenarios in which 2 or more than 2 reward rules are matching in this condition admin can decide to provide the reward type which configured from the admin reward rule engine.

By default if no rule has been integrated in combined situation, then the highest reward point prioritised will be given.

The admin can see all the reward system details as shown in the image below:-

To see in detail click on the eye icon under the action, the page that generates will look like shown below:-

Under this the admin can perform several redemption settings as shown in the image below:-

• The admin can allow customers to apply points during checkout.
• The admin can also set the conversation rate for cart subtotal redemption.
  for example:- 1 point=$1
• The admin can also enable to apply points during checkout.

When the customer register, If the admin has provided the reward for registration that will be visible in the customer profile as shown below: –

In the product page, the details regarding the reward point is visible like shown in the below image:-

The reward points are also visible on the order summary page.
The customer needs to enter the points, The customer can use either the registration points or the other points to have been awarded.

Now, customers can apply the reward point by clicking on “Apply Rewards Points” from the summary cart.

**Note:-

• If the product falls under all the reward points like Product, Category, and Cart.
• Specified reward point would be given as configured into reward rule engine
• For example,
• Cart rule specific rule is granting 20 points
• Category rules specific reward rules grants 10 points
• Product rules specific reward rules grants 10 points.
• In this situation if reward rule is being created from the reward rule engine in module then suppose in meeting with all these 3 situations “Category Reward” would be granted then only “Category Reward” would be given.
• Otherwise if no reward rule has been set then only highest reward point (here Cart Rule gives 20 points) would be by default given.

The admin can also see the reward points in the order details in the admin panel.

So, that was all about the User Guide of Laravel eCommerce Reward Points. For any queries or doubts, reach out to us at support@webkul.com.

You can also raise a ticket at our HelpDesk System. Please explore our Laravel Development Services and Quality Bagisto Extensions.