VibeFox GLS ParcelShop for PrestaShop — Help
Requirements
PrestaShop: 8.0 to 9.x. The ParcelShop selection works in the Classic and Hummingbird themes.
PHP: 8.0 or later. The module refuses to install on older PHP versions.
GLS: no GLS account or API key is used or needed by the module. The ParcelShop map is public. You need a GLS contract to ship the parcels to the chosen ParcelShops.
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 GLS ParcelShop 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. Set your prices: at least one Country prices row (for example * Default) or a Fallback cost (see Configuration), and click Save.
On install the module creates the GLS ParcelShop carrier with the delivery time text Delivery to a GLS ParcelShop of your choice. The carrier is assigned to all customer groups and to the zones of the GLS map countries (in a standard shop usually Europe and Europe (non-EU)). You can change zones, customer groups, delivery time and logo 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 GLS ParcelShop > Configure. Each section has its own Save button, which saves the whole page.
Warnings at the top of the page point out configuration problems: the carrier was not found, the shop weight unit is not known to the module (set kg, g, lb or oz in International > Localization, Local units), no price is set, or some or all of the selected Countries (ignore zones mode) are not covered by the GLS map. An invalid or negative number is refused with a message that names the field, and its previous value is kept. The other fields are still saved.
General
The section lists the countries covered by the GLS map. The carrier is not offered for other destination countries.
Enable/Disable: turns GLS ParcelShop on or off. This is the same switch as the carrier status in Shipping > Carriers.
Name: the shipping method name shown to the customer (the carrier name). Default: GLS ParcelShop. Required, at most 64 characters.
Tax status: the tax rule of the carrier. None means shipping is not taxed. Choose a tax rule to make shipping taxable.
Prices
Prices are entered in your shop default currency, tax excluded. Decimals may use a comma or a point (4,99 or 4.99). The price is shown to the customer in the cart currency.
Calculation type: how the price is applied.
Country prices: a table with one row per destination country. Click Add country to add a row and the trash icon to remove one. Each row has a Country, a Price and five weight columns: XS up to 1 kg, S 1-2 kg, M 2-3 kg, L 3-5 kg and XL over 5 kg. The column for the cart weight is used. A weight column left at 0 uses the Price column. The * Default row is used for countries without their own row. New rows start with * Default and 0 in every column, and a row where all prices are 0 gives free delivery, so choose the country and fill in the prices before you save. If a value in the table is not a valid number, the whole table is not saved and the message lists the wrong values.
Fallback cost: the price used when the table has no row for the destination country and no * Default row. Leave it empty to hide the carrier for such countries.
Free shipping from: the cart subtotal (after discounts, without tax) from which GLS ParcelShop delivery is free. Leave it empty if delivery is never free.
Availability
Minimum weight (kg): hide the carrier when the cart weighs less. The weight is converted from your shop weight unit. Empty or 0 means no limit.
Maximum weight (kg): hide the carrier when the cart weighs more. Default: 20. GLS ParcelShops usually accept parcels up to 20 kg, so check your GLS contract. Empty or 0 means no limit. If the minimum is greater than the maximum, both weights are refused with a message and the previous values are kept.
Minimum cart subtotal: offer the carrier only when the cart subtotal (after discounts, without tax) reaches this amount. Leave it empty for no minimum.
Ignore shipping zones: when on, the carrier is linked to all zones, including disabled ones, and is offered for the countries selected below, even if they are not in its zones. Zones created later are linked too. When you turn it off, the carrier gets back the zones it had before and is offered only there. Default: off.
Countries (ignore zones mode): the destination countries for that mode. Leave it empty to use all GLS map countries. Countries not covered by the GLS map are skipped. This field is used only when Ignore shipping zones is on.
Advanced
Debug log: writes rate calculations and ParcelShop choices to logs/vfd_glps_debug.log.php in the module folder. The file cannot be opened from the web. Errors are always logged. No customer personal data is logged. Turn the log off when you are done.
Log: shows the size and the latest entries of the debug log. Click Clear log to empty it.
Remove data on uninstall: when on, uninstalling the module deletes the settings, the carrier and the log. When off, everything is kept for a re-install. The ParcelShop saved in orders is always kept.
How it works at checkout
When PrestaShop shows the delivery step, it asks the module for the GLS ParcelShop price. Only physical products count: virtual products add no weight and are not included in the cart subtotal. The module first checks the conditions: delivery country covered by the GLS map (and selected in Countries (ignore zones mode) when that mode is on), cart weight and minimum cart subtotal. If the cart subtotal reaches Free shipping from, the delivery is free. Otherwise the price is taken from the row of the country (or the * Default row) and the weight column, or from Fallback cost. If no price is found, the carrier is hidden.
When the customer selects GLS ParcelShop, a GLS ParcelShop box with a Select GLS ParcelShop button appears under the carrier. It opens the official GLS ParcelShop map for the delivery country. After a ParcelShop is chosen, its name and address are shown and the button changes to Change ParcelShop. The choice is saved to the cart, so it stays after the delivery step refreshes or the page reloads. If the delivery address changes to another country, the customer has to choose a ParcelShop again.
When the customer clicks Continue in the delivery step, the module checks that a ParcelShop was chosen and that it is in the delivery country. Otherwise the customer sees Please select a GLS ParcelShop. or The selected GLS ParcelShop is not in your shipping country. Please choose a ParcelShop again. and stays in the delivery step. If the ParcelShop cannot be saved, the customer sees The ParcelShop could not be saved. Please try again. If the GLS map script cannot be loaded, the customer sees a message to reload the page or choose another shipping method.
The GLS map runs in the customer's browser. In the checkout the module loads the GLS map script from map.gls-croatia.com, and the map loads ParcelShop data and map tiles from GLS. GLS receives the usual request data of the visitor (IP address, browser). Nothing is sent from your server to GLS.
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 get live GLS rates, create GLS shipments, print labels or track parcels. It has no list of ParcelShops on your server, so it cannot verify the ParcelShop ID against GLS. Hand the ParcelShop ID from the order to GLS in your usual way (MyGLS, your GLS software or another module).
Pickup points
When the order is placed, the ParcelShop of the cart is saved with the order: its ID, its name with the address and its country. It no longer changes with the cart.
Admin order page: a GLS ParcelShop block shows the ParcelShop name and address with the ParcelShop ID and country. If a GLS ParcelShop order has no ParcelShop, the block shows No ParcelShop was selected for this order.
Customer pages: the ParcelShop is shown on the order confirmation page and on the order details page in the customer account.
E-mails: the ParcelShop is added to the carrier name in the order confirmation e-mail to the customer. The new order e-mail to the merchant (Mail alerts module) also includes the ParcelShop ID.
License key
The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox GLS ParcelShop is the first block on Modules > Module Manager > VibeFox GLS ParcelShop > 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-gls-parcelshop 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 GLS ParcelShop 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
GLS ParcelShop 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 and check Countries (ignore zones mode)). Check that the destination country is one of the GLS map countries and has a price (a country row, the * Default row or Fallback cost). Check the weight limits and Minimum cart subtotal. Products can also be limited to certain carriers in the product page. Turn on Debug log and look at the Log field to see the reason.
The map does not open: the customer sees "The GLS ParcelShop map could not be loaded..." when the GLS script is blocked, for example by an ad or privacy blocker, a content security policy or a GLS outage. Allow map.gls-croatia.com in your content security policy.
Delivery is free for a country by mistake: check the row of that country in Country prices. A row where the Price and all weight columns are 0 gives free delivery.
The table or a field was not saved: a value is not a valid number. The message at the top of the page names the value. Use digits with a comma or a point as the decimal separator.
The page says the GLS ParcelShop carrier was not found: the carrier was deleted in Shipping > Carriers. Reset the module in Modules > Module Manager to create it again. Reset keeps the status of an existing carrier: a disabled carrier stays disabled.
An order has no ParcelShop and the log says the ParcelShop of the cart is already saved in another order: one cart became two orders. The first order keeps the ParcelShop. Give the second order to GLS by hand.
Uninstall
Go to Modules > Module Manager, open the menu next to VibeFox GLS ParcelShop and choose Uninstall. The license key and the license status 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 ParcelShops of carts without an order are removed. If it is off, the carrier is only disabled and all settings are kept. Installing the module again gives the saved carrier back its previous status. The ParcelShop saved in orders is always kept.
GLS is a trademark of its respective owner. This module is not affiliated with or endorsed by GLS.
