VibeFox Envioclick for Adobe Commerce — Hilfe
Requirements
Magento: Magento Open Source or Adobe Commerce 2.4.6 to 2.4.9, on your own server or hosting, on premises or on Adobe Commerce on cloud infrastructure. The module does not work with Adobe Commerce as a Cloud Service (the SaaS edition), which does not accept PHP modules.
PHP: 8.1 to 8.4, with the cURL and JSON extensions.
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 ([email protected]).
VibeFox license key: bought on vibefox.net. One key works on one domain.
Installation
The module is one ZIP file. It is a Composer package and can also be copied into app/code. Run the commands in the Magento root folder as the user that owns the Magento files.
1. With Composer: put the ZIP file into a folder that your project uses as a Composer "artifact" repository and run composer require vibefox/module-envioclick-shipping. Without Composer: unpack the ZIP file into app/code/Vibefox/EnvioclickShipping/, so that registration.php is directly in that folder.
2. Run bin/magento module:enable Vibefox_EnvioclickShipping and bin/magento setup:upgrade. In production mode also run bin/magento setup:di:compile and bin/magento setup:static-content:deploy, then bin/magento cache:flush.
3. In the Admin go to Stores > Configuration > Sales > Delivery Methods and open VibeFox Envioclick. Paste your VibeFox license key into License key in the license block, the first row of the group, 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 the base currency of your store is not MXN or COP, enter the currency conversion rate. Optionally add fixed prices per country and a fallback cost (see Configuration). Set Enable Envioclick to Yes and click Save Config.
The module adds the Envioclick shipping method to Magento. Customers see it as Envioclick - Standard shipping (method title and method name). It is off after installation (Enable Envioclick = No).
Configuration
All settings are in Stores > Configuration > Sales > Delivery Methods > VibeFox Envioclick, in the standard Magento configuration form. Like other Magento settings, they can be changed for a website with the Scope switcher at the top of the page; Method title and Method name also for a store view. The license block is set for the whole installation (Default Config). Save Config saves the whole page and clears the cached Envioclick quotes. Number fields accept both a point and a comma as the decimal separator ("9.99" and "9,99").
If a value is wrong, Magento shows an error and nothing on the page is saved: an empty Method title, longer than 64 characters or with one of the characters < > ; = # { }; an empty Method name or one longer than 64 characters; a Sort order that is not a whole number; a number field that does not contain a number or contains a negative number; a Currency conversion rate of 0; a Minimum weight greater than the Maximum weight; an origin code that does not have 5 digits for Mexico or 8 digits (or the 5-digit municipality code) for Colombia.
While Enable Envioclick is Yes and an API key is saved, warnings after saving remind you of settings that stop live rates: no conversion rate when the base currency is not the currency of the API country, no User-Agent for Mexico, no origin postcode or DANE code (neither in the settings nor in the shipping origin of the store), and no origin address for Colombia. The warnings are shown only while the method is enabled, because the Delivery Methods page is shared by all shipping methods.
General
Enable Envioclick: shows or hides Envioclick at checkout. Default: No.
Method title: the shipping method name shown to the customer in the cart and at checkout (the carrier title in Magento). Default: Envioclick. Required, at most 64 characters.
Method name: shown after the method title, as "Method title - Method name". Default: Standard shipping. Required, at most 64 characters.
Carrier in the title: adds the Envioclick carrier and the estimated delivery time of a live rate to the method name, for example "Standard shipping (Redpack Terrestre, 3 days)". Magento saves this name with the order, so it also appears in the order e-mails and on the order pages. The carrier is saved to the order and shown on the order pages either way. Default: Yes.
Sort order: the position among the shipping methods at checkout. A whole number, negative numbers are allowed.
Envioclick API (live rates)
Optional. Without an API key only the fixed prices are used. The section names the Envioclick API documentation for Mexico (apidoc.envioclickpro.com) and Colombia (apidoc.envioclickpro.com.co). 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 and never written to the log. Magento stores it encrypted and shows only a mask after saving. Leave the mask as it is to keep the saved key, type a new value to change it. To delete the saved key, clear the field and click Save Config. Only the fixed prices are used then.
API country: the country of your Envioclick account.
User-Agent (Mexico): the value issued by Envioclick support ([email protected]), 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. With No, only home delivery rates are used. Cash-on-delivery (COD) services are never used. Default: No.
Currency conversion rate: Envioclick quotes in MXN (Mexico) or COP (Colombia). If the base currency of the website is different, enter the value of 1 MXN or COP in the base currency, for example 0.05. The declared parcel value is converted back the same way. Leave it empty if the base currency is MXN or COP. Without it, live rates are not used in another currency, and the fixed prices apply.
Ship from
Used for live rates. Empty fields are taken from the shipping origin of the store (Stores > Configuration > Sales > Shipping Settings > Origin) if it 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. Only the digits are saved.
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. Prices are in the base currency of your store, tax excluded.
Price per country: a table of countries and prices. Click Add country to add a row and Delete to remove one. The row * All other countries is used for every country without its own row. Rows without a valid price (a number of 0 or more) are not saved.
Fallback cost: used when there is no live rate and no row of the table matches. Leave it empty to hide the method in that case. 0 means free.
Fixed price applies: Per order (default) 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 (kg): hide the method below this cart weight. 0 means no limit.
Maximum weight (kg): hide the method above this cart weight. Default: 25. 0 means no limit.
Minimum order amount: show the method only when the subtotal of the products that need shipping (after discounts, tax excluded, in the base currency) is at least this amount. Leave empty to always show it.
Free shipping from: free shipping when the subtotal of the products that need shipping (after discounts, tax excluded, in the base currency) reaches this amount. No API request is made then. Leave empty to never give free shipping.
Ship to Applicable Countries: All Allowed Countries (default) offers Envioclick for every country your store allows, Specific Countries only for the countries below.
Ship to Specific Countries: the destination countries for Specific Countries. Live rates are requested only for the API country; other countries use the fixed prices.
Product weights are converted to kg from the weight unit of your store (Stores > Configuration > General > General > Locale Options > Weight Unit, lbs or kgs). The module has no tax field: Envioclick quotes already include the carriers' taxes. If your store charges tax on shipping (Stores > Configuration > Sales > Tax > Tax Classes > Tax Class for Shipping), tax is added on top; choose None there to avoid charging tax on shipping twice.
Advanced
Debug log: logs rate calculations and API errors to var/log/vfd_evc_debug.log.php in the Magento 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 Yes, uninstalling the module with its data deletes the Envioclick settings and the log (see Uninstall). The value in Default Config is the one used. When No, they are kept for a re-install. The license key and the cached quotes are always removed. The Envioclick quotes saved with orders are order history and are never deleted.
How it works at checkout
At the shipping step Magento asks the module for the Envioclick price. Only products that need shipping count: virtual and downloadable products add no weight and are not included in the order amount. Magento first checks Ship to Applicable Countries; the module then checks the cart weight and the minimum order amount. If free shipping applies, the price is 0 and no request goes to Envioclick. A Magento cart price rule with free shipping also makes the price 0.
If an API key is saved 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). Magento lists the Colombian departments as regions. A city name that exists only once in Colombia, such as Bogotá, is recognized with any department. The module picks the cheapest or the fastest quote that is not cash on delivery and converts it to your base currency. Magento then shows the price in the customer's currency.
The parcel is always one box with the total cart weight in kg. Magento products have no standard dimensions, so every item counts as a 10 × 10 × 10 cm box. A cart without any weight is sent as 0.5 kg. The destination address is the first street line. 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 method is hidden. The reason is written to the debug log.
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 Envioclick, the rate calculated for its cart is saved with the order and no longer changes. On the admin order page (Sales > Orders > View, Information tab) the block Envioclick shipping shows 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) in the base currency. Create the guide in your Envioclick account.
For a live rate the customer sees Shipping carrier: with the Envioclick carrier on the order page in their account (or on the Orders and Returns page for guests). Orders placed with a fixed price have no Envioclick carrier. The block and the carrier line also work for older orders and when the module is switched off.
License key
The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox Envioclick is the first row of the VibeFox Envioclick group in Stores > Configuration > Sales > Delivery Methods, 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 store. Below them are the line Product: magento-shipping-envioclick and the link Manage licenses and domains in your account, which opens your vibefox.net account. Only Admin users whose role allows the Delivery Methods configuration section can change the key. The texts of the block follow the Admin interface locale (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 store 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 default store view, also when the installation has several websites or stores. Removing the key from the store does not free its domain slot. Free the slot in your vibefox.net account.
Without an active key, the Envioclick method is not shown to customers at checkout and no rate is calculated. The Magento storefront does not know that you are logged in to the Admin, so the method 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 the System Messages of the Admin, with the links Enter the license key and Dismiss, which hides it for 7 days. 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: once a day for the first 14 days after the key is entered, then once a week, by the Magento cron and while you work in the Admin. Uninstalling the module with its data 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 Yes for the website of the store. Check Ship to Applicable Countries and Ship to Specific Countries, the weight limits and Minimum order amount. Without a live rate the method needs a price for the country, a * All other countries row or a Fallback cost.
Live rates do not appear: read the warnings shown after Save Config, then turn on Debug log, reload the checkout and look at the Log field in the Advanced section. Common reasons: no conversion rate (the base 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: check that the customer chose the department in State/Province and typed the municipality name correctly. For Bogotá the city name is enough. 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 Class for Shipping to None.
Rates look outdated after a change: click Save Config on the Delivery Methods page. This clears the cached quotes.
The settings page or the checkout looks unchanged after installing or updating: run bin/magento setup:upgrade and bin/magento cache:flush; in production mode also setup:di:compile and setup:static-content:deploy.
Uninstall
Deleting the module code alone removes nothing from the database: the license key and the settings stay. To remove the data, uninstall the module with the Magento command:
Installed with Composer: run bin/magento module:uninstall --remove-data Vibefox_EnvioclickShipping. It removes the data and the code.
Installed in app/code: run bin/magento module:uninstall --non-composer Vibefox_EnvioclickShipping to remove the data, then bin/magento module:disable Vibefox_EnvioclickShipping, delete the folder app/code/Vibefox/EnvioclickShipping and run bin/magento setup:upgrade.
The license key, the license status, the cached quotes and the rates remembered for carts are always removed. If Remove data on uninstall is Yes, the Envioclick settings and the log are removed too. If it is No, the settings are kept for a re-install. The Envioclick data of placed orders (carrier, rate ID, price source and price) stays with the orders.
Envioclick is a trademark of its respective owner. This module is not affiliated with or endorsed by Envioclick.