VibeFox Envioclick for PrestaShop — Help
Requirements
PrestaShop: 8.0 to 9.x.
PHP: 8.0 or later. The module refuses to install on older PHP versions.
Envioclick account (for live rates only): an Envioclick account in Mexico or Colombia with API access. The API key is in your Envioclick account under Mi cuenta (top right) > Información del API. If you only use fixed prices, you do not need an Envioclick account.
User-Agent (Mexico only): Envioclick Mexico requires a User-Agent value for every API request. Ask Envioclick support for it (soporte.tecnico@envioclick.com).
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 Envioclick 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 the API key, choose the API country, enter the User-Agent (Mexico), the origin postcode or DANE code and the origin address. If your shop default currency is not MXN or COP, enter the currency conversion rate. For Colombia, click Add Colombian departments if the page offers it.
5. Optionally add fixed prices per country and a fallback cost, then click Save.
On install the module creates the Envioclick Shipping carrier with the delivery time text Courier delivery by the best Envioclick carrier. The carrier is assigned to all zones and all customer groups. 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 Envioclick > Configure. Each section has its own Save button, which saves the whole page. Every save also clears the cached Envioclick quotes. Number fields accept both a point and a comma as the decimal separator.
When an API key is set, the page shows warnings at the top if live rates cannot work: no conversion rate for a shop currency other than MXN or COP, no User-Agent for Mexico, no origin postcode or DANE code, or no origin address for Colombia. The page also warns if the weight or dimension unit of your shop is not recognized; set kg, g, lb or oz and cm, mm, m or in in International > Localization (Local units). When saving, the module checks that Method title is a valid carrier name, that number fields contain numbers that are not negative, that Currency conversion rate is greater than 0, that Minimum weight is not greater than Maximum weight, and that the origin code has 5 digits for Mexico or 8 digits (or the 5-digit municipality code) for Colombia. If a check fails, an error is shown and nothing is saved.
General
Zones, customer groups and size limits of the carrier are set in Shipping > Carriers (or use Ignore shipping zones below). The settings on this page apply to every zone.
Enable Envioclick: turns the carrier on or off. This is the same switch as the carrier status in Shipping > Carriers.
Method title: the carrier name shown to the customer in the cart and at checkout. Default: Envioclick Shipping. Required.
Carrier in the title: show the Envioclick carrier and the estimated delivery time of a live rate under the carrier at checkout, for example "Estafeta Express, 1 day". The carrier is saved to the order and shown on the order pages either way. Default: on.
Envioclick API (live rates)
Optional. Without an API key only the fixed prices are used. The section links to the Envioclick API documentation for Mexico and Colombia. Live rates are requested only for destinations in the API country. Shipping to other countries uses the fixed prices.
API key: your Envioclick API key from Mi cuenta > Información del API. It is sent in the "Authorization" header. After saving, the field stays empty and shows Saved — leave empty to keep it. Type a new value only to change it.
Remove the saved API key: shown only while a key is saved. Choose Yes and save to delete the key; only the fixed prices are used then. A key typed in API key replaces the saved one instead.
API country: the country of your Envioclick account.
Colombian departments: Colombia only. PrestaShop has no Colombian departments by default. Without them only city names that are unique in Colombia are recognized; the department tells apart municipalities with the same name. The button Add Colombian departments adds the 33 departments as states of Colombia (ISO codes ANT, DC and so on), turns on "Contains states" for Colombia and adds the department field to the Colombian address form. Departments that already exist are not added twice. When everything is in place, the field shows how many departments Colombian addresses have.
User-Agent (Mexico): the value issued by Envioclick support (soporte.tecnico@envioclick.com), for example EcUserAgent-2/123456. Required for Mexico; live rates for Mexico are not requested without it. Optional for Colombia.
Carrier choice: Cheapest (default) or Fastest (then cheapest). Envioclick returns quotes from several carriers, and the customer gets one rate.
Branch pickup rates: also consider "Ocurre" rates, where the customer collects the parcel at the carrier's branch. When off, only home delivery rates are used. Cash-on-delivery (COD) services are never used. Default: off.
Currency conversion rate: Envioclick quotes in MXN (Mexico) or COP (Colombia). If your shop default currency is different, enter the value of 1 MXN or COP in your shop currency, for example 0.05. The declared parcel value is converted back the same way. Leave it empty if the shop currency is MXN or COP. Without it, live rates are not used in another currency.
Ship from
Used for live rates. Empty fields are taken from the shop address in Shop Parameters > Contact > Stores if the shop is in the API country.
Origin postcode / DANE code: Mexico: the 5-digit postcode. Colombia: the 8-digit DANE code of the municipality, for example 11001000 for Bogotá; the 5-digit municipality code (11001) also works.
Origin address: the street and number of the pickup address. Required for Colombia, optional for Mexico.
Fixed prices
Used when there is no live rate: no API key, a destination outside the API country, or an API error or no carrier for the route.
Price per country: a table of 2-letter country codes and prices in your shop default currency, tax excluded. Click Add row to add a country and the trash icon to remove one. Use * as the country code for all countries without their own row.
Fallback cost: used when there is no live rate and no row of the table matches. Leave it empty to hide the carrier in that case.
Fixed price applies: Per order charges the price once. Per item (price × quantity) multiplies it by the number of items in the cart. Live Envioclick rates are always per shipment.
Conditions
Minimum weight: hide the carrier below this cart weight, in kg. 0 means no limit.
Maximum weight: hide the carrier above this cart weight, in kg. Default: 25. 0 means no limit.
Minimum order amount: show the carrier only when the cart subtotal (after discounts, before tax) is at least this amount. Leave empty to always show it.
Free shipping from: free shipping when the cart subtotal (after discounts, before tax) reaches this amount. No API request is made then. Leave empty to never give free shipping.
Tax: the tax rule of the carrier, or No tax. Envioclick quotes already include the carriers' taxes, so choose No tax to avoid charging tax on shipping twice.
Availability without shipping zones
Normally the carrier is offered in the zones assigned to it in Shipping > Carriers.
Ignore shipping zones: offer Envioclick for the countries below even if the carrier is not assigned to their zone. When you turn it on, the carrier is assigned to all zones, including zones created later. When you turn it off, the carrier gets its previous zones back.
Countries: the destination countries for that mode. Leave empty to use all countries you ship to (active countries). Used only when Ignore shipping zones is on.
Advanced
Debug log: logs rate calculations and API errors to logs/vfd_evc_debug.log.php in the module folder. The file cannot be opened from the web. The API key and customer addresses are not logged. Nothing is written while the log is off. Turn it 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 Envioclick settings, the carrier, cached quotes and logs. The carrier saved with past orders is kept. When off, everything is kept for a re-install.
How it works at checkout
At the shipping step PrestaShop asks the module for the Envioclick price. Only physical products count: virtual products add no weight and are not included in the order amount. The module first checks the conditions: the countries of Ignore shipping zones, the cart weight and the minimum order amount. If free shipping applies, the price is 0 and no request goes to Envioclick.
If an API key is set and the destination is in the API country, the module asks Envioclick for quotes. In Mexico the request is made once the customer has entered a 5-digit postcode. In Colombia it is made once the department and municipality are recognized (accents and case do not matter). The module picks the cheapest or the fastest quote that is not cash on delivery and converts it to your shop default currency. The price is then shown in the customer's cart currency.
The parcel is always one box: the total weight converted to kg, and the length and width of the largest item with a height that keeps the total volume of all items. Products without dimensions count as 10 × 10 × 10 cm. A cart without any weight is sent as 0.5 kg. The declared value is the cart subtotal.
Each quote is cached for 1 hour for the same route and parcel. A failed request is cached for 10 minutes, so an unavailable API does not slow down every checkout update. The API timeout is 10 seconds. If Envioclick returns an error or no carrier for the route, the customer sees no error: the fixed price is used, or the carrier is hidden. The reason is written to the debug log.
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 calculates rates only. It does not create guides or labels, request pickups, track or cancel shipments. It offers one rate, not a choice between carriers, and uses no cash-on-delivery services and no multi-parcel quotes. Live quotes are domestic only.
Orders
When an order is placed with the Envioclick carrier, the rate calculated for its cart is saved with the order and no longer changes. The admin order page shows the block Envioclick shipping with Envioclick carrier, Estimated delivery and Envioclick rate ID (for a live rate), Price source (Envioclick live rate, Fixed price per country, Fallback cost or Free shipping threshold) and Calculated price (excl. tax). For a live rate the customer's order page shows Shipping carrier. Create the guide in your Envioclick account.
Orders placed with a fixed price have no Envioclick carrier.
License key
The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox Envioclick is the first block on Modules > Module Manager > VibeFox Envioclick > 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-envioclick 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 Envioclick 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
Envioclick does not appear at checkout: check that the license is active and Enable Envioclick 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. Check the weight limits and Minimum order amount. Without a live rate the carrier needs a fixed price for the country, a * row or a Fallback cost. Products can also be limited to certain carriers in the product page.
Live rates do not appear: read the warnings at the top of the module page, then turn on Debug log, reload the checkout and look at the Log field on the module page. Common reasons: no conversion rate (shop currency is not MXN or COP), no User-Agent (Mexico), no origin postcode or DANE code, the customer's postcode (Mexico) or city (Colombia) is not entered yet, the destination is outside the API country, or no carrier for the route.
Why a conversion rate? Envioclick returns prices in Mexican or Colombian pesos only. The module never shows a peso amount as another currency.
Colombia: the city is not recognized: click Add Colombian departments on the module page so customers can choose the department, and check that the municipality name is typed correctly. An 8-digit DANE code typed as the postcode also works.
Tax is charged twice on shipping: Envioclick quotes already include the carriers' taxes. Set Tax to No tax.
Rates look outdated after a change: click Save on the module page. This clears the cached quotes.
The page says the Envioclick 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 Envioclick and choose Uninstall. The license key and the license status are always removed. The cached quotes and the saved rates of carts without an order are always removed. If Remove data on uninstall is on, the carrier is deleted (orders keep their history) and the settings and log are removed. If it is off, the carrier is only disabled and all settings are kept. Installing the module again gives the saved carrier its previous status back. The Envioclick data of placed orders is kept in both cases.
Envioclick is a trademark of its respective owner. This module is not affiliated with or endorsed by Envioclick.