1. Home
  2. Docs
  3. Magento 2 Sale Motivation Extensions
  4. Magento 2 Reward Points
  5. Installation Guide

Installation Guide

After finishing purchasing process, we will immediately send you an email containing the link to download this extension.

Before installing, please note that we provide you lists of Restful API and GraphQL API supported by the module. Let’s take a look at these lists in the User Guide.

  • Restful API support is included in the main module package (from Magento 2 Reward Points v1.0.3).
  • GraphQL API support is included in the GraphQL package, acting as an add-on for anyone who needs to use GraphQL.

If you want to use Restful API, just follow the section 1 in this guide to install the main package.

In case you want to use GraphQL API, please follow both sections.

(Please turn off Merge-JS before installing the module. Only Turn on Merge-JS when finishing the installation).

1. Install the extension

1.1. Install via App/Code

Step 1:

Unzip the file.

Step 2:

Create another directory called app/code/Bss/RewardPoint/.
RewardPoint is the module's internal identifier. You can find it in the "composer.json" file in the extension ZIP file you downloaded, look at the node "psr-4".

This is what you call the directory, and then you put the contents of the extension ZIP file in there.

Step 3:

Upload the directory app/code/Bss/RewardPoint/ into the root directory of your Magento installation. The root directory of Magento is the directory that contains the directories "app", "bin", "lib" and more. All directories should match the existing directory structure.

Step 4:

Go to Magento 2 root directory.

Run: php bin/magentosetup:upgrade.

Step 5:

Run: php bin/magentosetup:static-content:deploy.

Step 6:

Run: php bin/magento setup:di:compile

Step 7:

Clear all Caches.

1.2. Install via Composer

Besides installing Magento 2 extensions via App/Code, installing via Composer is another very common and simple way used by a lot of Magento users.

Follow the guide here.

2. Install/Uninstall/Disable the GraphQL package

The following instruction is used for the GraphQL package ONLY.

2.1. To install the GraphQL package, run commands:

- php bin/magento module:enable Bss_RewardPointGraphQl

- php bin/magento setup:upgrade

- php bin/magento setup:static-content:deploy

2.2. To disable the GraphQL package, run commands: 

- php bin/magento module:disable Bss_RewardPointGraphQl

- php bin/magento cache:flush

2.3. To uninstall the GraphQL package, run commands:

- bin/magento module:disable Bss_RewardPointGraphQl

- remove directory from app/code manually

- bin/magento setup:upgrade

- bin/magento cache:flush

3. Install/Uninstall/Disable the Hyva Theme Compatibility package

The following instruction is used for the Hyva theme compatibility package ONLY.

3.1. To install the Hyva compatibility package: 

Step 1: Install the extension by the above Composer (If you have already installed the module, then skip this step)

Step 2: Install the Hyva compatibility package:

a.  Install via composer, run commands:

- run command: composer config repositories.bsscommerce composer <path>
with path is:
+ https://composer.bsscommerce.com/community if you want to install Community extension only
+ https://composer.bsscommerce.com/enterprise if you want to install Enterprise extension only
- run command: composer require hyva-themes/magento2-bsscommerce-reward-point

b. Enable module, run command:

- php bin/magento setup:upgrade

3.2. To disable the Hyva compatibility package, run command: 

- php bin/magento module:disable Hyva_tên_module

3.3. To uninstall the Hyva compatibility package:

- backup file composer.lock

- run command: composer remove hyva-themes/magento2-bsscommerce-reward-point

- run command setup:upgrade

*Note 1 :

When installing module, you need to run the following commands to receive css:

- bin/magento hyva:config:generate

Adding the file including tailwind css: "src": "vendor\/hyva-themes\/magento2-bsscommerce-reward-point\/src" to file app/etc/hyva-themes.json

- cd /path/vendor/hyva-themes/magento2-default-theme/web/tailwind/

(This path is for theme Hyva default in your site)

- cd /path/to/project/app/design/frontend/VendorName/ModuleName/web/tailwind/

(This path is for custom theme in your site)

- npm run build-prod

*Note 2: 

  • This module needs to install the Hyva compat base module.
  • After installing, navigate to Stores > Bss Commerce > Hyvä Theme Compat Base > Rewrite Template, then in Block Customer Menu choose Yes.

4. Install/ Uninstall/ Disable the Hyva Checkout Compatibility package

4.1. To install the Hyva Checkout compatibility package

Step 1: Install the extension by the above Composer (If you have already installed the module, then skip this step)

Step 2: Install the Hyva Checkout compatibility package:

a. Install via composer, run commands:

- composer require hyva-themes/magento2-hyva-checkout-bsscommerce-reward-point

b. Then run command:

- php bin/magento s:up

4.2. To disable the Hyva Checkout compatibility package, run command: 

- php bin/magento module:disable Hyva_CheckoutBssRewardPoint

4.3. To uninstall the Hyva Checkout compatibility package, run command:

- composer remove hyva-themes/magento2-hyva-checkout-bsscommerce-reward-point


After purchasing this module, just add our skype account at support.bsscommerce, BSS Support Team will help you to install this extension immediately. Further assistance is available via Email and Skype.

In case you have followed all above steps but the extension still doesn’t work properly, you can delete the file or change the module’s filename to keep your website function as normal. Then please contact us via sales@bsscommerce.com or Skype: support.bsscommerce, our supporters will assist you in resolving any issues within 24 hours.

Was this article helpful to you? Yes No

How can we help?