✨ Magento 2 - New Connector Documentation

You have the option to automate how you submit your purchase/service transactions through Magento 2 CMS.

> Click on the version that corresponds to your menu:

✨ New Platform 🖥️ Historical Platform

Operating Principle

Magento 2 is an open-source E-commerce solution. Our Verified Reviews connector for Magento 2 is available for download on our website or via Composer.

Once the connector is installed and configured, everything is automatic; Verified Reviews communicates directly with your e-commerce solution.

  • Automatic retrieval of orders and sending of review requests: The connector directly communicates your latest orders to us. Our platform retrieves the orders for which we need to send review requests, based on the configuration provided during the setup described later in this document.
  • Display of product reviews on your site: The connector allows you to display your collected product reviews on our platform directly on your product pages, reassuring your customers about the quality of your products.
  • Display of the Verified Reviews rating widget: You have the option to display a floating widget on your site. This widget shows your visitors the average overall Veridied Reviews rating and reassures potential customers about the quality of your services.

Installation of the Connector

Installation via Magento Marketplace

Retrieve the connector installation key

  • Log in to Magento Marketplace (marketplace.magento.com).
  • Use the search engine to find the Verified Reviews connector.
  • Select the connector version for Magento 2 (M2).
  • Click " Add to cart " and proceed with the order.
  • Once the order is completed, click " Install ".
  • Create a new key for Magento 2 via the " Create a new access Key " button.
  • Copy the keys, as you will need them later!

Installing the Connector on Magento 2

Step 1:

  • Log in to your Magento 2 back office.
  • In the main menu, click on "System" and then on "Web Setup Wizard":

mceclip21.png

  • Next, click on " Component Manager ".

mceclip20.png

  • If you are not yet logged in, click on " Sign in" and enter your credentials. 

mceclip19.png

  • Once logged in, click on " Install ». 

mceclip17.png

  • Check the connector "Netreviews - Avisverifies" and click on " Install ".

mceclip18.png

 

Step 2:

Click on " Readiness Check " to check if your Magento2 site has all the necessary components for the connector installation:

mceclip16.png

  • Once the check is complete, click on the " Next " button. If you have components in red, you can resolve these conflicts through the link at the bottom of the page; it will redirect you to the official Magento 2 documentation.

mceclip15.png

Step 3

  • The next step will allow you to create a backup. It is recommended to perform a full backup before installing a new connector. Select the items you want to include in the backup and click the " Create Backup " button.

mceclip14.png

  • A backup confirmation should appear on the screen; you can then proceed by clicking " Next". 

mceclip13.png

Step 4

The final step asks you to confirm the installation of this new connector.

  • Click the " Install " button to complete the installation.
  • Once the connector is installed, you can click the " Back to Setup Tool ".

mceclip12.png

Connector Installation via Archive

Download the Connector Archive

The connector is available for download from the customer space of your Verified Reviews account. To access it, simply log in to: www.verified-reviews.com and click on the " Orders / Our eCommerce Modules " menu.

 

Magento.jpg

 

Click on the " Download " button for our Magento 2 connector to obtain a zip archive of it.

Connector Installation on Magento 2

Step 1

Extract the connector archive into the "Your_Magento2_Site/app/code" folder of your Magento 2 site.

Step 2

Log in to your Magento 2 site via the command line and enter the following two commands:

mceclip23.png

You should see a success message indicating the connector's installation!

Version History:

The version history is available on the connector's download page by clicking the " Version History " button.

 

Magento.jpg

Installation via Composer

  1. At the root of your site, run the following command: composer require netreviews/verifiedreviews:<version>. The latest available version is indicated here.
  2. Enter your authentication keys. Your public key is your username, and your private key is your password.
  3. Wait for Composer to finish updating your project's dependencies and ensure there are no errors.
  4. To activate the module, execute the following commands:
  • bin/magento module:enable Netreviews_Avisverifies
  • bin/magento setup:upgrade
  • bin/magento setup:di:compile (If your site is in Production mode)
  • bin/magento module:status Netreviews_Avisverifies: Verify that the module is successfully activated

For more details, please refer to Adobe's official documentation on installing plugins via Composer.

Connector Configuration in Magento 2 Back-Office

Two pieces of information are required in the " General Configuration " section, the connector API key and the website ID.

To find them, go to your Verified Reviews account:

  • Navigate to the " Account Management > My Connector " menu.

 

On this page, you will find the information to enter in the connector:

  • Copy the connector secret key and the website ID.
  • Go back to the " Configuration " section of your Magento 2 back-office.

  • Select the store to configure:

