VibeFox GIG Logistics for PrestaShop — Help

Requirements

PrestaShop: 8.0 to 9.x.

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

GIG Logistics API credentials (for live prices only): live prices use the GIG Logistics third-party API. GIG Logistics issues an API username (usually an e-mail address) and password to business customers. Request them on the GIG Logistics developer page (giglogistics.com/developer). Test credentials work only with the test API. If you only use the price table and the fallback cost, you do not need API credentials.

Nigeria in your shop: live prices are requested for delivery addresses in Nigeria only, so the country Nigeria must exist and be active in International > Locations > Countries.

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 GIG Logistics 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. Fill in the price table and/or the fallback cost. For live prices, also enter the API username and password, the pickup phone, city and state, and the currency conversion rate if your default currency is not NGN (see Configuration). Click Save.

5. If the Nigerian states field shows the Add Nigerian states button, click it (see Configuration).

On install the module creates the GIG Logistics carrier with the delivery time text Courier delivery. The carrier is linked to the zone of Nigeria (in a default shop, Africa) 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 GIG Logistics > Configure. Each section has its own Save button, which saves the whole page. Every save also clears the cached GIG Logistics prices, API tokens and address coordinates.

Above the sections, the page shows warnings when live prices cannot be used: only one of the API username and password is entered, Sender phone or the pickup city and state are missing, or your default currency is not NGN and no Currency conversion rate is set. It also warns when the GIG Logistics carrier was not found, and when your shop weight unit (International > Localization > Local units) is not one the module knows, in which case product weights are read as kg. When you save, a wrong number (a negative amount, a Currency conversion rate of 0, a latitude outside -90 to 90, a longitude outside -180 to 180), a Min weight (kg) above Max weight (kg), an empty or invalid Method title or an unknown tax rule is reported, and nothing is saved.

General

The settings on this page apply to every zone of the carrier.

Enable/Disable: 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: GIG Logistics. Required.

Tax: the tax rule of the carrier, or No tax. A tax rule adds your shipping tax on top of the cost. Choose No tax if the GIG price already includes everything you want to charge.

GIG Logistics API (live prices) (optional)

With API credentials, the price is requested from GIG Logistics for every Nigerian address. Without credentials, or when the API gives no price, the price table and the fallback cost are used.

API username: your GIG Logistics third-party API username, usually your e-mail address.

API password: your GIG Logistics third-party API password. It is used only to log in to the API and is never logged. After saving, the field stays empty and shows Saved — leave empty to keep it. Type a new value only to change it. To remove the password, clear API username and save.

Test mode: use the GIG Logistics test (dev) API. Test credentials work only with the test API. Turn it off for real prices. Default: off.

Currency conversion rate: GIG Logistics returns prices in NGN. If your shop default currency is not NGN, enter how much one NGN is worth in your default currency (1 NGN = ? of your currency, for example 0.0006). The rate must be above 0. Without it, live GIG prices are not used. If your default currency is NGN, the field says so and is not needed. Both a point and a comma are accepted as the decimal separator.

Pickup (sender) address

Where GIG Logistics picks up the parcels, in Nigeria. If your shop is in Nigeria, empty street, city and state fields use the shop address from Shop Parameters > Contact > Stores.

Sender name: the sender name sent to GIG Logistics. Empty means the shop name.

Sender phone: your phone number, for example 08030000000. Required by GIG Logistics for live prices.

Street address: the pickup street address.

City / area: the pickup city or area, for example Victoria Island. Required for live prices.

State: the Nigerian state of the pickup address, chosen from the 37 states. The default option, Shop state (Shop parameters > Contact > Stores), uses the state of the shop address. Required for live prices.

Pickup latitude: optional map latitude of the pickup point, for example 6.4281. GIG Logistics prices by distance. Empty means the coordinates are looked up from the address.

Pickup longitude: optional map longitude of the pickup point, for example 3.4219.

Address lookup: find map coordinates of addresses with OpenStreetMap (Nominatim). GIG Logistics calculates the price from the pickup and delivery coordinates. The customer's street, city and state are sent to nominatim.openstreetmap.org, and the results are cached for 30 days. Without it only the address text is sent, and GIG Logistics may not return a price. Default: on.

Nigerian states: the state of the delivery address is sent to GIG Logistics and to the address lookup. PrestaShop has no Nigerian states by default; without them only the street and city are used. The Add Nigerian states button adds the 37 states (codes LA, FC and so on), turns on Contains states for Nigeria and adds the state field to the Nigerian address form. States that already exist (by code or by name) are not added twice. When everything is in place, the field shows how many states Nigerian addresses have. Nothing is changed until you click the button.

Price table and fallback

Used for other countries, when live prices are not configured, or when GIG Logistics gives no price. Prices are in your shop default currency, tax excluded.

