VibeFox LP Express for Adobe Commerce — Ajuda

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.

LP Express: no API account is needed. LP Express has no public price API, and the module does not use the Unisend API, so you enter your own (contract) prices. Create the parcels in your Unisend ("Mano siuntos") account.

Parcel terminal list: the module uses the open LP Express terminal list (https://www.lpexpress.lt/index.php?cl=terminals&fnc=getTerminals). No key is needed. If this online list is unavailable, the module uses the last downloaded copy if there is one, otherwise your own list. Be ready to enter your own list (see Configuration).

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

2. Run bin/magento module:enable Vibefox_LpExpressShipping 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 LP Express. 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. Fill in the price table (at least one row), a fallback cost or a free shipping threshold. Set Enable LP Express to Yes and click Save Config. Check the Information row at the top of the group: it shows how many parcel terminals are available. Add your own terminal list if the online list is not available.

The module adds the LP Express parcel terminal shipping method to Magento. Customers see it as LP Express parcel terminal - Parcel terminal (carrier title and method name). It is off after installation (Enable LP Express = No). The module also creates its own table for the terminals chosen in carts and orders.

Configuration

All settings are in Stores > Configuration > Sales > Delivery Methods > VibeFox LP Express, 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. Only the value of Remove data on uninstall in the Default Config is used. Save Config saves the whole page and reloads the online terminal list at the next request (the saved copy of the list is kept). Amounts and weights 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 < > ; = # { } (Enter a valid method title or name (64 characters max).), and a Sort order that is not a whole number (Sort order must be a whole number.).

Other mistakes do not stop the save, and a warning names them. An amount or weight that is not a number of 0 or more keeps its previous value. A Minimum weight (kg) greater than Maximum weight (kg) (30 kg when the maximum is empty) keeps both previous weights with Minimum weight exceeds maximum. The previous weights were kept., because the method would never be shown. Prices in the table that are not numbers are left empty with Some country prices were invalid and were left empty.

While Enable LP Express is Yes, the Information row at the top of the group shows notices: Set a country price, fallback cost or free shipping threshold. LP Express is hidden without a price.; No LP Express parcel terminals are available. Check the online list or enter your own list.; The online list is unavailable. A saved copy or your own terminal list is being used.; and the status line Parcel terminal list: with the number of terminals and cities. The notices are shown only while the method is enabled, because the Delivery Methods page is shared by all shipping methods.

General

Enable LP Express: shows or hides LP Express at checkout. Default: No.

Carrier title: the carrier name shown in the cart and at checkout. Default: LP Express parcel terminal. Required, at most 64 characters.

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

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

Prices (in the base currency of your store, tax excluded; decimals may be written as 2.99 or 2,99)

Country prices: one row per destination country. Click Add country to add a row (a new row starts with Lithuania) 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: XS ≤ 1 kg, S ≤ 2 kg, M ≤ 3 kg, L ≤ 5 kg and XL > 5 kg. The weight is the cart weight, or the weight of one item with Per item. An empty column uses the Base price of the row. 0 means free. A row without any price is removed when you save. If a country has several rows, the first one is used. If the row of the country has no price for the weight and no Base price, the Fallback cost is used.

Fallback cost: used when the table has no row for the destination country (and no * All other countries row). Leave it empty to hide the method for such countries. 0 means free.

Price applies: how the price is counted.

Per order: one price for the cart, with the weight column chosen by the total cart weight. This is the default.

Per item: every physical item is priced by the weight column of its own weight, multiplied by its quantity, and the prices are added up.

Free shipping from: the cart subtotal (products that need shipping, after discounts, before tax) from which LP Express is free. Leave empty for no free shipping.

The prices are in the base currency of your store; Magento shows them in the customer's currency. If your store charges tax on shipping, Magento adds it to these prices. Set this with Stores > Configuration > Sales > Tax > Tax Classes > Tax Class for Shipping.

Conditions

Minimum weight (kg): hide the method when the cart is lighter. Empty or 0 means no limit.

Maximum weight (kg): hide the method when the cart is heavier. LP Express terminals accept parcels up to 30 kg. Default: 30. An empty field means 30 kg, an explicit 0 means no limit.

Minimum order amount: show the method only from this cart subtotal (products that need shipping, after discounts, before tax). Leave empty to always show it.

Ship to Applicable Countries: All Allowed Countries (the default) offers LP Express for every country your store allows, Specific Countries only for the countries below. LP Express terminals are in Lithuania, so you may want to choose Specific Countries and Lithuania.

Ship to Specific Countries: the destination countries for Specific Countries.

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 price uses the actual weight (the sum of product weights). Magento products have no standard dimensions, so volumetric weight is not calculated.

Terminals

Terminal list: where the terminals come from.

LP Express online list: the online list is downloaded when it is needed and cached for 24 hours. When it cannot be loaded, the last downloaded copy is used, then your own list below, and the online list is tried again after 15 minutes. This is the default.

Only my own list: only the terminals you enter below are offered.

Advanced

Debug log: writes price calculation and terminal list details to var/log/vfd_lpex_debug.log.php in the Magento folder. The file cannot be opened from the web. Errors, such as an unavailable terminal list, are always logged, even when this is off. No customer names or addresses are 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 LP Express settings, the log, the saved copy of the terminal list and the terminals chosen in carts that did not become orders (see Uninstall). The license key is always removed. The terminals saved with orders are never deleted.

How it works at checkout

At the shipping step Magento asks the module for the LP Express price. Only products that need shipping count: virtual and downloadable products add no weight and are not included in the subtotal. The module checks the countries, the cart weight and Minimum order amount. If the cart subtotal reaches Free shipping from, the price is 0. Otherwise the price comes from the row of the country (or the * All other countries row): the weight column, else the Base price, else the Fallback cost. If there is no price, or no parcel terminal is available, the method is hidden, so the customer never sees a checkout that cannot be completed. A Magento cart price rule with free shipping makes an available LP Express price 0.

The online terminal list is cached for 24 hours. A failed download is remembered for 15 minutes, so the checkout does not wait for the list on every refresh. The download timeout is 10 seconds. Only active terminals from the list are offered. The last good copy of the list is kept apart from the Magento cache, so it survives cache:flush and Save Config.

The selector works in the standard Magento checkout (Luma). The module does not request LP Express or Unisend prices, create shipments, print labels, call a courier or track parcels. Create the parcels in your Unisend ("Mano siuntos") account. Courier (door-to-door) delivery is not part of this method.

Pickup points

When the customer selects LP Express, the block LP Express parcel terminal appears under the shipping methods with two lists: City (-- Choose a city --) and Parcel terminal (-- Choose a parcel terminal --). The city of the delivery address is pre-selected when it matches a city in the list (accents do not matter). Each terminal is shown with its name, address and ZIP. The customer may also choose a terminal in another city. The choice is saved to the cart right away, so it is not lost when the checkout refreshes.

A terminal is required. Without one, Next in the shipping step shows Please choose an LP Express parcel terminal. The terminal is checked against the current list on the server when it is chosen, when the customer clicks Next and again when the order is placed. A forged or outdated terminal ID is refused with This terminal is not in the LP Express list. Choose the parcel terminal again. If the choice cannot be saved, the customer sees The parcel terminal could not be saved. Please try again.

When the order is placed, the terminal ID, name and city are saved with the order. From then on the storefront cannot change them. The terminal is shown in these places:

Shipping description of the order: the module adds LP Express parcel terminal: with the terminal and its city to the shipping method of the order. The customer sees it in the order in their account (or on the Orders and Returns page for guests) and in the order e-mails, and you see it on the admin order page. Magento keeps at most 255 characters of this text; the full terminal name stays in the admin block.

Admin order page: on Sales > Orders > View, Information tab, the LP Express parcel terminal block shows the City, the Terminal ID and the terminal name and address. The block also works 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 LP Express is the first row of the VibeFox LP Express 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-lp-express 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 LP Express 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

LP Express does not appear at checkout: check that the license is active and Enable LP Express 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. Open the settings: the Information row explains if no price is set or no parcel terminal is available. With Debug log on, the Log field in the Advanced section shows why the method was hidden.

No parcel terminals: the online list could not be loaded and there is no saved copy or own list. The module tries again after 15 minutes. Enter your own list in Own terminal list, or choose Only my own list.

The terminal list is outdated: click Save Config on the Delivery Methods page. The online list is then downloaded again at the next request. With your own list, update the lines yourself.

The customer cannot continue: a parcel terminal must be chosen in the LP Express parcel terminal block. If the customer sees No LP Express parcel terminals are available. Choose another shipping method., no terminals are available right now. Add your own list.

An order created in the Admin with LP Express is refused: the Admin shows Please choose an LP Express parcel terminal. A terminal can be chosen only in the storefront checkout. Use another shipping method for orders created in the Admin.

In which currency are the prices: in the base currency of your store. Customers paying in another currency see the price converted by Magento.

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

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

The license key, the license status and the cached terminal list are always removed. If Remove data on uninstall is Yes, the LP Express settings, the log, the saved copy of the terminal list and the terminals chosen in carts without an order are removed too. If it is No, the settings and the saved copy are kept for a re-install. The terminals saved with orders and the shipping descriptions of orders are never deleted.

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