Magento 1 - Connector Documentation

You can automate the transmission of purchase proofs, services, and the publication of your reviews using the Magento 1 CMS.

Operating Principle

Before using the Magento 1 module "Verified Reviews," you must first register on the portal http://www.verified-reviews.com. The information requested during the configuration of your Magento module all comes from your Verified Reviews customer account.

The Magento 1 module integrates an API allowing us to communicate with it. Once the module is installed and configured, everything is automatic: Verified Reviews communicates directly with your e-commerce solution.

• Automatic retrieval of orders and review requests : The module communicates directly to us your latest orders. Our platform therefore retrieves the orders for which we need to send review requests, based on the configuration provided during the setup described in the following sections of this document.
• Display of product reviews on your site : The module allows you to display your product reviews collected on our platform directly on your product pages, thereby 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 displays to your visitors your overall average Verified Reviews rating and thus reassures potential customers about the quality of your services.

 

Module Visuals

These visuals apply to the default Magento 1 theme.

1/ Homepage and Category Page

a/ Stars and number of reviews in brackets.

b/ Stars only

 

2/ Product Pages

a/ Stars Block

 

b/ Reviews Block

• Complete Reviews Block
  
  

 

• Reduced display (Review block detail)
  
  

Module Installation and Configuration

Installation via Magento Marketplace

Retrieve the module installation key 

• Log in to Magento Marketplace
• Use the search engine to find the Verified Reviews module or click here to view the module

• Check that it is indeed the module version for Magento 1 (M1)
• Click on "Add to cart" and proceed with the order
• Once the order is placed, click on "Install"
• Create a new key for Magento 1 via the "Create a new access Key " button.
• Copy the keys, you will need them later.

Installation via Magento Connect

Download of the Verified Reviews module

The module is available from your Verified Reviews account. To access it simply log in to: http://www.avis-verifies.com and go to the "Orders > Our Ecommerce Modules" section. Click on " Download " to obtain the module and be able to save it to your computer.

 

Installation of the module on Magento 1

Step 1

The first step is to log in to your Magento solution's administration interface and go to the "Magento Connect Manager" via the " System > Magento Connect > Magento Connect Manager" menu.

After clicking on the "Magento Connect Manager" link, you need to authenticate by entering your Username / Password.

Step 2

Once on the "Magento Connect Manager" page, click on " Choose a file " and select the archive you previously downloaded. Click on " Upload " to install the module.

You should see a successful module installation message. You can then click the " Refresh " button to update the content of this page. The module will appear in the list of installed modules.

You can return to your back office by clicking on the " Return to admin " button.

 

Module Configuration on Magento

Module Menu

The Verified Reviews module is located in your Magento back office under the " Catalog > Verified Reviews " menu. From version 2.9.x onwards, this menu has four sub-menus:

• Export orders (CSV file): Allows you to create a .csv file with the orders from the selected site. For more details, please refer to the section dedicated to this feature
• Configuration: Allows you to configure the module
• Check Installation: Allows you to check the installation status of the module. For more details, please refer to the section dedicated to this feature
• Google Shopping - Product Data (PLA): Allows you to configure the product information to be sent for Google Shopping reviews, by mapping product information and attributes (ID, SKU, brand, color, custom attribute, etc.). For more information, please refer to the section Configure Data for Google Shopping (Optional).

Configuration

Setting up customer identifiers

Once the module is installed, go to the "Catalog > Verified Reviews > Configuration" section and choose your shop from the menu at the top left. Two pieces of information are required, the Secret Key and the Id Website.

 

To find them, go to your Verified Reviews account and navigate to the "Collecting Reviews > Configure my module" section.

On this page you will find the information to be entered into the module in the "Your integration codes" section. Copy the secret key and the website ID.

If you are using the " MultiBoutique " feature, you must provide the Secret Key and WebsiteID for each store you want to use our module with, using the list of stores in the top left corner.

