Magento (Module)

[CommunityJedi22]

If you use Magento as your eCommerce platform, use the following guide to implement PowerReviews for your site.

The Magento module should only be installed with guidance from your PowerReviews Implementation Team. If you do not have a current Implementation Project, please reach out to our Sales Team or to your Account Manager to get started. If you are not already working with our Sales Team, contact us for a demo.

Overview

PowerReviews and Magento have partnered so that you can easily and natively implement PowerReviews within your Magento admin instance. This enables you to quickly start collecting and displaying Ratings and Reviews on your products. PowerReviews also offers the ability to collect and display Questions and Answers about your products and services as well. Depending on the package you purchased, the PowerReviews extension installs both Ratings and Reviews and Q&A.

Install the PowerReviews extension by downloading it from the Magento Marketplace. 

When you run the commands and then save the configuration in your store, you're ready to start collecting and displaying ratings and reviews.

The module will install the following components: 

• Product Display Pages (PDPs):
  • Review Snippet & Display - display a review summary, individual reviews, and a media gallery on your PDPs
  • Q&A Snippet & Display - display previously asked and answered product questions on your PDPs to help inform customer buying decisions
  • Feedless Product Data Functionality - share product catalog information to PowerReviews directly through our JavaScript for real-time updates.
    
    
• Write-a-Review (WAR) Page:
  • WAR Page - a standalone wrapper page that displays the Write-a-Review form
    
    
• Category/Product Listing Pages (PLPs): 
  • Category Snippets - display a product's average star rating and total review count to encourage visitors to click through to the PDP
    
    
• Order Confirmation Page:
  • Checkout Beacon - capture and send order information to power the post-purchase Follow-Up Email and solicit reviews from your customers

Getting Started

This module is designed to support Magento versions 2.4+. Previous versions may still be compatible, but it is best to discuss with your PowerReviews Implementation Team before moving forward.

This module was not designed to support a single-page application (SPA). If your site currently fits this criteria, you will need to move forward with a non-module installation. 

To install the PowerReviews extension in your Magento store, download the PowerReviews app via the Magento Marketplace. 

Unzip the pr-review-display.zip file to your server in the following folder path:  /app/code/PowerReviews/ReviewDisplay

Running Magento Commands

After you unzip the pr-review-display.zip file, you'll need to run three commands using the Command Line to add the PowerReviews components to your store.

To install the PowerReviews components:

1. Open your Command Line program on your machine. Run the following commands on the same server where your PowerReviews and Magento files are.
2. Enter the following command: bin/magento cache: flush
3. Press Enter
4. Enter the following command: bin/magento setup: upgrade
5. Press Enter
6. Enter the following command: bin/magento setup: d: compile
7. Press Enter

If you experience any issues running these commands, please work with your Implementation Team.

Enabling PowerReviews in Your Magento Store

Once you finish running the Magento commands using the Command Line, you can complete the PowerReviews setup.

Please ensure you have the following account credentials from your PowerReviews Implementation Team:

• Merchant Group ID
• Merchant ID
• API Key
• Locale

This information ensures that your PowerReviews software appears correctly in your store.

Configuring Your Magento Store

To configure your store:

1. Log in to your Magento account, using your credentials.
2. Navigate to Stores > Configuration
3. Enter the following information in the General section for PowerReviews:

• Merchant Group ID
• Merchant ID
• API Key
• Locale

4. Select Yes for each component of the PowerReviews software you want to install in the On/Off section
5. Click Save Config

This completes your setup, and your store is now ready to start collecting review content. If you experience any issues, please work with your Implementation Team.

Implementing Multiple Sites

The PowerReviews Magento module allows you to enable reviews across multiple Magento sites.

1. To view the Configuration menu for your second site, click on the Store View dropdown on the Configurations page and click on the name of another site. In the example below, the second site is "Another test store view."

2. If the Review Display is not already enabled, uncheck the Use Website box, then ensure that Yes is selected from the Enable Review Display dropdown.

Your PowerReviews Implementation Team will provide you with each of the following account credentials for your second site (these will be different than what was provided for your first site or any other site):

• Merchant Group ID
• Merchant ID
• API Key
• Locale

3. Uncheck the Use Website box for each of these items in the configuration page, and enter the appropriate information
4. Click Save Config to save the configuration

 

Disabling Magento Reviews

Magento enables its own review feature when you create your store. If you install PowerReviews and don't disable the native Magento review feature, two review tabs will appear on your PDPs. You must therefore disable the Magento review feature when installing PowerReviews.

To disable Magento reviews:

1. Open your Command Line program
2. Enter the following command: php bin/magento module: disable -f Magento_Review
3. Press Enter

Magento reviews are now disabled.

Styling Your Display

After you complete your PowerReviews installation and setup, you can update the style of your Review Display if desired. For more information, see Magento's front-end developer guide. 

Note: You must use Magento 2.0 and above for these styling instructions to apply.