VibeFox Loggi 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.

Loggi account (for live prices only): the live price uses the Loggi GraphQL API with an API key that Loggi issues for business accounts. Ask your Loggi account manager or Loggi integration support ([email protected]), see also the Loggi API documentation at docs.api.loggi.com. You need three values: the e-mail of your Loggi account, the API key and the numeric ID of your shop. If your Loggi account only has credentials for the newer Loggi REST platform API (client ID and secret), the live price is not available and the fixed prices are used. If you only use fixed prices, you do not need a Loggi account.

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-loggi-shipping. Without Composer: unpack the ZIP file into app/code/Vibefox/LoggiShipping/, so that registration.php is directly in that folder.

2. Run bin/magento module:enable Vibefox_LoggiShipping 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 Loggi. 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 Loggi API e-mail, API key, Shop ID and the pickup address and, if the base currency of your store is not BRL, the BRL exchange rate. Add fixed prices as a safety net (see Configuration). Set Enable Loggi to Yes and click Save Config.

The module adds the Loggi shipping method to Magento. Customers see it as Loggi - Courier delivery (carrier title and method name). It is off after installation (Enable Loggi = No).

Configuration

All settings are in Stores > Configuration > Sales > Delivery Methods > VibeFox Loggi, in the standard Magento configuration form. Like other Magento settings, they can be changed for a website or a store view with the Scope switcher at the top of the page. Remove data on uninstall is read from the Default Config only. Save Config saves the whole page and clears the cached Loggi prices. Amounts accept "9.99" and "9,99".

If a value is wrong, Magento shows an error and nothing on the page is saved: an empty Carrier title or Method name, longer than 64 characters or with one of the characters < > ; = # { }; an API e-mail that is not a valid e-mail address; a Shop ID that is not a positive whole number; a Sort order that is not a whole number; a number field that does not contain a number of 0 or more; a BRL exchange rate of 0; a Minimum weight (kg) greater than the Maximum weight (kg); a changed API e-mail with the old saved API key (see API key).

While Enable Loggi is Yes, the Information row at the top of the group shows warnings about an incomplete setup: the API e-mail, API key or numeric Shop ID are missing (only fixed prices are used, or, without fixed prices, the method is hidden), there is no pickup address, or the BRL exchange rate is missing for a base currency other than BRL. The warnings are shown only while the method is enabled, because the Delivery Methods page is shared by all shipping methods.

General

Enable Loggi: shows or hides Loggi at checkout. Default: No.

Carrier title: the carrier name shown in the cart and at checkout. Default: Loggi. Required, at most 64 characters.

Method name: shown after the carrier title, as "Carrier title - Method name". Default: Courier delivery. Required, at most 64 characters.

Sort order: the position among the shipping methods at checkout. A whole number, negative numbers are allowed.

Api (leave the credentials empty to use fixed prices only)

API e-mail: the e-mail of your Loggi account. The API key belongs to it. It must be a valid e-mail address. Clearing it also deletes the saved API key.

API key: your Loggi API key. It is sent only to Loggi and never logged. 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 (or API e-mail) and click Save Config. Only the fixed prices are used then. If you change API e-mail, enter the API key for the new e-mail as well. Otherwise Magento shows The API e-mail was changed. Enter the API key for the new e-mail as well. and nothing is saved. A change in upper or lower case only is accepted.

Shop ID: the numeric ID (pk) of your shop in the Loggi dashboard. Only a positive whole number is accepted.

Staging: use the Loggi staging environment with test credentials. Staging and production use different accounts and keys. Default: No.

Pickup address: where Loggi collects the parcels, in one line: street and number, neighbourhood, city, state and CEP, for example Rua Example, 123 - Bairro, São Paulo - SP, 01310-100. Leave it empty to use the shipping origin from Stores > Configuration > Sales > Shipping Settings > Origin, if it is in Brazil and has a street address and a city. Without a pickup address Loggi cannot estimate and only fixed prices are used.

BRL exchange rate: Loggi prices are in Brazilian reais. If the base currency of your store is BRL, this field is not needed. Otherwise enter how many units of the base currency 1 BRL is worth, for example 0.16. It must be greater than 0. Leave it empty and live prices are not used, the fixed prices apply.

Prices (in the base currency of your store, tax excluded)

Fixed prices are used when the Loggi API is not configured, for destinations outside Brazil or without a full CEP, and whenever Loggi returns no price (API down, key rejected, address out of coverage).

Country prices: one row per destination country. Click Add country to add a row and Delete to remove one. Choose * All other countries for every country without its own row. Each row has a Base price and weight columns: ≤ 1 kg, ≤ 2 kg, ≤ 3 kg, ≤ 5 kg and > 5 kg. A weight column with a price above 0 replaces the base price for that weight. An empty (or 0) weight column uses the base price. Base price 0 means free shipping. When you save, invalid or negative prices are emptied, rows without any price are dropped, and for a country with two rows the first one is kept.

Fallback cost: used when there is no live Loggi price and no usable price in the table for the destination country (and no * row). Leave it empty to hide the method in that case. 0 means free.

Price applies: the way fixed prices are counted. A live Loggi price already covers the whole cart and is never multiplied.

Conditions

Minimum weight (kg): hide the method when the cart weighs less. 0 or empty means no limit.

Maximum weight (kg): hide the method when the cart weighs more. Default: 30. 0 or empty means no limit.

Minimum order amount: show the method only when the cart subtotal reaches this amount. Leave empty to always show it.

