VibeFox Andreani for PrestaShop — Help

Requirements

PrestaShop: 8.0 to 9.x.

PHP: 8.0 or later. The module refuses to install on older PHP versions.

Andreani account (for live rates only): live rates use the Andreani quote API. Andreani issues API credentials, a client code and contract numbers to business customers, usually from about 300 shipments a month. See developers.andreani.com or write to ventapyme@andreani.com. You need the API username and password, the client code and the contract number. Andreani issues a separate contract for each service (home delivery, branch pickup). Without API access, use fixed prices. The branch selector works without credentials.

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 Andreani 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. Set the name, the rate source, the country prices (for example AR=5000) and, for live rates, the API credentials, client code and contract number (see Configuration). Click Save.

On install the module creates two carriers:

Andreani: the main carrier, switched on, with the delivery time text Andreani delivery in Argentina.

Andreani - branch pickup: the second option, switched off, with the delivery time text Pickup at an Andreani branch.

Both carriers are assigned to the zone of Argentina 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 Andreani > Configure. Each section has its own Save button, which saves the whole page. After saving you see Settings saved. Cached token, branches and rates were cleared. Warnings about missing settings (API credentials, contract number, ARS exchange rate, no price for Argentina, a deleted carrier) are shown at the top of the page. A warning also appears if the shop weight or dimension unit is not known to the module (weights are then read as kg, dimensions as cm). When you save, a name longer than 64 characters or a Min weight (kg) greater than Max weight (kg) is refused and nothing is saved. A value that is not a number, a negative number or an ARS exchange rate of 0 or less is not saved, and a warning names the field.

General

Enable/Disable: turns Andreani shipping on or off. This is the same switch as the status of the main carrier in Shipping > Carriers. The second option has its own switch.

Name: the carrier name shown to the customer at checkout. Default: Andreani. Required.

Tax status: None, or Taxable with one of your tax rules. With a tax rule, the shop adds tax to the shipping cost, so the API rate is taken without IVA. With None, the API rate is taken with IVA included. The setting is saved to both Andreani carriers.

Andreani API (needed for live rates)

Environment: Sandbox / QA (apisqa.andreani.com) (default) or Production (apis.andreani.com). Use the environment your credentials belong to.

API username: your Andreani API user name.

API password: your Andreani API password. After saving, the field stays empty and shows Saved - leave empty to keep it. Clearing the API username removes it too. Type a new value only to change it.

Client code: the client code (código de cliente) provided by Andreani, for example CL0000000.

Contract number: the contract of the service used for rates, for example home delivery. The second option can use another contract, for example for branch pickup.

Origin branch code: optional origin branch (sucursalOrigen) for rate quotes. Leave it empty to use the branch configured in your contract.

Delivery and rates

Delivery modality: the modality of the main carrier. The first part is where Andreani takes the parcel (your address or a branch where you drop it off). The second part is where the customer gets it.

Door to door (Puerta a Puerta): delivery to the customer's address. Default.

Door to branch (Puerta a Sucursal): the customer chooses an Andreani branch at checkout.

Branch to door (Sucursal a Puerta): delivery to the customer's address.

Branch to branch (Sucursal a Sucursal): the customer chooses an Andreani branch at checkout.

Rate source: how the price is calculated.

Fixed prices (Country prices below): the price comes from Country prices. No Andreani account needed.

Andreani API (method hidden when the API has no rate): the price is requested from Andreani for each cart.

Andreani API, fixed price if the API fails: the price is requested from Andreani. If there is no rate, the fixed price for the country is used.

Country prices: a fixed price per destination country in your shop default currency, tax excluded, one per line in the format CC=PRICE, for example AR=5000. Used by the fixed mode and as the API fallback. Countries without a line get no fixed price. Lines in another format are ignored, and a warning lists them when you save.

ARS exchange rate: Andreani quotes in Argentine pesos. Only needed if your shop default currency is not ARS: the price of 1 ARS in your shop currency, for example 0.001. Without it, API rates are not used.

Default product weight (kg): used for products without a weight when requesting API rates and checking weight limits. Empty means 0.5 kg.

Calculation type: Per order charges the price once. Per item (price x number of items) multiplies the fixed price from Country prices by the number of items in the cart. A live Andreani rate is already for the whole cart and is not multiplied.

Availability

Min weight (kg): the minimum cart weight for the carrier to appear. 0 means no limit.

Max weight (kg): the maximum cart weight. The carrier is hidden if it is exceeded. Empty means 100 kg, 0 means no limit.

Minimum subtotal: show the carrier only when the cart subtotal (products that need shipping, after discounts, tax excluded) is at least this amount. Leave it empty to always show it.

Ignore shipping zones: offer Andreani for the countries below without setting up zones. When you switch it on, both carriers are linked to all zones, and a zone created later is linked at once. When you switch it off, the carriers get their previous zones back.

Countries: the destination countries for that mode. Leave it empty to allow all countries. Only used when Ignore shipping zones is on.

Free shipping

Free shipping: turn on the free shipping threshold.

Free shipping from: the cart subtotal from which shipping is free. Requires Free shipping to be on.

Second option

A second Andreani carrier with its own name, delivery modality and contract, for example "a domicilio" in the main carrier and "retiro en sucursal" here, to offer both. All other settings are shared.

Enable second option: turns the second carrier on or off. This is the same switch as its status in Shipping > Carriers. Default: off.