mceclip29.png

  • Paste the secret key and the website ID.
  • Select "Yes" in "Enable Module on this Website" to activate the connector on this store.

 

  • Once the configuration is complete, click on the "Save Config" button.

 

The Single-Store Mode does not prevent configuring the connector correctly.

However, this mode may sometimes hide the configurations entered in the connector configuration page.

If, after saving the Secret Key and Website ID, you do not see the saved keys, please clear your Magento caches in the "System > Tools > Cache Management" menu and then refresh the connector configuration page.

If you still do not see the keys after this operation, visit our FAQ, section "Configuring a Single-Store Site".

  • Use the "Advanced Configuration" section only if you are very familiar with your site's configuration and configure options related to your store's features.

 

An image containing text, screenshot, Font, number

Automatically generated description

 

By default, the advanced configuration is filled out as follows:

Identify my products using By default, leave the value as "SKU". Change to "ID" only if our technical team requests it or if you are sure you want to use IDs.
Use the data of the Parent product

"Yes" (Retrieve data from Parent products: Configurable, bundle, package.

  • If the value is "No", the connector retrieves data from child products: Simple type products.
  • If the value is "No", an option appears to allow an exception for parent products of type bundle.
Group reviews by family in Configurable products "Yes" by default (Choose "No" if you want to only display reviews of a child product on its product page).
Group reviews by family in Grouped products "Yes" by default (Choose "No" if you want to only display reviews of a child product on its product page).
Group reviews by family in Bundle products "Yes" by default (Choose "No" if you want to only display reviews of a child product on its product page).

Use the Data of the Parent Product : If in the module configuration the option "Use the data of the parent product: YES" is enabled, the module will collect reviews on the parent products (Bundle).

Concrete example: Taking the example of an order where a customer buys an item via the product page of a bundle (parent product A), the product actually purchased on the site will be the child product, identified as product B in the table below.
However, since the purchase of product B was made from the page of bundle product A (parent product), and if the option "Use the data of the parent product" is set to "Yes" in the module configuration, then the review will be collected on the parent product A, and not on the child product B.

  ID SKU P. Type Name Status
Product A) Parent 15344 SKU344 Bundle Product Bundle-type product. Enabled
Product B) Child 12913 SKU913 Other Non-bundle type product. Enabled

Connector Configuration in your Verified Reviews Account

Access the configuration from your Verified Reviews account in Review Collection - Configuration

Check the connector's connection

Your review collection configuration page should indicate "Review Collection with Magento2."

 

If it does not indicate Magento 2: this means that our platform cannot contact the connector installed on your site.

To explicitly check the connection between our platform and your site, you can go to Account Management > My Connector and click on the "Test Connection" button. If the issue persists, contact Verified Reviews support using our contact icon.

 

 

Configuration

To configure the collection via the connector, go to the configuration page in the review collection section:

 

blobid6.png

 

From this interface, you can configure all aspects of your collection:

  • Enable brand review collection

This option automates your order collection. If checked, our system will retrieve orders placed on your site to send review requests. Click this option to disable/enable it.

 

blobid7.jpg

  • Time before sending brand review request

This option allows you to manage the waiting time before sending your review requests. This delay applies as soon as our services receive an order.

 

blobid8.jpg

  • Desired statuses to retrieve your orders

This option allows you to choose the status or statuses on which our services will base the retrieval of your orders.

 

 

  • Enable product review collection

This option enables the collection of reviews on your products.

 

blobid10.jpg

 

  • Delay sending product review request

This option allows you to separate the brand review request and the product review request into two emails.

 

blobid11.jpg

 

  • Delay after sending brand review request

This option allows you to select the number of days between sending the brand review request and the product review request.

 

blobid13.jpg

  • Domain exclusions

In this field, you can enter the domain names on which no review request will be sent. A default list of extensions is provided, which you can modify by removing or adding extensions of your choice.

 

Once you have defined the configuration, click on Save.

 

You are now automated; you can track review requests sent to your customers from Review Collection – Review Request Tracking.

 

Multistore Configuration

If you are using multistores under Magento 2, you need to provide the Connector secret key and IdWebsite for each store you want to use our connector with.

If you want to use our connector for your multilingual stores, you need to create multiple Verified Reviews accounts for the corresponding countries (each account linked to a store).

Automatic Order Retrieval

General Process

We retrieve your orders according to the configuration you set in your Verified Reviews account.

You can track the retrieved orders in your account in the Review Collection – Review Request Tracking menu.

When we also retrieve product details, the default product reference is the parent SKU. If a review is submitted for the product, this review will be associated with this SKU in your Verified Reviews account. Then, this review will be synchronized to your site and displayed on the product page corresponding to this SKU.