In the screenshots below, both stores are configured on the same Verified Reviews account (same idWebsite and Secret Key).

• Store 1
• Store 2

If you want to use our module for your multi-language stores, you must create multiple Verified Reviews accounts for the corresponding countries (each account being linked to a store).

For example, your site is available in French, Spanish, Italian, and English. To benefit from multilingual configuration, you must have an account on each of our platforms:

• https://www.avis-verifies.com (FR)
• https://www.opiniones-verificadas.com (ES)
• https://www.recensioni-verificate.com (IT)
• https://www.verified-reviews.co.uk (UK)

The multilingual configuration follows the following behavior:

• Each platform retrieves orders from the corresponding language, allowing to send review request emails in your customer's language (for example, on the ES site, the order will be retrieved from the platform https://opiniones-verificadas.com ) and collect reviews in the languages of the pages.
• FR product pages will then display the reviews collected on https://www.avis-verifies.com, ES pages will display those of https://www.opiniones-verificadas.com/ etc.

In the screenshots below, the French store is associated with an FR account (FR account idWebsite and Secret Key) and the English store is associated with a UK Verified Reviews account (UK account idWebsite and Secret Key)

• English Store with idWebsite and Secret Key from a Verified Reviews UK account
• French Store with idWebsite and Secret Key from an Verified Reviews FR account

Configuration Steps

Customer identifiers are entered in the " System Integration " section which allows to establish a connection between the module and your Verified Reviews account.

1/ Select the store to configure

2/ Paste the secret key and the website ID.

3/ Select " Yes " in " Enable Module on this Website " to enable the module on this store.

4/ Configure the Reviews: Product Page and Reviews: Category Page (product list) sections

5/ Only use the "Advanced Configuration" section if you are very familiar with your site's configuration

Reviews Section: Product Page

Number of reviews to display on the product page

Choose the number of reviews you want to display by default on the product page upon first loading. Other reviews will be hidden, and visitors will need to click on "More reviews…" to see them.

Star color

You can customize the color of the stars on your product pages to better match your brand's visual identity.

Allow visitors to rate the usefulness of reviews?

You can add a useful review button (yes/no) next to each review.

Display a message if the product has no reviews

This option allows to display the message "No reviews have been left for this product yet." if no reviews are available for this product.

Activate Product Rich Snippets

By enabling this option, you will activate Rich Snippets on your product pages.
Rich Snippets are structured data that will inform search engines that your product has reviews and will allow them to know the number and average rating of the reviews.

 

Rich snippets format: if your theme already integrates rich snippets, you must select the same format in the module configuration. After selecting the format, clear the Magento caches and if necessary the server cache as well.

How to verify that my rich snippets have been integrated correctly?

Google offers a test tool to check if a web page is eligible for rich snippets, available here Rich Results Test - Google Search Console

Simply enter the URL of a product page with reviews. Google will return any errors in the integration of rich snippets or indicate that the page is eligible for rich snippets by showing a preview of the result.

Our module adds AggregateRating and Reviews tags and obtains an effective preview on Google's test tool, but cannot completely guarantee the display of rich snippets in browser search results, as Google considers many other factors (content quality etc.)

Reviews Section: Category Page (product list)

Display stars

This option allows to activate the display on product lists (home page, category pages)

Display the number of reviews

This option adds the number of reviews in parentheses after the stars in the visual on category pages

Activate the link that redirects to the Reviews Page

If this option is enabled, on product lists, a click on the stars will redirect to the product page.

Advanced Configuration

Star Size in Pixels at the Top of the Product Page

This option allows you to change the size of the stars at the top of the product page under the product name.

Star Size in Pixels for Product Reviews

This option allows you to change the size of the stars in the reviews tab.

Reduced Reviews Display Area

This option allows you to hide the graph at the top of the reviews. Select "Yes" only if the product reviews are displayed in a small block (e.g., 400px, see block on the right in the image below):

 

 

Retrieve the Parent Product ID

Select "Yes" to retrieve the parent product data instead of the child product.