Free shipping from: delivery is free when the cart subtotal reaches this amount. No request goes to Loggi. Leave empty for no free shipping.

The cart subtotal is the total of the products that need shipping, after discounts, before tax, in the base currency. Product weights are converted to kg from the weight unit of your store (Stores > Configuration > General > General > Locale Options > Weight Unit, lbs or kgs). A product without a weight counts as 0 kg.

Ship to Applicable Countries: All Allowed Countries offers Loggi for every country your store allows, Specific Countries only for the countries below.

Ship to Specific Countries: the destination countries for Specific Countries. Live prices are requested for Brazil only; other countries use the fixed prices.

Shipping tax is not a setting of the module: if your store taxes shipping, set the tax class in Stores > Configuration > Sales > Tax > Tax Classes > Tax Class for Shipping.

Advanced

Debug log: writes rate calculations and Loggi requests to var/log/vfd_lggi_debug.log.php in the Magento folder. The file cannot be opened from the web. API errors are always logged, even when this is off. The API key and customer addresses are never logged.

Log: shows the size and the latest entries of the log. Click Clear log to empty it.

Remove data on uninstall: when Yes, uninstalling the module with its data deletes the Loggi settings and the log (see Uninstall). The license key and the cached prices are always removed. Orders are never changed.

How it works at checkout

At the shipping step Magento asks the module for the Loggi price. Only products that need shipping count: virtual and downloadable products add no weight and are not included in the subtotal. The module first checks the countries, the cart weight and Minimum order amount. If Free shipping from applies, the price is 0 and no request goes to Loggi. A Magento cart price rule with free shipping also makes the price 0.

For an address in Brazil with a full 8-digit CEP, the module builds Loggi packages: each item is turned so that its smallest side is the height, and items are stacked into one package while it stays within 55 × 55 × 55 cm and 20 kg. Magento products have no standard dimensions, so every item counts as 1 cm per side and volumetric weight is not calculated; every package weighs at least 100 g. Loggi accepts 2 packages per estimate, so bigger carts are sent in several requests and the totals are added up. The module sends Loggi your Shop ID, the pickup address, the delivery address (street, city, state and CEP) and the packages, and converts the Loggi total from BRL to your base currency. Magento then shows it in the customer's currency and adds tax on shipping if your store charges it.

Each Loggi price is cached for 1 hour per cart, address, account and environment, so the same cart does not trigger a new request. A failed estimate is cached for 10 minutes. If Loggi cannot be reached at all, requests pause for 2 minutes, so the checkout does not wait for Loggi on every refresh. The API timeout is 10 seconds.

The fixed prices are used instead when the API is not configured, the address is outside Brazil or has no full CEP yet, the BRL exchange rate is missing, there is no pickup address, a product is heavier than a Loggi package, the cart needs more than 10 packages, or Loggi returns an error, a rejected package, an address out of coverage or a zero total. If there is no fixed price either, the method is hidden. The customer never sees an API error. The reason is written to the log.

The module calculates prices only. It does not create Loggi orders or shipments, print labels, track parcels, show the delivery time at checkout or offer pickup points or lockers. Create shipments in the Loggi dashboard. Loggi delivers within Brazil only. Use the fixed prices for other countries. The order keeps the standard Magento shipping method and amount; the module adds no data of its own to orders.

License key

The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox Loggi is the first row of the VibeFox Loggi 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-loggi 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 Loggi method is not shown to customers at checkout and no price 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

Loggi does not appear at checkout: check that the license is active and Enable Loggi is Yes for the website of the store. Check Ship to Applicable Countries and Ship to Specific Countries, the warnings in the Information row, the weight limits and Minimum order amount. If the customer has not entered a full CEP yet or Loggi returns no price, the method needs a fixed price: a row for the country, a * row or Fallback cost.

Only fixed prices are shown: look at the Log field in the Advanced section. Errors are always logged. Set Debug log to Yes for every step and reload the checkout. Typical reasons: missing API e-mail, key or Shop ID, no pickup address, no BRL exchange rate for a base currency other than BRL, no full 8-digit CEP yet, a product heavier than 20 kg, or an address out of Loggi coverage.

HTTP 401 or 403 in the log: Loggi rejected the API e-mail or key. Check them with Loggi, and check that Staging matches the credentials: staging and production keys are different.

My store sells in euros or dollars: Loggi answers in BRL. Enter BRL exchange rate (how many units of your base currency 1 BRL is worth). Fixed prices are always in your base currency.

Prices are not accurate: fill in the weight of your products. Magento has no standard product dimensions, so the module counts each item as 1 cm per side and each package as at least 100 g. The real parcel price at Loggi can differ.

Per item does not multiply the Loggi price: this is intended. A live Loggi price covers the whole cart. Per item applies to fixed prices only.

Prices look outdated after a change: click Save Config on the Delivery Methods page. This clears the cached Loggi prices.

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_LoggiShipping. It removes the data and the code.

Installed in app/code: run bin/magento module:uninstall --non-composer Vibefox_LoggiShipping to remove the data, then bin/magento module:disable Vibefox_LoggiShipping, delete the folder app/code/Vibefox/LoggiShipping and run bin/magento setup:upgrade.

The license key, the license status and the cached Loggi prices are always removed. If Remove data on uninstall is Yes, the Loggi settings and the log are removed too. If it is No, the settings are kept for a re-install. Orders keep their shipping method and amount.

Loggi is a trademark of its respective owner. This module is not affiliated with or endorsed by Loggi.