VibeFox GIG Logistics for WooCommerce — Help

Requirements

WordPress: 5.8 or later.

WooCommerce: 5.0 or later, installed and active. The plugin refuses to activate without it.

PHP: 8.0 or later.

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.

VibeFox license key: bought on vibefox.net. One key works on one domain.

Installation

1. In WordPress go to Plugins > Add New > Upload Plugin, choose the plugin ZIP file and click Install Now. You can also upload the vfd_gig_logistics folder to /wp-content/plugins/ by FTP.

2. Click Activate.

3. Open the settings: WooCommerce > Settings > Shipping > VibeFox GIG Logistics, or click Settings under the plugin name on the Plugins page.

4. Enter your VibeFox license key in the license block at the top of the page and click Activate.

5. 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 store currency is not NGN (see Configuration).

6. Add VibeFox GIG Logistics to a shipping zone for Nigeria in WooCommerce > Settings > Shipping > Shipping zones, or turn on Ignore shipping zones and choose countries.

Configuration

All settings are on one page: WooCommerce > Settings > Shipping > VibeFox GIG Logistics. They apply to every shipping zone. When you add the method to a zone, the zone window has only one field:

Title (zone): the name customers see for this zone. Leave it empty to use the global Method title.

Above the fields, 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 the store currency is not NGN and no Currency conversion rate is set. Every time you save the settings, the cached prices and API tokens are cleared.

General

Enable/Disable: turns the method on or off in all zones at once. Default: on.

Method title: the shipping method name shown in the cart and at checkout. Default: GIG Logistics. A zone title overrides it.

Tax status: Taxable adds your store shipping tax on top of the cost, None does not. Choose None 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.

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 store currency is not NGN, enter how much one NGN is worth in your store currency (1 NGN = ? of your currency, for example 0.0006). Without it, live GIG prices are not used. If your store currency is NGN, this field 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 store is in Nigeria, empty street, city and state fields use the store address from WooCommerce > Settings > General.

Sender name: the sender name sent to GIG Logistics. Empty means the site 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. By default the store state is used. 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.

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 store currency.

Country prices: a table with a base price per country. Click Add country to add a row and the cross 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. 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 method 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 from which shipping is free. Empty means never free.

Minimum subtotal: show the method 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 store weight unit. 0 means no limit.

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

Excluded shipping classes: hide the method if the cart contains products of these WooCommerce shipping classes.

Availability without shipping zones

Ignore shipping zones: offer the method for the countries below, even if it is not added to a zone. When off, the method appears only in the shipping zones it is added to.

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

Advanced

Debug log: log price calculations to WooCommerce > Status > Logs, source vfd-gig-logistics. API errors are always logged, even with the log off. No passwords, tokens or customer addresses are written.

Remove data on uninstall: when on, deleting the plugin removes its settings, zone methods and caches. Deactivating the plugin never deletes anything.

How it works at checkout

When the customer enters a delivery address, WooCommerce asks the plugin for a price. The plugin first checks the conditions: delivery country, cart weight, minimum subtotal and excluded shipping classes. If the subtotal reaches Free shipping from, the method is shown with a price of 0, but only when the country has a price: a row in Country prices, a Fallback cost or a live GIG Logistics price. GIG Logistics is asked only when the table and the fallback cost give no price.

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 customer has entered a city or state, the pickup phone, city and state are set, and a conversion rate is set for non-NGN stores. The plugin 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 method is hidden for that cart.

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 log.

The method works on the classic checkout and on the Cart and Checkout blocks. It is compatible with WooCommerce High-Performance Order Storage (HPOS).

The plugin 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 plugin works with a VibeFox license key from vibefox.net. The license block is at the top of WooCommerce > Settings > Shipping > VibeFox GIG Logistics. Paste the key into License key and click Activate. The block shows the status, for example the date the license is active until and your domain. Use Check now to check the status again, Change key to enter another key and Remove key to remove it from this site. The link Manage licenses and domains in your account opens your vibefox.net account.

One key works on one domain. Removing the key from a site does not free its domain slot. Free the slot in your vibefox.net account.

Without an active key, GIG Logistics is not shown to customers at checkout. Logged-in store managers still see it, marked (unlicensed — visible to admins only), so you can set up and test the plugin before you buy a key. A reminder appears on the Plugins page and on WooCommerce pages. Existing orders are not affected.

When a license expires, the plugin keeps working, but updates and support need a renewal. The status is checked again automatically in the background.

Troubleshooting

GIG Logistics does not appear at checkout: check that the license is active, Enable/Disable is on, and the method is added to the zone of the customer's country (or Ignore shipping zones is on and the country is allowed). Check the weight limits, Minimum subtotal and Excluded shipping classes. Check that the table (the country or *) or Fallback cost gives a price for the country.

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 non-NGN stores, the Currency conversion rate. Look at the warnings at the top of the settings page. Turn on Debug log, reload the checkout and open WooCommerce > Status > Logs, source vfd-gig-logistics, 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. Confirm the prices with your GIG Logistics account before going live.

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

Prices look outdated after a change: save the settings page. This clears the cached prices and tokens.

Own geocoder: developers can supply their own address lookup with the vfd_gigl_pre_geocode filter.

The license block shows an error: follow the message in the block. For example, if the key is already used on another domain, free a slot in your vibefox.net account and click Check now. If the site address changed, click Check now to activate the key for the new domain. If the license server cannot be reached, the plugin keeps working on the last known status.

Uninstall

Deactivating the plugin keeps all data. To remove it, deactivate and delete it on the Plugins page. The license key and license status of this plugin are always removed. Settings, zone methods, cached prices, tokens and address lookups are removed only if Remove data on uninstall was on. Otherwise they stay for a later re-install. Existing orders keep their shipping lines.

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