Our connector sends orders to our real-time order API when they reach the chosen status(es) in the configuration page.

PLA Section - Google Shopping

To allow Verified Reviews to retrieve additional data about your products (requested by Google Shopping):

  • Go to the Magento 2 back office in the "Verified Reviews > Google Shopping - Product Data (PLA)" menu.
  • Select the STORE to configure. Product information for Google Shopping is configured only at the store (store views) level.

mceclip49.png

Please read the warnings indicated under each field. By default, the connector retrieves the following data related to your products:

  • ID
  • SKU
  • Description: Product name
  • Link: Product sheet URL
  • Image link: Product image URL

mceclip50.png

Do not change the default value of these fields, you can only change it if you are sure that the connector is not retrieving the correct product attribute.

 

  • To retrieve a new product data, please select from the list the product attribute only for the fields that Google Shopping asks for, usually the product brand (Brand), the MPN, and a GTIN. Fields marked with "---" will not change their default value.

 

mceclip52.png

  • Click on "Save Config".

Displaying brand and product reviews

Setting up the site review widget

Once you have collected more than three site reviews: you can add our floating or fixed widget to your website. To display the widget, you need to:

  • Choose and configure the widget
  • Integrate it into the website

Widget Configuration

  • Go to your Verified Reviews account and click on Display Reviews - Embed my widgets.
  • Click on add a widget.
  • Choose to create a Brand widget.
  • Then start configuring your widget.

This article can help you: How to integrate the new version of the Brand Widget on your website?

 

Tips:

  • A floating widget will be visible at all times, regardless of the user's scroll. The integration of the floating widget is done directly from the connector configuration.
  • You can combine widgets, for example, a floating widget for Desktop and another one for mobile.

Integrate Your Widget into Your Site

🔨 If you create a fixed widget: then you will need to perform a manual integration. Copy the script into the desired space on your site.

💬 If you choose a floating widget: you have the option to integrate it automatically from the Verified Reviews platform.

  • Go to Display Reviews > Embed my widgets
  • Click on the brand widget you want to integrate : a banner appears in the right column to enable/disable automatic integration of the widget on your site.

  • You can automatically integrate multiple widgets.

 

Setting Up the Product Review Widget

The connector allows you to integrate the Product Widget automatically.

A Magento 2 product widget is created by default when you create your account

 

You have the option to integrate it automatically from the Verified Reviews platform:

  • Go to Display Reviews > Integrate my widgets
  • Click on the Product widget to integrate it into your site : a banner appears in the right column to enable/disable automatic integration of the widget on your site.

  • The widget will appear on your product pages, and the star block will be displayed on category pages.

 

FAQ

Reviews and/or stars are not displayed on the product page

Refer to the "Displaying brand and product reviews" section and make sure all mentioned points are correct.

Stars are not displayed on the product listing page
Refer to the "Displaying brand and product reviews" section and make sure all mentioned points are correct.
The average rating, number of reviews, or reviews do not match
Orders are not being collected for some time
  • Check the connection between our platform and your site (Verified Reviews account > Account management > My connector, you can click on the "Test connection" button). If you get a failure message, please contact support.
  • Check if automation is properly enabled in Verified Reviess account > Collect Reviews > Configuration.
  • Check that your orders to be fetched have the same status(es) as the one(s) you have selected on your Verified Reviews account connector configuration page.

If you get a connection, automation is properly enabled and statuses are correct, please contact support.

Setting up a single-store site
  • When do you need single-store mode?

You can activate single-store mode if you have a website with a single store and a single store view and you do not plan to use multiple stores in your Magento 2 installation.

 

mceclip55.png

 

This mode does not prevent configuring the connector correctly; however, it may hide the configurations entered on the connector configuration page as shown below:

 

 

If you wish to display the configuration on your single-store site, please follow the instructions below:

  • In the administration sidebar, click on Stores, then under Settings, choose Configuration.

mceclip57.png

 

  • Scroll down the tab GENERAL and click on General:

mceclip60.png

  • Scroll down the page and open the Single-Store Mode section.
  • Set the Enable Single-Store Mode option to NO.

mceclip62.png

 

  • Click the Save configuration button at the top right:

mceclip63.png

 

  • Refresh the cache by following these steps:

1. Go to the " System > Tools > Cache Management " menu.

2. Check the Page Cache and Configuration boxes.

3. With the actions set to "Refresh", press "Submit" .

 

 

 

This configuration will display the main connector configuration in your Magento 2 back-office:

 

mceclip65.png

Was this article helpful?
1 out of 1 found this helpful