Second option name: the name of this option at checkout. Default: Andreani - branch pickup. Required.

Delivery modality: Use global setting or one of the four modalities. Default: Door to branch (Puerta a Sucursal).

Contract number: Andreani issues a separate contract per service (home delivery, branch pickup). Leave it empty to use the global contract.

Branch selector at checkout (shown for door to branch and branch to branch)

Province select width: the CSS width of the province list, for example 100% or 300px. Default: 100%.

Branch select width: the CSS width of the branch list, for example 100% or 400px. Default: 100%.

Advanced

Debug log: logs API requests and rate calculations to logs/vfd_andr_debug.log.php in the module folder. The file cannot be opened from the web. Errors are always logged. Credentials and tokens 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 on, uninstalling the module deletes all module settings and the carriers. When off, uninstalling only switches the carriers off. Branch data saved in orders is always kept.

How it works at checkout

In the delivery step PrestaShop asks the module for the price of each Andreani carrier. Only physical products count: virtual products add no weight and are not included in the subtotal. The module checks the countries (when Ignore shipping zones is on), the cart weight (product weights are converted to kg, products without a weight use Default product weight (kg)) and Minimum subtotal.

In the fixed mode the price is taken from Country prices. In the live modes the module logs in to the Andreani API and requests a quote with the destination postcode, the contract, the client code, the weight in kg, the volume from product dimensions and the declared value (the cart subtotal in ARS). A live rate is requested only for a valid Argentine postcode. The ARS amount is converted with ARS exchange rate when your shop currency is not ARS. The price is calculated in your shop default currency and then shown in the customer's cart currency.

The login token is cached for 23 hours and renewed automatically when Andreani rejects it. Quotes are cached for 1 hour. A failed API call is not repeated for 5 minutes. API errors are never shown to the customer: the carrier is hidden, or the fixed price is used in the fallback mode. The reason is written to the log.

If Free shipping is on and the cart subtotal reaches Free shipping from, the price is 0. Free shipping applies only where the carrier has a price: if the Andreani API returns no rate and there is no fixed price to fall back to, the carrier is not shown.

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 does not create Andreani shipments, print labels or track parcels. Use the Andreani web portal for these.

Pickup points

When a carrier with Door to branch or Branch to branch is selected, a province list and a branch list appear under it in the delivery step. The province is pre-selected from the delivery address. The branch list comes from the public Andreani branch API and is cached for 12 hours. Branches that do not hand over parcels are not listed. If no branches are available, the customer sees No Andreani branches available right now. Please try again later or choose another shipping method.

The choice is saved to the cart as soon as the customer selects it. Only a branch from the current Andreani list is accepted. Without a branch, Continue in the delivery step and the order button in the payment step do not go through, and the customer sees Please select an Andreani pickup branch. The server checks the branch again when the customer continues. If the branch is no longer in the list, the customer sees The selected Andreani branch is not available. Please choose another one.

A branch chosen under Andreani before the customer switched to another carrier does not belong to the order.

Orders

The order keeps the delivery modality and, for the branch modalities, the chosen branch.

Admin order page: an Andreani block shows the modality and the branch (name, ID and province). Click Edit, choose another province and branch and click Save to change it. You see Branch updated. Only branches from the Andreani list can be saved. If the list is not available, the branch cannot be changed.

Customer: the branch is shown as Andreani pickup branch: on the order confirmation page and on the order details page.

E-mails: in the order confirmation e-mail and in the new order e-mail to the shop (Mail alerts module), the branch is added to the carrier name. The shop e-mail also shows the branch ID.

Existing orders keep their branch data.

License key

The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox Andreani is the first block on Modules > Module Manager > VibeFox Andreani > 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-andreani 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 Andreani 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

Andreani does not appear at checkout: check that the license is active and Enable/Disable is on (for the second carrier also Enable second option). 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 and check Countries. Check that Country prices has a line for the country (for fixed prices or as the fallback), and check the weight limits and Minimum subtotal. Read the warnings at the top of the Configure page. Products can also be limited to certain carriers on the product page.

Live rates do not appear: turn on Debug log, reload the checkout and look at the Log field on the module page. It shows the reason: missing credentials or contract number, a failed login (wrong username, password or environment), no valid Argentine postcode yet, no exchange rate, or an Andreani HTTP error. With Andreani API, fixed price if the API fails customers still get the fixed price while you fix the problem.

My shop is not in Argentine pesos: set ARS exchange rate to the value of 1 ARS in your shop default currency.

Shipping tax looks wrong: with a tax rule in Tax status the Andreani rate without IVA is used and PrestaShop adds its own tax. With None the rate with IVA is used and no tax is added. Check that taxes are enabled and the tax rule is set up for Argentina.

No branches in the list: the Andreani branch API did not answer. A failed request is retried after 5 minutes. Check the log.

Rates look outdated after a change: click Save on the module page. This clears the cached token, branch list and rates.

The page says an Andreani 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 Andreani and choose Uninstall. The license key and license status are always removed. The cached token, branch list and rates are always removed. If Remove data on uninstall is on, the carriers are deleted (orders keep their history), and the settings, the log and branch choices of carts without an order are removed. If it is off, the carriers are only switched off and all settings are kept. Installing the module again, or a Reset of the module, gives both carriers their previous status. Branch data saved in orders is never deleted.

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