Check Installation

This section allows you to see the status of the module installation and provides several options available to maintain the module in case of installation errors.

Please do not use this section if you are unsure of the actions to take. If you experience issues with the module, please contact our technical support following the steps in our article: How to Contact Us?

Advanced Section

The available options in this advanced section are:

• Install Tables: Reinstalls the module tables.
• Add missing fields: Adds missing module columns to the orders table.
• Fix primary key field: Fixes primary key issues for review synchronization.
• Flag orders to 1: Changes the status of all orders to "already retrieved by the module".
• Check order configuration: Checks the relationship of child and parent products.
• Reset all module configuration page: Deletes all module configurations.

Google Shopping Section - Product Data (PLA)

This section allows you to map product information to their attributes (ID, SKU, brand, color, custom attribute, etc.).

For more information on configuring data to show reviews on Google Shopping, please see the section Configure Data for Google Shopping (Optional).

 

Module Configuration on Verified Reviews

Access the configuration from your Verified Reviews account in "Collect Reviews > Configure my module".

What to do if the "Configure my module" tab does not appear?

If the "Configure my module" tab does not appear, it means your Verified Reviews account has not been configured for Magento.

To change this, you need to go to Account Management > My Account

Then in the box My Certificate > e-Commerce Solution, choose Magento 1

 

Save the change by clicking on the "Save" button at the bottom of the page.

 

Configuration Recovery

This step will allow you to recover the configuration of your Magento 1 site in order to set up our module based on it.

• Click on "Save website config." to check the connection between Verified Reviews and Magento 1.

✅ If the success message "The configuration has been successfully recovered." appears and the square in the right section "Module Status" has green checkmarks, the module is properly configured.

❌ If another message appears, check the previous configurations, and if the problem persists, contact technical support following the steps in our article: How to Contact Us?

 

Multistore Configuration

If you are using multi-store under Magento 1, you must enter the Secret Key and IdWebsite for each store you want to use our module for.

If you want to use our module for your multi-language stores, you must create multiple Verified Reviews accounts for the corresponding countries (each account linked to a store).

When you click on "Save website config", the list of all the websites and stores on your site appears. Only the stores next to which it is written (Current Configuration) are configured for this Verified Reviews account. The configured store identifier appears in braces {}.

If "Current Configuration" is written next to a store you do not want to configure, go back to the module configuration on your Magento 1 back office then select the store in question from the dropdown menu at the top left. Clear the Secret Key and Idwebsite, and set the "Enable Module on this Website" option to "No" then click again on "Recover configuration" in the Verified Reviews account.

Module Configuration Option

This step will allow you to configure the module and review requests. Simply fill out the form following the instructions. If you encounter an issue, hover over the "?" to get help.

Automatic Order Retrieval

• Enable Automation: Click yes to enable it. This is the main condition to start automatic collection of your orders.
• When should orders be retrieved: You can choose between two options:
  • when the order is created by selecting "On order": in this case, ALL orders will be retrieved (including canceled, refunded, etc.).
  • via a specific order status (or statuses) by clicking on "On order status change". If you choose this option, you must select the status(es) from the list of statuses.

 

Reviews Collection

• Reviews Collection: You can set a delay before sending the review request.
  • The first part allows you to select the number of days between the moment the order is retrieved by our services and the sending of the review request.

• The second part only concerns product reviews. You can choose to separate the sending of product review requests to your customers by adding a delay to the email sending for product reviews, for example, to give the customer time to test the product.
  • Example:
    • How long after this event should we send the review request? 3 days
    • How long after sending the site review request should we send the product review request? 5 days.
    • For an order retrieved on the 1st of the month, the site review request will be sent 3 days later, and the product review request will be sent 5 days later, i.e., 8 days after the order is retrieved by our services.
