VibeFox Bob Go for Adobe Commerce — सहायता
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, JSON and Intl extensions.
Bob Go account (for live rates only): Bob Go has no API keys. You need a Bob Go account (bobgo.co.za), your store installed as a WooCommerce sales channel in your Bob Go account (Sales channels) and "Rates at checkout" enabled for that channel. Services, prices and rules are configured on Bob Go. If you only use fixed prices, you do not need a Bob Go account.
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-bob-go-shipping. Without Composer: unpack the ZIP file into app/code/Vibefox/BobGoShipping/, so that registration.php is directly in that folder.
2. Run bin/magento module:enable Vibefox_BobGoShipping 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 Bob Go. 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. In your Bob Go account, install your store as a sales channel. Enable "Rates at checkout" for that channel and set up your services and prices. Then check the store domain, the origin (ship from) address and, if the base currency of your store is not ZAR, the ZAR conversion rate (see Configuration). Set Enable Bob Go to Yes and click Save Config.
The module adds the Bob Go shipping method to Magento. Customers see each live Bob Go service as its own option, for example Bob Go - The Courier Guy - Economy (method title and service name), and a fixed price as Bob Go - Courier delivery (method title and method name). It is off after installation (Enable Bob Go = No) and uses live Bob Go rates by default.
Configuration
All settings are in Stores > Configuration > Sales > Delivery Methods > VibeFox Bob Go, in the standard Magento configuration form. Like other Magento settings, they can be changed for a website with the Scope switcher at the top of the page; Method title and Method name (fixed price) also for a store view. Remove data on uninstall is read from the Default Config only. Save Config saves the whole page and clears the cached Bob Go rates. Numbers accept a point or a comma as the decimal separator.
If a value is wrong, Magento shows an error and nothing on the page is saved: an empty Method title or Method name (fixed price), longer than 64 characters or with one of the characters < > ; = # { }; a Sort order that is not a whole number; a value that is not a number ("…" must be a number.); a negative amount or weight ("…" must be a number of 0 or more.); a ZAR conversion rate of 0 or less; a Minimum weight above the Maximum weight.
General
Enable Bob Go: shows or hides Bob Go at checkout. Default: No.
Method title: the carrier name shown to the customer before the Bob Go services, as "Method title - The Courier Guy - Economy". Default: Bob Go. Required, at most 64 characters.
Method name (fixed price): shown after the method title when a fixed price is used, as "Method title - Method name". The live Bob Go services keep the names from Bob Go. Default: Courier delivery. Required, at most 64 characters.
Shipping cost: how the price is calculated.
The reason for missing live rates is written to the log. It is never shown to the customer.
Sort order: the position among the shipping methods at checkout. A whole number, negative numbers are allowed.
Bob Go account
This section explains what you need on Bob Go, with links to your Bob Go account, Sales channels and Rates at checkout, and shows the last response from Bob Go for your store domain: connected, the WooCommerce channel is not installed on Bob Go (HTTP 404), "Rates at checkout" is not enabled for this channel (HTTP 401 or 403), or request failed with the error code or no connection.
When live rates are used, the section also warns about settings that stop them: Live rates are not requested: your store currency is … — set the "ZAR conversion rate"., and that South Africa has no region list in your store. Magento has no provinces for South Africa, so the customer types the province in the State/Province field. The module recognises it by its name (for example Gauteng is sent as GP); if it cannot, Bob Go gets no province.
Store domain: Bob Go identifies your store by its domain. Leave it empty to use the domain of the store base URL. Enter another domain only if your channel on Bob Go is installed under a different address, for example example.co.za/shop for a store in a subfolder. The scheme and a trailing slash are removed.
ZAR conversion rate: Bob Go quotes in South African rand (ZAR). If the base currency of your store is not ZAR, enter how much 1 ZAR is in the base currency, for example 0.05. Rates are converted with it and product prices are sent to Bob Go in ZAR. Leave it empty to not use live Bob Go rates in another currency (fixed prices still work). The rate must be greater than 0. If your base currency is ZAR, leave it empty.
Delivery dates: shows the estimated delivery date range from Bob Go next to each service at checkout. The estimate is always saved with the order and visible on the order page. Default: No.
Ship from (origin address)
The origin address is sent to Bob Go with every rate request. If the shipping origin of your store (Stores > Configuration > Sales > Shipping Settings > Origin) is in the same country, empty fields are taken from it.
Origin country: the country you ship from. Default: South Africa. Bob Go ships within South Africa.
Origin province: a South African province, or Store province (if in South Africa) (default).
Origin city / suburb: the city or suburb you ship from, for example Johannesburg.
Origin postal code: the postal code you ship from, for example 2001.
Origin street address: the street address you ship from, for example 123 Main Street.
Fixed prices (used when Shipping cost is Fixed prices (below), and as the fallback when Bob Go returns no rates)
Fixed prices are in the base currency of your store, tax excluded. Magento has no tax field per shipping method: tax on shipping comes from Stores > Configuration > Sales > Tax > Tax Classes > Tax Class for Shipping.
Price per country: one line per country: a 2-letter country code, an equals sign and the price, for example ZA=99.99. Use * for all other countries, for example *=199.99 on the next line. Lines in another format are removed when you save, and a warning lists them; the rest of the page is saved.
Flat price: the price for countries without a line above. Leave it empty to hide the method for them.
Fixed price applies: Per order (default) charges the price once. Per item (price × quantity) multiplies it by the number of items in the cart. Live Bob Go rates are always for the whole shipment.
Conditions
Minimum weight (kg): hide the method below this cart weight. 0 means no limit (default).
Maximum weight (kg): hide the method above this cart weight. 0 means no limit (default). When both limits are set, the minimum cannot be above the maximum.
Product weights are converted to kg from the weight unit of your store (Stores > Configuration > General > General > Locale Options > Weight Unit, lbs or kgs). Magento products have no standard dimensions, so no dimensions are sent to Bob Go.
Minimum order amount: show the method only when the subtotal of the products that need shipping (after discounts, tax excluded, in the base currency) is at least this amount. Leave empty to always show it.
Free shipping: free shipping when the order amount below is reached. Default: No.
Free shipping from: the cart subtotal (products that need shipping, after discounts, tax excluded, in the base currency) for free shipping. Used only when Free shipping is Yes. Bob Go is not asked for rates then.
Ship to Applicable Countries: All Allowed Countries (default) offers Bob Go for every country your store allows, Specific Countries only for the countries below.
Ship to Specific Countries: the destination countries for Specific Countries.
Advanced
Debug log: logs rate calculations and Bob Go requests to var/log/vfd_bobg_debug.log.php in the Magento folder. The file cannot be opened from the web. Customer addresses are not logged. Bob Go errors are logged even when this is off. Turn the log off when you are done.
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 Bob Go settings and the log (see Uninstall). The license key and the cached rates are always removed. The Bob Go service saved with orders is kept. When No, the settings are kept for a re-install.
How it works at checkout
At the shipping step Magento asks the module for the Bob Go price. Only products that need shipping count: virtual and downloadable products add no weight and are not included in the order amount. The module first checks the destination country, the cart weight and Minimum order amount. If free shipping by order amount applies, the customer sees Bob Go - Courier delivery (free) at 0 and no request goes to Bob Go. A Magento cart price rule with free shipping makes every Bob Go option 0.
In the live modes the module sends Bob Go your store domain, the origin and delivery addresses (with the province and the street) and the cart items with their weight, with product prices in ZAR. Live rates are requested only after the customer has entered a city or postal code. Rates in ZAR are converted with ZAR conversion rate when the base currency of your store is not ZAR. The price is calculated in the base currency, tax excluded; Magento shows it in the customer's currency and adds tax on shipping if your store charges it.
Every Bob Go service is shown as its own shipping option, with the method title, the service name and the price, for example Bob Go - SkyNet - Overnight. If Delivery dates is Yes, the estimated delivery dates follow the name in brackets. The customer chooses a service like any other Magento shipping method.
Rates are cached for 1 hour per full request, so the same cart does not trigger a new request. A failed request is cached for 5 minutes, and the timeout is 12 seconds, so a Bob Go outage does not slow down every checkout update. A failed request never breaks the checkout: the method is hidden, or the fixed price is used in the fallback mode. The reason goes to the log.
The module shows rates only. It does not create shipments, waybills or labels, track parcels, sync orders to Bob Go or send notifications. Use the Bob Go dashboard for fulfilment. It has no pickup point or locker selection. Bob Go ships within South Africa only.
Orders
The name of the chosen Bob Go service is the shipping description of the order, for example Bob Go - SkyNet - Overnight, in the Admin, in e-mails and for the customer. When the order is placed, the module also saves the service, its code and the delivery estimate with the order. Later changes to the cart or to Bob Go prices do not change them.
On the admin order page (Sales > Orders > View, Information tab) the Bob Go block shows Bob Go service (name and code) and Estimated delivery. The customer sees Bob Go service and Estimated delivery on the order page in their account (or on the Orders and Returns page for guests). The blocks also work for older orders and when the module is switched off. Orders with a fixed price or free shipping have no Bob Go service.
License key
The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox Bob Go is the first row of the VibeFox Bob Go 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-bob-go 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 Bob Go 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
Bob Go does not appear at checkout: check that the license is active and Enable Bob Go 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. In the fixed mode, check that the country, * or Flat price has a price.
No Bob Go rates are shown: open the Bob Go account section. It shows the last response from Bob Go. "The WooCommerce channel is not installed on Bob Go" (HTTP 404) means the store domain is not a sales channel on Bob Go: check Store domain. "Rates at checkout is not enabled" (HTTP 401 or 403) means the feature is off for the channel. Also make sure the customer has entered a city or postal code and, if your base currency is not ZAR, that ZAR conversion rate is set. Turn on Debug log, reload the checkout and look at the Log field in the Advanced section. With Bob Go live rates, fixed prices if Bob Go returns no rates customers still get the fixed price while you fix the problem.
My store is not in rand: Bob Go quotes in ZAR. Enter how much 1 ZAR is in the base currency of your store. Without it the module does not ask Bob Go for rates. Fixed prices still work.
Bob Go gets no province: South Africa has no region list in Magento, so customers type the province in State/Province. Ask them to enter the full province name, for example Gauteng or KwaZulu-Natal.
Tax is charged twice on shipping: Bob Go rates normally include VAT. Do not tax shipping in Tax Class for Shipping.
Rates look outdated after a change: click Save Config on the Delivery Methods page. This clears the cached Bob Go rates. Changes in your Bob Go account are picked up after the 1-hour cache or when you save the settings.
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_BobGoShipping. It removes the data and the code.
Installed in app/code: run bin/magento module:uninstall --non-composer Vibefox_BobGoShipping to remove the data, then bin/magento module:disable Vibefox_BobGoShipping, delete the folder app/code/Vibefox/BobGoShipping and run bin/magento setup:upgrade.
The license key, the license status and the cached rates are always removed. If Remove data on uninstall is Yes, the Bob Go settings (with the last Bob Go response) and the log are removed too. If it is No, the settings are kept for a re-install. The Bob Go service saved with orders is always kept.
Bob Go is a trademark of its respective owner. This module is not affiliated with or endorsed by Bob Go.