Country prices: a table with a base price per country. Click Add country to add a row and the trash icon to remove one. Choose * Any other country for all countries without their own row. The columns XS (up to 1 kg), S (up to 2 kg), M (up to 3 kg), L (up to 5 kg) and XL (above 5 kg) are optional weight tier prices: a tier price above 0 replaces the base price for carts in that tier. A price of 0 means free shipping. Empty price cells are saved as 0, so fill in the base price for every row you add. If a country appears twice, the later row is kept. Corrected values are listed in a warning after saving. Countries without a row (when there is no * row) get no table price.

Fallback cost: used when neither GIG Logistics nor the table gives a price. Empty means the carrier is hidden in that case.

Table / fallback price is: Per order charges the price once. Per item (multiplied by the number of items) multiplies it by the number of items in the cart. Live GIG prices are always for the whole order.

Conditions

Free shipping from: the cart subtotal (products that need shipping, after discounts, tax excluded) from which shipping is free. Empty means never free.

Minimum subtotal: show the carrier only when the cart subtotal reaches this amount. Empty means always.

Min weight (kg): the minimum cart weight in kg. Product weights are converted from your shop weight unit. 0 means no limit.

Max weight (kg): the maximum cart weight in kg. Default: 30. 0 means no limit.

Availability without shipping zones

Ignore shipping zones: offer the carrier for the countries below, even if its zones do not include them. When you turn it on, the carrier is linked to all active zones, and zones created later are linked too. When you turn it off, the carrier gets its previous zones back.

Countries: the destination countries for that mode. Empty means all countries you ship to. Used only with Ignore shipping zones.

Advanced

Debug log: writes price calculations to logs/vfd_gigl_debug.log.php in the module folder. The file cannot be opened from the web. API errors are always logged, even with the log off. No passwords, tokens or customer addresses are written.

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 module settings, the carrier, caches and logs. When off, everything is kept for a re-install. Orders are always kept.

How it works at checkout

At the shipping step PrestaShop asks the module for the GIG Logistics price. Only products that need shipping count: virtual products add no weight and are not included in the subtotal. The module first checks the conditions: the delivery country (with Ignore shipping zones), cart weight and minimum subtotal. If the subtotal reaches Free shipping from, the price is 0 and no request goes to GIG Logistics.

Then the price is taken from the first source that gives one. First, the live GIG Logistics price, if API credentials are entered, the address is in Nigeria, the address has a city or state, the pickup phone, city and state are set, and a conversion rate is set for shops whose default currency is not NGN. The module logs in to the GIG Logistics API and sends the pickup and delivery addresses and coordinates and the cart items with names, quantities, weights and values. Products without a weight are sent as 1 kg. The price is requested for bike delivery. Second, the Country prices table. Third, the Fallback cost. If none gives a price, the carrier is hidden for that cart. The price is calculated in your default currency and then shown in the customer's cart currency.

Each GIG answer is cached for 1 hour, so the same cart does not trigger a new request. A failed request or a failed login is cached for 10 minutes, so the checkout does not wait for GIG Logistics on every refresh. The login token is kept for 30 minutes and renewed automatically when GIG rejects it. The API timeout is 10 seconds, and the address lookup timeout is 5 seconds.

If GIG Logistics returns an error or a zero price, the customer sees no error. The table or fallback price is used, and the error 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 prices only. It does not create GIG Logistics shipments, waybills or labels, book pickups, track parcels or let customers choose a service centre. Orders are shipped through your GIG Logistics account as usual. Live prices are requested for Nigerian addresses only. For other countries, use the price table.

License key

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

GIG Logistics does not appear at checkout: check that the license is active and Enable/Disable 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 and check Countries. Check the weight limits and Minimum subtotal. Check that the table (the country or *) or Fallback cost gives a price for the country. Products can also be limited to certain carriers in the product page.

The price comes from the table, not from GIG Logistics: live prices need the API username and password, Sender phone, pickup city and state, a Nigerian delivery address with a city or state, and, for shops whose default currency is not NGN, the Currency conversion rate. Look at the warnings at the top of the Configure page. Turn on Debug log, reload the checkout and look at the Log field on the module page to see the reason. A failed request is retried after 10 minutes.

Login failed in the log: GIG Logistics rejected the API username or password. Check them, and check Test mode: test credentials work only with the test API. Save the settings to retry at once.

GIG Logistics does not return a price: GIG prices by distance. Keep Address lookup on, or enter Pickup latitude and Pickup longitude. Click Add Nigerian states so the delivery state is sent too. Confirm the prices with your GIG Logistics account before going live.

The pickup city and state warning stays: choose a state in State and fill in City / area. The shop address is used only when the shop country is Nigeria, and the shop state is known only after the Nigerian states have been added and chosen in Shop Parameters > Contact > Stores.

Tax is charged on top of the GIG price: set Tax to No tax if the GIG price already includes everything you want to charge.

Prices look outdated after a change: click Save on the module page. This clears the cached prices, tokens and coordinates.

The page says the GIG Logistics 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 GIG Logistics and choose Uninstall. The license key and the license status are always removed. The cached prices, tokens and address coordinates 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 gives the saved carrier its previous status back. Nigerian states added with Add Nigerian states stay in your shop in both cases.

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