VibeFox Mondial Relay for PrestaShop — Help
Requirements
PrestaShop: 8.0 to 9.x. The checkout works with the Classic and Hummingbird themes.
PHP: 8.0 or later. The module refuses to install on older PHP versions.
Mondial Relay account: the brand code (Enseigne) and the Private Key come with a Mondial Relay business account: see the professionals section of mondialrelay.fr, your "Connect" customer area or your sales contact. The map selector needs only the brand code. The list of nearest points needs both. For tests Mondial Relay provides the brand code BDTEST13 with the Private Key PrivateK.
VibeFox license key: bought on vibefox.net. One key works on one domain.
Installation
1. In the back office go to Modules > Module Manager and click Upload a module. Choose the module ZIP file.
2. When the upload finishes, click Configure, or find VibeFox Mondial Relay in the module list later and click Configure.
3. Paste your VibeFox license key into License key in the license block at the top of the Configure page and click Activate (see License key).
4. Enter your brand code (Enseigne) and, for the list mode, the Private Key. Fill in Country prices and click Save.
On install the module creates the Mondial Relay Point Relais carrier with the delivery time text Delivery to a Mondial Relay Point Relais of your choice. The carrier is assigned to all customer groups and to the zones of France, Belgium, Luxembourg, Spain, Portugal and the Netherlands. You can change zones, customer groups, delivery time, logo and size limits in Shipping > Carriers. Do not set prices there: the price always comes from the module.
Configuration
All settings are on the module page: Modules > Module Manager > VibeFox Mondial Relay > Configure. Each section has its own Save button, which saves the whole page. Every save also clears the cached pickup point lists.
Warnings at the top of the page show problems that hide the carrier: a missing brand code, a missing Private Key in list mode, no price for France, Belgium or Spain, and a deleted carrier. Values that cannot be saved are reported after Save: a number field with a value that is not a number (or is negative) keeps its previous value. A name longer than 64 characters or a Min weight (kg) greater than Max weight (kg) is refused, and nothing is saved. If the shop weight unit is not one the module knows, a warning says that product weights are taken as kg.
General
Enable/Disable: turns Mondial Relay on or off. This is the same switch as the carrier status in Shipping > Carriers.
Name: the carrier name shown to customers at checkout. Default: Mondial Relay Point Relais. Required, up to 64 characters.
Tax status: None means the prices in the table are final. A Taxable option with a tax rule name means PrestaShop adds the shipping tax of that rule on top of the prices.
Mondial Relay account
Brand code (Enseigne): required, up to 8 letters and digits, for example BDTEST13 for tests. Used by the pickup point map and by the Web Service. Without it customers cannot choose a Point Relais, so the carrier is not shown at checkout.
Private Key: needed only for the List of nearest points selector. After saving, the field stays empty and shows Saved - leave empty to keep it. Type a new value only to change it. To delete the saved key, tick Remove the saved Private Key and click Save. When the brand code and the Private Key are set, the connection to the Mondial Relay Web Service is tested every time you save the settings, and a message shows whether they are valid.
Pickup point selector
Selector: how the customer chooses a Point Relais.
Rates (in your shop default currency, tax excluded)
Country prices: price by destination country and parcel weight. Click + Add country to add a row and the trash icon to remove one. Choose * Default as the country for all other countries. Each row has a Price and weight columns: XS up to 1 kg, S 1-2 kg, M 2-3 kg, L 3-5 kg and XL over 5 kg. An empty or 0 weight column uses the Price column. If Price is empty too, the delivery for that weight is free, so fill in Price when you use only some weight columns. Decimals with a dot or a comma (4.90 or 4,90). Rows without any price are dropped when you save, and values that are not numbers are reported and left empty.
Fallback cost: used for countries without a row in the table. Leave it empty to hide the carrier for them.
Calculation type: how the price is counted.
Free shipping from: the cart subtotal (after discounts, without tax) from which the delivery is free. Leave empty for no free shipping.
Availability
Min weight (kg): hide the carrier when the cart weighs less. 0 means no limit.
Max weight (kg): hide the carrier when the cart weighs more. Mondial Relay accepts parcels up to 30 kg in Points Relais. Default: 30. 0 means no limit. An empty field means 30 kg. It cannot be lower than Min weight (kg).
Minimum subtotal: show the carrier only when the cart subtotal (products that need shipping, after discounts, without tax) is at least this amount. Leave empty to always show it.
Ignore shipping zones: offer the carrier for the countries below, or for every supported country when the list is empty, even where the carrier zones do not contain them. While it is on, the carrier is linked to every active zone, including zones you create later. When you switch it off, the carrier gets back the zones it had before.
Countries (ignore zones): the destination countries for that mode. This field is used only when Ignore shipping zones is on. The list has only the countries with Points Relais.
Advanced
Debug log: writes rate calculations and Web Service calls to logs/vfd_mrel_debug.log.php in the module folder. The file cannot be opened from the web. Errors are always logged, even with this option off. Keys and customer data are never logged.
Log: shows the size and the latest entries of the log. Click Clear log to empty it.
Remove data on uninstall: when on, uninstalling the module deletes the settings and the carrier. When off, uninstalling only switches the carrier off. The pickup points saved in orders are kept.
How it works at checkout
The carrier is offered only for countries with Points Relais: France, Belgium, Luxembourg, Spain, Portugal and the Netherlands. It is hidden when customers could not choose a point: without a brand code, or in list mode without the Private Key.
At the shipping step PrestaShop asks the module for the price. Only physical products count: virtual products add no weight and are not included in the subtotal. The module checks the cart weight and the minimum subtotal. The price comes from the row of the country (or the * row): the weight column, else Price. Without a row, the fallback cost is used. If there is no price, the carrier is hidden. If the subtotal reaches Free shipping from, the price becomes 0. The price is calculated in your default currency and then shown in the customer's cart currency.
If you edit the carrier in Shipping > Carriers after it has orders, PrestaShop saves it as a new carrier version. The module follows the new version automatically.
The module does not request live rates: Mondial Relay has no public rate API. It does not create shipments, print labels or track parcels. Create the shipments in your Mondial Relay "Connect" space using the Point Relais number shown in the order. Home delivery (Domicile) is not offered.
Pickup points
When the customer selects the Mondial Relay carrier in the delivery step, a Mondial Relay pickup point box appears under it.
Map mode: the button Choose a Point Relais opens the official Mondial Relay map in a window for the delivery country, postcode and parcel weight. After the customer picks a point, it is shown as Selected: and the button changes to Change Point Relais. The map widget is loaded from widget.mondialrelay.com and its map library from unpkg.com only when the customer opens the map. Mention this in your privacy policy.
List mode: a drop-down - Choose a Point Relais - shows the 10 nearest points for the delivery postcode, with their distance. The chosen point is shown with its opening hours. The list is loaded by your server, so no third-party script runs in the browser. Lists are cached for 12 hours, an empty answer for 1 hour, and a failed request is remembered for 5 minutes. The Web Service timeout is 10 seconds. Without a postcode the customer sees Enter your postcode to see the nearest pickup points. If no point is found or the list is not available, the customer sees a message such as "The list of pickup points is not available right now. Please use the map." and the map is offered.
The chosen point is saved to the cart at once. A point is required. Without one, the customer sees Please choose a Mondial Relay pickup point. and cannot continue to payment. A point in another country than the delivery address is refused. In list mode the point is also checked against the list for the address.
When the order is placed, the point stays with the order. The back office order page shows the Mondial Relay pickup point block with the point name, address and Point Relais number (for example FR-066974). The customer sees the point on the order confirmation page and in the order details in their account. In the order confirmation e-mail and in the new order e-mail of the Mail alerts module, the point is added after the carrier name.
License key
The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox Mondial Relay is the first block on Modules > Module Manager > VibeFox Mondial Relay > Configure, above the settings. Paste the key into License key and click Activate. After that the block shows the key masked, the status (for example the date the license is active until and your domain) and the buttons Check now to check the status again, Change key to enter another key and Remove key to remove the key from this shop. Below them are the line Product: presta-shipping-mondialrelay and the link Manage licenses and domains in your account, which opens your vibefox.net account. Only employees with the Configure permission for the module can change the key. The texts of the block follow the back office language (English and Russian are included).
If the key is not accepted, the block says why, for example Key not found, This key belongs to another product, Domain limit reached or License expired on a date. After the shop address changes, or after you free a domain slot in your account, click Check now. If the license server cannot be reached, the module keeps working on the last known status.
One key works on one domain: the domain of the main shop, also in a multistore setup. Removing the key from the shop does not free its domain slot. Free the slot in your vibefox.net account.
Without an active key, the Mondial Relay carrier is not shown to customers at checkout and no rate is calculated. The PrestaShop storefront does not know that you are logged in to the back office, so the carrier is hidden for you too: you can set up the module before you buy a key, but not test it at checkout. A reminder appears in Modules > Module Manager on the Alerts tab. Existing orders are not affected.
When a license expires, the module keeps working, but updates and support need a renewal. The status is checked again automatically while you work in the back office: once a day for the first 14 days after the key is entered, then once a week. No cron job is needed. Uninstalling or resetting the module always removes the license key and license status.
Troubleshooting
Mondial Relay does not appear at checkout: check that the license is active and Enable/Disable is on. In Shipping > Carriers check that the carrier covers the zone of the customer's country and the customer's group, or turn on Ignore shipping zones. Check the warnings at the top of the module page: the carrier is hidden without a brand code, in list mode without the Private Key, for a country without a price, outside the weight and subtotal limits, and for countries without Points Relais. Products can also be limited to certain carriers in the product page.
Web Service test failed after saving: the message shows the Mondial Relay error, for example an invalid brand code or an invalid security key. Check the brand code and the Private Key with Mondial Relay.
The list of points is empty or not available: the customer needs a delivery postcode first. If the Web Service fails, the map is offered instead. Turn on Debug log, reload the checkout and look at the Log field on the module page for the reason.
The map does not open: the map is loaded from widget.mondialrelay.com and unpkg.com. Check that a privacy or script blocker does not block them. If the map cannot be loaded, the customer sees "The Mondial Relay map could not be loaded. Please try again later or choose another shipping method."
The order page says No Point Relais was saved for this order: the order was placed without a point of the delivery country. The reason is written to the log. Ask the customer for the Point Relais before you create the shipment.
The page says the Mondial Relay carrier was not found: the carrier was deleted in Shipping > Carriers. Reset the module in Modules > Module Manager to create it again.
Uninstall
Go to Modules > Module Manager, open the menu next to VibeFox Mondial Relay and choose Uninstall. The license key and the license status are always removed. The cached pickup point lists are always removed. If Remove data on uninstall is on, the carrier is deleted (orders keep their history), and the settings, the log and the points of carts without an order are removed. If it is off, the carrier is only switched off and all settings are kept. Installing the module again restores the carrier status it had before. The pickup points saved in orders are always kept.
Mondial Relay is a trademark of its respective owner. This module is not affiliated with or endorsed by Mondial Relay.