Back

VibeFox Envioclick for WooCommerce — Help

Requirements

WordPress: 5.8 or later.

WooCommerce: 5.0 or later, installed and active. The plugin refuses to activate without it.

PHP: 8.0 or later.

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 WordPress go to Plugins > Add New > Upload Plugin, choose the plugin ZIP file and click Install Now. You can also upload the vfd_envioclick folder to /wp-content/plugins/ by FTP.

2. Click Activate.

3. Open the settings: WooCommerce > Settings > Shipping > VibeFox Envioclick, or click Settings under the plugin name on the Plugins page.

4. Enter your VibeFox license key in the license block at the top of the page and click Activate.

5. 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 store currency is not MXN or COP, enter the currency conversion rate.

6. Optionally add fixed prices per country and a fallback cost.

7. Add VibeFox Envioclick to a shipping zone in WooCommerce > Settings > Shipping > Shipping zones, or turn on Ignore shipping zones and choose countries.

Configuration

All settings are on one page: WooCommerce > Settings > Shipping > VibeFox Envioclick. They apply to every shipping zone. When you add the method to a zone, the zone window has only one field:

Title (zone): the name customers see for this zone. Leave it empty to use the global Method title.

When an API key is set, the plugin shows warnings at the top of the page if live rates cannot work: no conversion rate for a store currency other than MXN or COP, no User-Agent for Mexico, no origin postcode or DANE code, or no origin address for Colombia. Every time you save the settings, the cached quotes are cleared. Number fields accept both a point and a comma as the decimal separator.

General

Enable/Disable: switches the method on or off in all zones at once. Default: on.

Method title: the shipping method name shown in the cart and at checkout. A zone can override it. Default: Envioclick Shipping.

Carrier in the title: show the carrier and the estimated delivery time next to the title for live rates, for example "Envioclick Shipping (Estafeta Express, 1 day)". The carrier is saved to the order and shown in order e-mails either way. Default: on.

Envioclick API (live rates)

Optional. Without an API key only the fixed prices are used. 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.

API country: the country of your Envioclick account.

Mexico (quotes in MXN, postcodes): quotes by 5-digit origin and destination postcodes. This is the default.
Colombia (quotes in COP, DANE municipality codes): the customer's municipality is detected from the department and city entered at checkout, or from an 8-digit DANE code typed as the postcode. The price is the freight plus the mandatory insurance.

User-Agent (Mexico): the value issued by Envioclick support (soporte.tecnico@envioclick.com). 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 store currency is different, enter the value of 1 MXN or COP in your store currency, for example 0.05. The declared parcel value is converted back the same way. Leave it empty if the store 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 store address in WooCommerce > Settings > General if the store 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á.

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, an API error or no carrier for the route.

Price per country: a table of countries and prices in your store currency. Click + Add country to add a row and the cross to remove one. The row * Default applies to 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 method 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 (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 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.

Excluded shipping classes: hide the method if the cart contains a product from any of these WooCommerce shipping classes.

Tax status: Taxable adds WooCommerce tax to the shipping cost, None does not. Envioclick quotes already include the carriers' taxes, so choose None to avoid charging tax on shipping twice.

Availability without shipping zones

Ignore shipping zones: offer Envioclick for the countries below even if it is not added to a shipping zone.

Countries: the destination countries for that mode. Leave empty to use all countries you ship to. Used only when Ignore shipping zones is on.

Advanced

Debug log: logs rate calculations and API errors to WooCommerce > Status > Logs, source vfd_envioclick. The API key and customer addresses are not logged. Turn it off when you are done.

Remove data on uninstall: when on, deleting the plugin removes all Envioclick settings, zone methods and cached quotes. Deactivating the plugin never deletes settings.

How it works at checkout

When the customer enters a delivery address, WooCommerce asks the plugin for a rate. The plugin first checks the cart weight, the minimum order amount and the excluded shipping classes. If free shipping applies, the method is shown with a zero price and no request goes to Envioclick.

If an API key is set and the destination is in the API country, the plugin 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, "Bogotá D.C." works). The plugin picks the cheapest or the fastest home-delivery quote that is not cash on delivery and converts it to your store 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 method is hidden. The reason is written to the debug log.

The method works on the classic checkout and on the Cart and Checkout blocks. It is compatible with WooCommerce High-Performance Order Storage (HPOS).

The plugin 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, no extra insurance and no multi-parcel quotes. Live quotes are domestic only.

Orders

When an order is placed with a live Envioclick rate, the carrier and service are saved to the order. The admin order screen shows Envioclick carrier with the estimated delivery time under the shipping address. The customer's order page and the order e-mails (HTML and plain text) show Shipping carrier. The Envioclick rate ID of the quote is stored with the order's shipping line as hidden data; it is not shown on the order screen. Create the guide in your Envioclick account.

Orders placed with a fixed price have no carrier.

License key

The plugin works with a VibeFox license key from vibefox.net. The license block is at the top of WooCommerce > Settings > Shipping > VibeFox Envioclick. Paste the key into License key and click Activate. The block shows the status, for example the date the license is active until and your domain. Use Check now to check the status again, Change key to enter another key and Remove key to remove it from this site. The link Manage licenses and domains in your account opens your vibefox.net account.

One key works on one domain. Removing the key from a site does not free its domain slot. Free the slot in your vibefox.net account.

Without an active key, Envioclick is not shown to customers at checkout. Logged-in store managers still see it, marked (unlicensed — visible to admins only), so you can set up and test the plugin before you buy a key. A reminder appears on the Plugins page and on WooCommerce pages. Existing orders are not affected.

When a license expires, the plugin keeps working, but updates and support need a renewal. The status is checked again automatically in the background.

Troubleshooting

Envioclick does not appear at checkout: check that the license is active, Enable/Disable is on, and the method is added to the zone of the customer's country (or Ignore shipping zones is on and the country is allowed). Check the weight limits, Minimum order amount and Excluded shipping classes. Without a live rate the method needs a fixed price for the country, a * Default row or a Fallback cost.

Live rates do not appear: read the warnings at the top of the settings page, then turn on Debug log, reload the checkout and open WooCommerce > Status > Logs, source vfd_envioclick. Common reasons: no conversion rate (store 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 plugin never shows a peso amount as another currency.

Colombia: the city is not recognized: the customer must choose the department and type the municipality name. An 8-digit DANE code typed as the postcode also works. Developers can supply a DANE code with the vfd_evc_dane_code filter.

Tax is charged twice on shipping: Envioclick quotes already include the carriers' taxes. Set Tax status to None.

Rates look outdated after a change: save the settings page. This clears the cached quotes.

Developer filters: vfd_evc_quotation_request (request body), vfd_evc_api_url, vfd_evc_dane_code, vfd_evc_default_dimensions and vfd_evc_package_description.

The license block shows an error: follow the message in the block. For example, if the key is already used on another domain, free a slot in your vibefox.net account and click Check now. If the site address changed, click Check now to activate the key for the new domain. If the license server cannot be reached, the plugin keeps working on the last known status.

Uninstall

Deactivating the plugin keeps all settings and zone methods; only cached quotes are cleared. To remove it, deactivate and delete it on the Plugins page. The license key and license status of this plugin are always removed. Settings, zone methods and cached quotes are removed only if Remove data on uninstall was on. Otherwise they stay for a later re-install. The carrier saved in past orders is kept, and existing orders keep their shipping lines.

Envioclick is a trademark of its respective owner. This plugin is not affiliated with or endorsed by Envioclick.