• Email extensions for which review requests should not be sent: By default, it prevents querying customers from marketplaces where temporary emails like xihdhsi54412@amazon.fr are created for each order. Therefore, you must enter the email extensions for which review requests should not be sent (the extension corresponds to what comes after the @). We have already provided some, and you can add more by separating them with a ";".

Product Options

• Do you want to collect reviews for your products?: Check "yes" to collect product reviews (when we retrieve orders, we include details of the ordered products and query your customers about all the products they ordered).
• Do you want to display product reviews on your product pages?: Check yes to display reviews on the corresponding product pages. Every day, we synchronize the latest product reviews you have collected into your database.

Widgets Display

• Would you like to display floating widget : If "yes", the widget will appear on your site.

• Floating Widget Script: You can paste the code corresponding to the widget you created. See here for more details.

Click on "Send configuration". Our platform communicates directly with the module to save this configuration.

You are now automated, you can track the review requests sent to your customers from "Collect reviews> Reporting - Review Requests". Your orders will start to be retrieved during the next run of our cron.

First order export (optional)

To quickly get your first reviews, the Verified Reviews module includes an order export feature that allows you to generate a CSV file already formatted on the correct structure that can be loaded directly via your Verified Reviews Client Area. The first order export allows you to quickly generate the first reviews by surveying the customers of your past orders.

• Go to "Catalog > AvisVérifiés > Export > Order" to access the order export.

If a 404 error appears, you must log out and log back into your Magento back office.

👉 Choose the shop or website for which you want to export orders from the menu at the top. "All Store Views" is selected by default, which means you will export orders for all shops in your Magento.

• Commandes depuis = Orders since: Allows you to choose the period of order creation, starting from the current date.
• Ajouter les informations produits = Add product information: If "yes", then the file will include product information from the orders in order to collect both site and product reviews. If you choose "no", the file will not include any product information, and your customers will only be surveyed for site reviews.
• By clicking the "Download Order" button in the top right, you will be prompted to download the CSV file.
• The file download starts automatically, by default you can find it in your download folder.
• Once you have retrieved the generated csv, you can go directly to the orders download area here. 
• You must upload the csv and associate the fields with the columns of the csv file. Make sure to follow the tutorial and check the information provided before validating the order import.

If you want to collect product reviews, it is the column of the csv product_id that must be associated with the field "Product reference". If you do not select the correct column, then the collected product reviews will not be displayed.

If you are unsure about the importation, do not hesitate to contact our team who will assist you as this operation will automatically send emails to your customers within minutes of the importation.

Automatic Order Retrieval

We retrieve your orders according to the configuration you define in your Verified Reviews account > Integration > Configure my Magento module.

You can track the retrieved orders in your account under Statistics > Brand and product review requests

By default, when we also retrieve the product details, the product reference is the parent product ID in the case of a configurable product and the child product ID in the case of a "grouped" product. If a review is submitted for the product, this review will be associated with the Magento ID in your Verified Reviews account. Then this review will be synchronized to your site and displayed on the product page corresponding to that Magento ID.

Our order retrieval cron runs every 6 hours on your site to check for new orders to retrieve.

Parent ID / Child ID Management

As previously indicated, by default the module configuration is set to retrieve the parent ID when necessary. We advise keeping this option enabled.

Here is a breakdown of the retrieved IDs depending on whether the option is enabled or not.

Option to Retrieve Parent Product ID Enabled

Automatic Order Retrieval

Product Type	Retrieved ID
Downloadable	Child ID
Simple (without parent product)	Child ID
Grouped product page	Child ID (simple product)
Simple product page associated with a grouped product	Child ID
Configurable product	Parent ID
Bundle	Bundle ID (not the IDs of the products composing the bundle)

Review Display

Product Type	Product Page where the review appears
Downloadable	Downloadable product page
Simple (without parent product)	Simple product page
Grouped product page	No display
Simple product page associated with a grouped product	Child ID product page (simple product)
Configurable product	Configurable product page (Parent ID)
Bundle	Bundle product page (no display on the pages of the products composing the bundle)

Option to Retrieve Parent Product ID Not Enabled

