VibeFox Jadlog for PrestaShop — Help
Requirements
PrestaShop: 8.0 to 9.x.
PHP: 8.0 or later. The module refuses to install on older PHP versions.
Jadlog contract (for live prices and Pickup points): live prices and the list of Pickup points come from the Jadlog Embarcador API. Your Jadlog franchise issues the access after the contract is signed. You need the Embarcador API token, the CNPJ (or CPF) of the shipper registered in the contract, the current account (conta corrente) and, if you have one, the contract number. If you only use fixed prices, you do not need a Jadlog contract.
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 Jadlog 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. Paste the API token, enter the CNPJ, current account, contract number and origin CEP, choose the Jadlog service and, if your shop default currency is not BRL, enter the BRL exchange rate. Add fixed prices or a fallback cost if you want them (see Configuration). Click Save.
5. To offer Jadlog Pickup points as well, turn on Enable Jadlog Pickup and click Save.
On install the module creates two carriers: Jadlog (home delivery, switched on, delivery time text Jadlog delivery to your address) and Jadlog Pickup (switched off, delivery time text Pickup at a Jadlog Pickup point). Both are linked to the zone of Brazil and to 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 Jadlog > Configure. They apply to both Jadlog carriers. Each section has its own Save button, which saves the whole page. Every save also clears the cached Jadlog prices and Pickup point lists.
At the top of the page the module shows warnings for an incomplete setup: no API token (only fixed prices are used, and Pickup points cannot be listed), no API token and no fixed prices (the method is never shown), no CNPJ or current account, no origin CEP, no BRL exchange rate for a shop that does not sell in BRL, a shop weight or dimension unit the module does not know (then weights are taken as kg and dimensions as cm; set the units in International > Localization, Local units), or a Jadlog carrier that was deleted. When you save, wrong values are reported: a CEP without 8 digits, a CNPJ without 14 digits (or 11 for a CPF), a number that is not valid, a minimum weight above the maximum weight (both weights keep their saved values), an unknown country or an invalid price in the price table.
General
Enable/Disable: turns Jadlog home delivery on or off. This is the same switch as the carrier status in Shipping > Carriers.
Method title: the name of the home delivery carrier shown in the cart and at checkout. Default: Jadlog. Required.
Tax status: None or Taxable with one of your tax rules. It is saved to both Jadlog carriers. Jadlog prices are final carrier prices. Choose None if PrestaShop must not add tax to them.
Jadlog live prices
Live prices are requested only for addresses in Brazil with a full 8-digit CEP.
API token: the Embarcador token from Jadlog. You can paste it with or without the word "Bearer". Leave it empty to use fixed prices only. 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 token: tick it and click Save to delete the saved token.
CNPJ: the CNPJ (14 digits) or CPF (11 digits) of the shipper registered in the Jadlog contract. Dots, slashes and dashes are allowed.
Current account (conta corrente): your Jadlog current account number. Without it and the CNPJ, Jadlog cannot quote and only fixed prices are used.
Contract number: your Jadlog contract number, if your franchise gave you one.
Origin CEP: the postal code the parcels are shipped from, 8 digits. It is saved in the format 00000-000. Leave it empty to use the shop postcode from Shop Parameters > Contact > Stores, if the shop address is in Brazil.
Jadlog service: the service (modalidade) of your contract for home delivery: .Package (3, default), .Com (9), Expresso (0), Rodoviário (4), Econômico (5), Doc (6), Corporate (7), Internacional (10), Cargo (12) or Emergencial (14). Jadlog Pickup (40) is the second carrier.
Insurance type: Normal (N) (default) or Own insurance policy (A - apolice), as agreed in your Jadlog contract.
Volumetric weight: Jadlog charges the greater of the real and the volumetric weight.
BRL exchange rate: Jadlog quotes in Brazilian reais. If your shop default currency is BRL, this field is not needed. Otherwise enter how much 1 BRL is in your default currency, for example 0.16. The Jadlog price is multiplied by this rate, and the declared order value sent to Jadlog is converted back to BRL. Without the rate live prices are not used and only fixed prices apply. Both a point and a comma are accepted as the decimal separator.
Delivery time: show the delivery time returned by Jadlog at checkout, under the Jadlog carrier and next to each Pickup point, for example "Delivery time: 3 business days". On by default. The delivery time is always saved with the order.
Jadlog Pickup
A second carrier with the Jadlog service Pickup (40). It needs the API token. Without points the carrier is hidden.
Enable Jadlog Pickup: turns the Jadlog Pickup carrier on or off. This is the same switch as its status in Shipping > Carriers. Off after install.
Jadlog Pickup carrier name: the name of this option at checkout. Default: Jadlog Pickup. Required.
Points to show: how many Pickup points to offer, from 1 to 10. Default: 5.
Fixed prices (used when there is no API token, for countries Jadlog does not serve, and whenever Jadlog returns no price)
Price per country: a table with the columns Country, Price, XS, S, M, L and XL, in your shop default currency. Click + Add country to add a row and the trash icon to remove one. The size column is chosen by cart weight: XS up to 1 kg, S up to 2 kg, M up to 3 kg, L up to 5 kg, XL above 5 kg. Price is used when the size column is empty. Price 0 means free shipping for that country. Use * Default (other countries) for all other countries. Rows without any price are removed when you save.
Fallback cost: used when neither Jadlog nor the table gives a price. Leave it empty to hide the carrier in that case.
Fixed price applies: Per order charges the price once. Per item (price x quantity) multiplies it by the number of items in the cart. This applies only to fixed prices and the fallback cost. Jadlog prices already cover the whole cart.
Conditions
Minimum weight (kg): hide the carriers when the cart weighs less. 0 means no limit.
Maximum weight (kg): hide the carriers when the cart weighs more. Default: 150. 0 means no limit.
Minimum order amount: show the carriers only when the cart subtotal (products that need shipping, after discounts, before tax) reaches this amount. Leave empty to always show them.
Free shipping from: the cart subtotal (after discounts, before tax) from which delivery is free. Leave empty for no free shipping.
Availability without shipping zones
Ignore shipping zones: offer Jadlog for the countries below even if its carriers are not linked to their zone. When you turn it on, both carriers are linked to every active zone, and zones created later are linked too. When you turn it off again, the carriers get back the zones they had before.
Countries: the destination countries for that mode, outside the carriers' own zones. Leave empty to allow all countries. This field is used only when Ignore shipping zones is on.
Advanced
Debug log: logs every Jadlog request and response to logs/vfd_jdlg_debug.log.php in the module folder. The file cannot be opened from the web. API errors are always logged, even when this option is off. The token, CNPJ and account are never logged and the customer CEP is shortened. Turn the log off when you are done.
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 all Jadlog settings and its carriers. When off, uninstalling only switches the carriers off. Cached prices are always removed. Orders are never changed.
How it works at checkout
At the shipping step PrestaShop asks the module for the price of each Jadlog carrier. Only physical products count: virtual products add no weight and are not included in the order amount. The module first checks the conditions: cart weight and minimum order amount, and with Ignore shipping zones the allowed countries. If the cart subtotal reaches Free shipping from, delivery is free and no price request goes to Jadlog.
For a delivery address in Brazil with a full 8-digit CEP, the module sends Jadlog the origin and destination CEP, the weight, your CNPJ, current account, contract, service, insurance type and the declared order value. The returned price is converted to your default currency and shown in the customer's cart currency. Carts without a weight are quoted as 0.1 kg. If there is no live price (no token, an address outside Brazil, an incomplete CEP, no BRL exchange rate, a Jadlog error), the module uses the Price per country table, then the Fallback cost. If none of them gives a price, the carrier is hidden for that cart.
Each price is cached for 1 hour, so the same cart does not trigger a new request. A failed request is cached for 10 minutes. If Jadlog does not answer, returns a server error or rejects the token, the API is not called again for 10 minutes. The API timeout is 10 seconds. The customer never sees an API error. The reason is written to the log.
If you edit a 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 prices and lists Pickup points only. It does not create Jadlog shipments, print labels, request collections, cancel shipments or track parcels. It does not show a map of Pickup points and does not request international quotes from Jadlog. Use fixed prices for other countries.
Pickup points
The Jadlog Pickup carrier is offered only for addresses in Brazil, and only when the API token is saved. When the customer has entered a full 8-digit CEP, the module asks Jadlog for the active Pickup points nearest to it and lists up to Points to show points under the carrier, each with its price, for example "point name — price (3 business days) — address". If the list is not cached yet, it is loaded when the customer selects the carrier, so the shipping step does not wait for Jadlog.
The price to each point is requested from Jadlog. If Jadlog gives no price for a point, the fixed price is used, and a point without any price is left out. Point lists are cached for 12 hours. The carrier price is the price of the chosen point. Before a point is chosen, it is the price of the nearest point that has a price. A point without a price does not hide the carrier while other points have one. After the customer chooses a point, the shipping step is refreshed with the new price.
A point is required. Without one the customer cannot continue and sees Please select a Jadlog Pickup point. The module checks that the point is in the Jadlog list for the delivery CEP. If not, the customer sees The selected Jadlog Pickup point is not in the Jadlog list for this CEP. Please choose the point again. When the CEP is incomplete, there are no points nearby or Jadlog is unavailable, a message is shown under the carrier.
Without an API token, without an 8-digit CEP, when Jadlog is unavailable or when there are no active points nearby, the Jadlog Pickup carrier is hidden. An order without a point could not be shipped.
Orders
When an order is placed with a Jadlog carrier, the module saves the Jadlog service and, when Jadlog returned it, the delivery time in business days. For a Jadlog Pickup order it also saves the Pickup point name, address and ID.
The admin order page shows a Jadlog block with Jadlog service, Delivery time and, for Jadlog Pickup, Pickup point, Pickup point address and Pickup point ID. The customer sees the chosen point on the order confirmation page and in the order details. The point is added to the carrier name in the order confirmation e-mail. The shop's new order e-mail (if you use the e-mail alerts module) also gets the point ID.
Book the shipment in the Jadlog system yourself. The order shows the service and the Pickup point ID you need for it.
License key
The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox Jadlog is the first block on Modules > Module Manager > VibeFox Jadlog > 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-jadlog 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 Jadlog carriers are 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 carriers are 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
Jadlog does not appear at checkout: check that the license is active and Enable/Disable (or Enable Jadlog Pickup) 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 weight limits and Minimum order amount. If the customer has not entered a full 8-digit CEP yet, only fixed prices can be used, so add a Price per country row or a Fallback cost. Products can also be limited to certain carriers in the product page.
Only fixed prices are shown: turn on Debug log, reload the checkout and look at the Log field on the module page. It shows the reason: no CNPJ or current account, no origin CEP, an incomplete destination CEP, no BRL exchange rate, or the Jadlog error message.
HTTP 401 or 403 in the log: Jadlog rejected the API token. Check it with your Jadlog franchise. The API is paused for 10 minutes after this error. Saving the settings clears the pause, so you can try again at once.
Pickup points do not appear: the Jadlog Pickup carrier needs Enable Jadlog Pickup, the API token and a full 8-digit CEP in Brazil. If Jadlog has no active points near the CEP, the carrier is hidden. Check the log for the reason.
Prices are in reais instead of my currency: enter the BRL exchange rate (how much 1 BRL is in your shop default currency).
Prices look too low or too high: fill in product weights and dimensions. Carts without a weight are quoted as 0.1 kg, and the volumetric weight needs dimensions.
Tax is added to Jadlog prices: set Tax status to None.
Prices look outdated after a change: click Save on the module page. This clears the cached Jadlog prices and Pickup point lists.
The page says a Jadlog 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 Jadlog and choose Uninstall. The license key and license status are always removed. The cached prices and Pickup point lists are always removed. If Remove data on uninstall is on, both carriers are deleted (orders keep their history) and the settings and log are removed. If it is off, the carriers are only switched off and all settings are kept. Installing the module again gives the carriers back the status they had. The Jadlog service, delivery time and Pickup point saved with orders are always kept.
Jadlog is a trademark of its respective owner. This module is not affiliated with or endorsed by Jadlog.