You have the option to automate the transmission of proof of purchase and services through the Prestashop CMS.
This documentation is only valid for customers who have the latest version of the Verified Reviews platform.
If you don’t have this page, use this documentation.
If you are updating your Prestashop connector to version 9, please consult this article detailing the specifics of this update.
How It Works
Once the module is installed and configured, everything is automatic: Verified Reviews communicates directly with your e-commerce solution.
- Automatic order and review request retrieval: The module communicates your latest orders directly to us. Our platform retrieves the orders for which we need to send review requests, according to the configuration set during the setup described later in this document.
- Display product reviews on your site: The module allows you to display product reviews collected on our platform directly on your product pages, reassuring your customers about the quality of your products.
Module Installation
- Log into your Prestashop back office
- Click on Module Catalog and search for "netreviews," the "VerifiedReviews" module will appear, or click here
- Click on Install
- A success message will appear after installation
Access Configuration
Initial Setup:
To configure the module in the Prestashop environment, go to the menu “Modules > Module Manager”, locate the Verified Reviews module in the “Modules” tab and click “Configure”.
Before configuring, if you have a multi-store Prestashop installation, ensure the module is activated in the module manager. Once on the module configuration page, make sure to select the relevant store using the Prestashop selector at the top of the page.
For our platform to communicate with your store, you need to provide the two fields “Connectorsecret Key” and “Website Identifier” that you can retrieve from your Verified Reviews client area. From the “Account Management > My Prestashop Connector” menu, copy your integration codes (see image below).
Enter them into your Prestashop store in the “CONFIGURATION” section.
Click “Save” to activate your module in Prestashop. You will then need to complete the module activation on your Verified Reviews account.
Multilingual Configuration
If your Prestashop is in multi-store mode, you can only connect a Verified Reviews account to one store (one id_shop). If you want to integrate the Verified Reviews module into several stores, you need as many stores as Verified Reviews accounts (different idWebsite and secret keys).
If your site is available in different languages, you can choose to activate the module's multilingual configuration. To do this, you need Verified Reviews accounts on different platforms and fill in the Secret Key and Website ID for each account.
For example: if your site is available in French, Spanish, Italian, and English. To benefit from the multilingual configuration, you need an account on each of our platforms:
- Verified Reviews FR for France
- Opiniones Verificadas for Spain
- Recensioni Verificate for Italy
- Verified Reviews UK for English-speaking countries
The default multilingual configuration follows the behavior below:
- Each platform retrieves orders in its corresponding language, which allows review request emails to be sent in your customer’s language (e.g., on the ES site, the order will be retrieved on the platform http://opiniones-verificadas.com), and reviews will be collected in the languages of the pages.
- FR product pages will then display reviews collected on http://avis-verifies.com, ES pages will display those from http://opiniones-verificadas.com, and so on.
- The module also allows, with code customization, to display all reviews in all languages.
If your site is not available in multiple languages, do not activate the multilingual configuration.
Module Configuration on Verified Reviews
Now that your module is installed and your codes are integrated into your Prestashop environment, you can ensure that the module is properly communicating with our platform.
Go to your Verified Reviews client area in the menu
« Account Management > My Prestashop Connector».
Review Collection Configuration
To configure the collection via the module, from the left side menu, go toCollect Reviews, then Configuration.
From this interface, you can configure all aspects of your collection..
- Delay 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.
- Desired statuses for order retrieval
This option allows you to choose the status or statuses that our services will use to retrieve your orders.
- Delay after sending brand review request
This option allows you to select the number of days between the sending of the brand review request and the product review request.
- Review request follow-up
This option allows you to resend a notification to your customers asking them to leave a review. You can also set the time before sending this email.
- Email extensions to exclude
You can enter in this field the domain names on which no review request will be sent.
Configuration of product review display
1. Configure the product widget
2. Integrate the product widget
There are 2 integration options available:
For manual widget integration, replace each data element in the code with the appropriate values from your website and product attributes.
3. Integrate stars on category pages
You can enable star display on category pages and/or the homepage from the module configuration page of your Prestashop account: section Design:
Brand review display configuration
You have two options for integrating our widget:
How to manually integrate the brand widget?
Automatic integration of brand and product widgets
Automatic integration is only valid for customers who have the latest version of the Verified Reviews platform and it only works to integrate a floating widget.
At any time, you can disable automatic integration.
Removing a brand widget from the back office automatically cancels any automatic integration if it was in place.
Export my orders (version 9.0.0)
In case of temporary loss of automation, you can generate a CSV file with your past orders to catch up.
Each export contains a maximum of 5000 orders. Once the first export is made, the orders included in the file are considered retrieved by our services. Please ensure to properly upload the CSV to our platform.
To avoid any over solicitation, also make sure that the orders in the file are not already present in our system.
Details of the options:
- From: you can retrieve orders up to 12 months (as defined in our Terms of Service).
- Retrieve product reviews: select "yes" if you wish to retrieve product reviews for these orders (essential if you want to survey your products).
- Export orders with the status: you can select one or more recovery statuses.
Once you have retrieved the generated CSV, contact our Care team.
- Dashboard and adding hooks
The "add all hooks" option allows you to reattach hooks in case they were incorrectly registered, for example. This feature is available from version 1.6.
Automatic order retrieval
General process:
We retrieve your orders according to the configuration you define in your Verified Reviews account "Review Collection Configuration".
You can track the retrieved orders in your account under "Review Collection Review Request Tracking".
When we also retrieve the details of the products, the product reference is the Prestashop ID. If a review is left on the product, that review will be associated with the Prestashop ID in your Verified Reviews account. It will then appear on the product widget displayed on the product page corresponding to that Prestashop ID.
Recovery hooks:
Our order recovery system relies on Prestashop's default system: with each order validation, we register it by executing the actionValidateOrder hook in our av_orders table.
Only the orders properly recorded in this table are considered "eligible" for automatic transmission to our services. The transmission occurs when an order changes status and transitions to one of the recovery status(es) selected in the configuration.
For orders to be transmitted, the status change method in the Prestashop back office must trigger the actionOrderStatusPostUpdate hook.
Google Shopping:
To be able to share your product reviews to Google Shopping, we need the GTIN_EAN (Europe) or GTIN_UPC (US, Canada) which is the most precise data for Google, or if necessary, the brand + MPN duo. It is also important to provide brand and MPN even if you have GTIN: the more information we can provide about your products to Google, the easier it will be for Google to associate reviews with the products.
When retrieving orders, we automatically retrieve Google Shopping information as long as they are correctly filled out in the product sheets of the catalog in the Prestashop Back Office.
Logs and Alerting (from version 10.0.0)
Logs
Logs are stored for 7 days on the connector, with daily rotation. By default, the module logs several events, including:
- error responses from calls made to our services
- references of orders sent to our services
- execution of hooks on which the connector operates
Starting with version 10.0.0 of the connector, two additional log levels have been introduced. These can be enabled/disabled in the "Advanced Actions" section.
- Advanced logs: Enabled by default. We recommend keeping these enabled as they facilitate the investigation of potential issues. These logs allow tracking which other modules have been installed/uninstalled since the installation of our module and identifying those attached to the same hooks as the connector.
- Full debug logs: Disabled by default. We recommend enabling these only at the request of our Care team. This option logs all status changes for each order, assisting in the investigation of potential issues with order transmission.
The Export logs button allows you to export a .zip file in one click, which you can attach to a support ticket. Our Care team can then directly access the connector logs to conduct the necessary investigations.
Alerting
In the event of major connector malfunctions, an alert is displayed in your Prestashop account. From the dashboard and module manager, a warning banner notifies you of a potential issue. A link provides direct access to the module configuration page, where the alert details can be reviewed. For each alert, documentation links are available to suggest initial actions.
4 types of errors can trigger an alert:
- Error during connector installation
- Errors in responses from calls made to our services
- Inability to write logs
- Inconsistency between the selected order status retrieval configuration and the status changes on the Prestashop account: this alert may appear if 15 days pass without any orders placed in the configured status(es).
Technical Recommendations
This documentation presents the options available in the latest version of the module. It is always recommended to update your module to benefit from new features/bug fixes and to regularly check that the connector is correctly transmitting the orders placed on your site.
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 pre-production site before updating your main site.
In the case of a module update to version 9.0.0 or higher of the connector, we strongly recommend that you read this article: https://help.rr.skeepers.com/hc/en-us/articles/14666167026332-The-new-version-of-your-Prestashop-connector-is-available-how-to-get-it-and-benefit-from-the-latest-product-improvements. It details the many benefits and important changes to consider for the most satisfying update possible.
In the case of updating the module to version 10.0.0 or higher of the connector, we recommend checking that there is no legacy module code in your /override/classes/Product.php files and themes/your_theme/product_list.tpl. If applicable, you will need to remove the code before proceeding with the module update.
Changes to Your Site Structure (only if your connector version is below 9.0.0)
We communicate with your site via an API URL. This API URL corresponds to the path to the file netreviewsApi.php located at the root of the module.
If you move the module within your files, or if you add a subdirectory, be sure to always check the connection and contact support to modify the API URL if necessary.
For example: if your site's domain is https://monsupersitedetest.com and you install the module at the root of the site, the API URL will be https://monsupersitedetest.com/modules/netreviews/netreviewsApi.php. If you then move your shop to a subdirectory https://monsupersitedetest.com/shop/, we will need to modify the API URL like this: https://monsupersitedetest.com/shop/modules/netreviews/netreviewsApi.php.
Synchronization of Collection and Display Configuration of Widgets with Your Prestashop Site
When you save a collection configuration or enable automatic integration of a widget, it may take up to an hour for the changes to be applied.
If you want to apply these changes immediately, you can force synchronization by clicking the "Retrieve" button in the Advanced Actions section of the module configuration page in the Prestashop Back Office.
FAQ
Product reference checks:
As detailed previously, the Prestashop module uses the Prestashop product ID as the product reference. You can check in your Verified Reviews account that your reviews are correctly linked to Prestashop IDs.
In other cases, here are the steps to follow if the reviews are not displaying:
1. Check the connection between our platform and your site by going to your Verified Reviews account, then “Account Management > My Prestashop Connector,” where you can click the “Test connection” button. If you get a failure message, please contact support (only if your connector version is lower than 9.0.0).
2. Check in your Verified Reviews account “Integrate my widgets > that the automatic integration is activated.
3. Click the “Add all hooks” button to re-register the hooks (configuration page of the module in the Prestashop Back-Office > DEBUG section).
4. Clear all your caches: Smarty cache and cache plugin (e.g., Page Cache Ultimate). When clearing the Smarty caches, ensure that the “Never recompile template” option is not selected.
If after all this, the reviews still do not display: it is most likely that your theme does not incorporate the hooks we attach to. You can manually insert our custom hooks into your templateproduct.tpl:
{hook h='ExtraNetreviews'} to display the stars
{hook h='TabcontentNetreviews' product=$product} to display the review block
Regarding the stars on category pages, our module attaches to the hooks:
displayProductListReviews if the Prestashop version is < 1.7
displayProductPriceBlock (type="before_price") if the Prestashop version is > 1.7
After activating this option, if the stars (in the product list) still do not appear: it means that these hooks are not present in your theme. In this case, you can directly add our custom hook {hook h='CategorystarsNetreviews' product=$product} in the product-list.tpl file (Prestashop < 1.7) or in the product thumbnail file (in the default theme of Prestashop 1.7, the file path is themes/classic/templates/catalog/_partials/miniatures/product.tpl).
This is usually a cache problem.
In the configuration page of the module in the Prestashop Back-Office > DEBUG section, click the “Add all hooks” button to re-register the hooks and then clear all your caches: Smarty cache and cache plugin (e.g., Page Cache Ultimate). When clearing the Smarty caches, ensure that the “Never recompile template” option is not selected.
Our stars on product and category pages, as well as the review block, normally appear automatically.
If their position is not satisfactory and you want to move them, you can do so by following these steps:
1. Unhook the relevant hooks
To do this, from the module configuration page, click on Hooks
Check the option “Show invisible hooks” to see all the hooks associated with the module.
To disable the automatic display of stars on product pages, unhook “displayProductButtons,” “displayLeftColumnProduct,” and “displayRightColumnProduct.”
To disable the automatic display of the product review block in a tab on product pages, unhook “displayProductExtraContent.”
To disable the automatic display of product reviews in product thumbnails on category pages, unhook “displayProductPriceBlock” and “displayProductListReviews.”
2. Manually insert our custom hooks
Product pages: in your templateproduct.tpl, add:
{hook h='ExtraNetreviews'} to display the stars
{hook h='TabcontentNetreviews' product=$product} to display the review block
Category pages: in the product-list.tpl file (Prestashop < 1.7) or in the product thumbnail file (in the default theme of Prestashop 1.7, the file path is themes/classic/templates/catalog/_partials/miniatures/product.tpl), add:
{hook h='CategorystarsNetreviews' product=$product}
1. Check the connection between our platform and your site: from the left-side menu, go to Verified Reviews, then Collect Reviews and Configuration. Click the Test Connection button or click Send Configuration. If you receive a failure message, please contact our Care team via the contact icon available at the bottom right of the page (only if your connector version is below 9.0.0).
2. Verify that automation is properly enabled: from the left-side menu, go to Verified Reviews, then Collect Reviews and Configuration.
3. Ensure that the orders to be transmitted have the same statuses as those selected in your Verified Reviews account: left-side menu, Collect Reviews, and Configuration.
4. Confirm that the method you use to change the order statuses correctly triggers the actionOrderStatusPostUpdate hook.
After performing these checks, if the issue persists, please contact our Care team via the contact icon.