VibeFox Aramex for PrestaShop — Help

Requirements

PrestaShop: 8.0 to 9.x.

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

Aramex account (for live rates only): live rates use the Aramex Rate Calculator API. Aramex gives API access to its account holders. Ask your Aramex account manager or see the Aramex Developers Solution Center on the Aramex website. You need six values: API username (usually an e-mail address), password, account number, account PIN, account entity (for example DXB) and account country code (for example AE). If you only use fixed prices per country, you do not need an Aramex account.

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 Aramex 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. Choose how the shipping cost is calculated, fill in the matching sections (see Configuration) and click Save.

On install the module creates the Aramex carrier with the delivery time text Courier delivery. The carrier is assigned to all zones and 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 Aramex > Configure. Each section has its own Save button, which saves the whole page. Every save also clears the cached Aramex rates.

General

Enable Aramex: turns the carrier on or off. This is the same switch as the carrier status in Shipping > Carriers.

Method title: the carrier name shown in the cart and at checkout. Default: Aramex. Required.

Shipping cost: how the price is calculated.

The reason for a missing live rate is written to the debug log. It is never shown to the customer.

Aramex API account (needed for live rates only; all six fields are required)

Username: your Aramex API user name, usually an e-mail address.

Password: your Aramex API password. After saving, the field stays empty and shows Saved — leave empty to keep it. Type a new value only to change it.

Account number: your Aramex customer account number.

Account PIN: the PIN of your Aramex account. Like the password, it is not shown again after saving.

Account entity: the Aramex entity (office) code of your account, for example DXB, AMM or RUH.

Account country code: the 2-letter country code of your Aramex account, for example AE.

Aramex service (used for live rates)

If the delivery address is in the origin country, the shipment is quoted as Domestic. All other shipments are quoted as International express.

International service: the Aramex product for shipments abroad: PPX Priority Parcel Express (default), PDX Priority Document Express, PLX Priority Letter Express, DPX Value Express Parcels, EPX Economy Parcel Express, EDX Economy Document Express, GPX Ground Parcel Express or GDX Ground Document Express.

Domestic service: the Aramex product for shipments within the origin country: ONP Overnight Parcel (default), OND Overnight Document, SMP Same Day Parcel, SMD Same Day Document, SDD Same Day Delivery, EMD Early Morning Delivery, PEC Economy Delivery, PEX Road Express or HVY Heavy (20 kg and more).

Payment type: who pays Aramex for the shipment: Prepaid (shipper pays), Collect (receiver pays) or Third party. Usually Prepaid.

API weight unit: the unit sent to Aramex, KG or LB. Product weights and dimensions are converted from your shop units. The chargeable weight is the larger of the actual weight and the volumetric weight (length × width × height in cm / 5000). The minimum is 0.5 kg, which also covers products without a weight.

Currency conversion rate: Aramex is asked to quote in your shop default currency. If it still answers in another currency, the rate is multiplied by this number (1 unit of the Aramex currency = X units of your default currency). Leave it empty to reject such quotes, so a customer is never charged in the wrong currency.

Ship from (origin address) (used for live rates)

Origin country: the country you ship from. By default it is your shop country.

Origin city: the city you ship from. Aramex requires it.

Origin state / emirate: optional.

Origin postcode: optional.

If the origin country is your shop country, empty fields are taken from the shop address in Shop Parameters > Contact > Stores.

Fixed prices (used in the fixed mode and as the fallback for live rates)

Price per country: a table of 2-letter country codes and prices in your shop default currency, tax excluded. Click Add row to add a country and the trash icon to remove one. Use * as the country code for all other countries. Countries without a price (when there is no * row) get no fixed rate, so the carrier is hidden for them.

Fixed price applies: Per order charges the price once. Per item multiplies it by the number of items in the cart. Live Aramex rates are always per shipment.

Conditions

Minimum weight: hide the carrier when the cart weighs less, in kg. 0 means no limit.

Maximum weight: hide the carrier when the cart weighs more, in kg. Default: 100. 0 means no limit.

Minimum order amount: show the carrier only when the cart subtotal (after discounts, before tax) reaches this amount. Leave empty to always show it.

Free shipping: turn on free Aramex delivery from the amount below.

Free shipping from: the cart subtotal (after discounts, before tax) from which delivery is free. Used only when Free shipping is on.

Tax: the tax rule of the carrier, or No tax. Aramex live rates may already include VAT. In that case choose No tax so tax is not charged twice.

Countries: offer Aramex only for these destination countries. Leave empty to allow all countries of the carrier zones.

Advanced

Debug log: writes rate calculations and API errors to logs/vfd_armx_debug.log.php in the module folder. The file cannot be opened from the web. Passwords, PIN, account number and customer addresses are masked. Turn the log off when you are done.

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

Remove data on uninstall: when on, uninstalling the module deletes the Aramex settings, the carrier, cached rates and logs. When off, everything is kept for a re-install.

How it works at checkout

At the shipping step PrestaShop asks the module for the Aramex price. Only physical products count: virtual products add no weight and are not included in the order amount. The module first checks the conditions: allowed countries, cart weight and minimum order amount. If free shipping applies, the price is 0 and no request goes to Aramex.

In the fixed mode the price is taken from the table. In the live modes the module sends Aramex the origin and delivery addresses, the chargeable weight, the service and your default currency, and uses the returned total. A live rate is requested only when the delivery address has a city or postcode. The price is calculated in your default currency and then shown in the customer's cart currency.

Each answer is cached for 1 hour, so the same cart does not trigger a new request. A failed request is cached for 10 minutes, so the checkout does not wait for Aramex on every refresh. The API timeout is 10 seconds.

If Aramex returns an error, a zero amount or a quote in another currency without a conversion rate, the customer sees no error. The carrier is hidden, or the fixed price is used in the fallback mode. The reason is written to the debug log.

If you edit the 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 rates only. It does not create Aramex shipments, print labels, book pickups, track parcels or let customers choose an Aramex office. The parcel is always sent to Aramex as one piece.

License key

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

Aramex does not appear at checkout: check that the license is active and Enable Aramex is on. In Shipping > Carriers check that the carrier covers the zone of the customer's country and the customer's group. Check Countries, the weight limits and Minimum order amount. In the fixed mode, check that the country or * has a price. Products can also be limited to certain carriers in 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 API credentials, the Aramex error code, no origin city, no delivery city or postcode, a weight or amount limit, or a quote in another currency. With Aramex live rates, fixed prices if the API fails customers still get the fixed price while you fix the problem.

Error ERR75 in the log: Aramex rejected the login. Check the username, password, account number, PIN, entity and country code with your Aramex account manager.

Quote in another currency is rejected: Aramex answered in a currency other than your default currency. Enter Currency conversion rate, or ask Aramex to quote in your currency.

Tax is charged twice on shipping: Aramex totals may already include VAT. Set Tax to No tax.

Rates look outdated after a change: click Save on the module page. This clears the cached Aramex rates.

The page says the Aramex 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 Aramex and choose Uninstall. The license key, the license status and the cached rates are always removed. If Remove data on uninstall is on, the carrier is deleted (orders keep their history) and the settings and log are removed. If it is off, the carrier is only disabled and all settings are kept. Installing the module again turns the saved carrier back on.

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