Automatic Order Retrieval

Product Type	Retrieved ID
Downloadable	Child ID
Simple (without parent product)	Child ID
Grouped product page	No ID retrieval
Simple product page associated with a grouped product	Child ID
Configurable product	Child ID
Bundle	Child IDs (products composing the bundle)

Review Display

Product Type	Product Page where the review appears
Downloadable	Downloadable product page
Simple (without parent product)	Simple product page
Grouped product page	No display
Simple product page associated with a grouped product	Child ID product page (simple product)
Configurable product	No display
Bundle	Display on the product pages of the child IDs (products composing the bundle) but not on the bundle product page

 

Configuring Data for Google Shopping (Optional)

By default, the module retrieves the following information about the products:

• Product ID
• Product Name
• Product Page URL
• Product Image URL
• Product SKU

To display your reviews on your Google Shopping store, the reviews must have the following data related to the products:

1. Product Name
2. Product Page URL
3. Product Image URL
4. Product SKU
5. Product Brand
6. GTIN_EAN (for EU), GTIN_UPC (for America), GTIN_ISBN or GTIN_JAN *
7. Product MPN *

If GTIN is provided, MPN is not necessary and vice versa. However, if you have both data, you can map them, otherwise, map either GTIN or MPN.

Data points 1, 2, 3, 4, and 5 are already retrieved by default by the module, so you can leave them as "Not Set".

We recommend not modifying the mapping for point 1 ID to avoid malfunctions in the automatic display of reviews on your product pages.

From point 6 ("brand") onward, the data must be mapped as follows:

1. Choose the store to configure from the top menu "Current Configuration Scope".
2. Map the fields: the field on the left specifies the data to map, and the list on the right shows the available attributes of the products.
3. Press the "Save" button.
4. Clear Magento caches and server caches if necessary to apply the configuration, otherwise, it will not be taken into account.

Here is an example of mapping:

If the data that has just been mapped "disappears", you will need to clear the Magento caches to see it mapped.

If you wish, you can also map other product attributes in the information 1 to 10 ("Extra Info1 - Extra Info10"). If you have any questions regarding this point, please contact our technical support following the steps in our article: How to contact us?

Here is an example of mapping extra information:

This configuration will be taken into account for the orders retrieved by our system on the next cron run.

To map your old orders and already generated reviews, please contact our technical support following the steps in our article: How to contact us?

Review Display on the Site

Setting up the site review widget

As soon as you have collected more than three site reviews, you can add our floating widget to your website directly via the module by following the steps in our documentation by clicking here 

💡 Tips: a floating widget will be visible at all times, regardless of the user's scroll.

 

To add the widget script via the module, go to the "Collect Reviews" section then "Configure my module" and scroll down to the "Display Widgets" section.

Select "Yes" for the question "Would you like to display floating widget ?" and paste the previously copied script into the corresponding box.

Finally, click on "Send this configuration".

Check on your site (clear cache if necessary).

Integration of the Carousel widget on your site

As soon as you have collected more than three site reviews, you can add a carousel widget to your site that directly displays the collected site reviews. You can follow the steps by following the steps in our technical documentation by clicking here.

Product Reviews Display

1. In your Verified Reviews account in the "Collect reviews > Configure my module" menu, the "Products options" section, select "Yes" for the following two questions:
   • Would you like to retrieve the reviews for your products?
   • Would you like to display the product reviews on your products files?
2. Click on "Send this configuration".

If this is the first time you are displaying product reviews, contact your account manager or Verified Reviews support, manual synchronization of reviews is required.

For any new product review deposited, you must wait 24 hours for it to appear on your site.

• To check the display of product reviews, go to "Review management > Product Reviews" and check its display on your website.

 

Technical recommendations

🔧 Module Update: If your module has been customized (overrides, modified module files, etc.), be sure to make a copy of the files before updating and test the update on a staging site before updating on your main site.

 

FAQ

 

Annexes