VibeFox Delhivery 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 and JSON extensions.
Delhivery API token (for live rates only): log in to Delhivery One and open Settings > API setup. The Delhivery help article "API token generation" explains the steps. Test tokens work with the staging environment. You also need the 6-digit pincode of your pickup location. If you only use fixed prices, you do not need a token.
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-delhivery-shipping. Without Composer: unpack the ZIP file into app/code/Vibefox/DelhiveryShipping/, so that registration.php is directly in that folder.
2. Run bin/magento module:enable Vibefox_DelhiveryShipping 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 Delhivery. 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. Enter the API token and your origin pincode, choose Express or Surface and Pre-paid or COD. If the base currency of your store is not INR, enter the conversion rate. Optionally enter fixed prices (see Configuration). Set Enable Delhivery to Yes and click Save Config.
The module adds the Delhivery shipping method to Magento. Customers see it as Delhivery - Courier delivery (method title and method name). It is off after installation (Enable Delhivery = No).
Configuration
All settings are in Stores > Configuration > Sales > Delivery Methods > VibeFox Delhivery, in the standard Magento configuration form. Like other Magento settings, most of them can be changed for a website with the Scope switcher at the top of the page; Method title and Method name also for a store view. Debug log and Remove data on uninstall are set for the whole installation (Default Config). Save Config saves the whole page and clears the cached Delhivery rates. Amounts accept "9.99" and "9,99".
If a value is wrong, Magento shows an error and nothing on the page is saved: an empty Method title or Method name, longer than 64 characters or with one of the characters < > ; = # { }; a Sort order that is not a whole number; a number field that does not contain a non-negative number; a conversion rate of 0; a Min weight greater than the Max weight.
While Enable Delhivery is Yes, warnings after saving remind you of settings that stop live rates: an origin pincode that does not have 6 digits, and a saved API token without a conversion rate when the base currency of your store is not INR. The warnings are shown only while the method is enabled, because the Delivery Methods page is shared by all shipping methods.
General
Enable Delhivery: shows or hides Delhivery at checkout. Default: No.
Method title: the carrier name shown in the cart and at checkout. Default: Delhivery. Required, at most 64 characters.
Method name: shown after the method title, as "Method title - Method name". Default: Courier delivery. Required, at most 64 characters.
Sort order: the position among the shipping methods at checkout. A whole number, negative numbers are allowed.
Delhivery API account (needed for live rates only)
Environment: Production (track.delhivery.com) (default) or Staging / test account (staging-express.delhivery.com). Use Staging only with a Delhivery test token.
API token: your Delhivery API token. It is sent only in the authorization header and never written to logs. Magento stores it encrypted and shows only a mask after saving. Leave the mask as it is to keep the saved token, type a new value to change it. To delete the saved token, clear the field and click Save Config. Only the fixed prices are used then.
Origin pincode: the 6-digit pincode of your pickup location or warehouse, for example 110001. Spaces are removed. If it does not have 6 digits, live rates are not requested until it is fixed.
Live rates
A live rate is requested for Indian destinations with a valid 6-digit pincode, for a forward (delivered) shipment.
Shipping mode: the Delhivery billing mode used for the rate: Express (default) or Surface.
Payment type: the payment type sent to Delhivery: Pre-paid (default) or COD (cash on delivery — Delhivery adds its COD charge). The module does not switch it by the payment method the customer chooses.
Rate amount: Delhivery returns the charge with and without GST.
INR to base currency conversion rate: Delhivery rates are in Indian rupees. If the base currency of your store is not INR, enter how many units of the base currency one rupee is worth, for example 0.011. The rate must be greater than 0. Leave it empty and live rates are not used, the fixed prices apply. Not needed when your base currency is INR.
Fixed prices (used when no live rate is available)
Fixed prices are used when there is no token or pincode yet, the destination is outside India, the pincode is not serviceable or the API returns an error. They are in the base currency of your store, tax excluded.
Prices per country: one per line in the format COUNTRY_CODE:price, for example IN:120. Checked before the fallback price. Lines in another format are dropped on save, and a warning lists them.
Fallback price: used when neither a live rate nor a country price applies. Leave it empty to hide the method. 0 means free.
Fixed price is charged: Per order charges the price once. Per item (price × quantity) multiplies it by the number of items in the cart. A live Delhivery rate is always for the whole parcel weight.
Conditions
Free shipping from: delivery is free if the cart subtotal (products that need shipping, after discounts, before tax, in the base currency) is at least this amount. No request goes to Delhivery. Leave empty to turn it off.
Show from subtotal: show the method only if the cart subtotal is at least this amount. Leave empty to always show it.
Min weight (kg): the minimum cart weight to show the method. 0 means no limit.
Max weight (kg): hide the method if the cart is heavier. Default: 30. 0 means no limit, an empty field means 30 kg.
Product weights are converted to kg from the weight unit of your store (Stores > Configuration > General > General > Locale Options > Weight Unit, lbs or kgs). The rate uses the actual cart weight (the sum of product weights). Magento products have no standard dimensions, so volumetric weight is not calculated.
Availability
Ship to Applicable Countries: All Allowed Countries offers Delhivery for every country your store allows, Specific Countries only for the countries below.
Ship to Specific Countries: the destination countries for Specific Countries. Live rates are requested for India only; other countries use the fixed prices.
Advanced
Debug log: writes rate calculations to var/log/vfd_dlv_debug.log.php in the Magento folder. The file cannot be opened from the web. API errors are always logged, even when this is off. Tokens and full customer pincodes 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 Yes, uninstalling the module with its data deletes the Delhivery settings and the log (see Uninstall). The license key and the cached rates are always removed. The Delhivery data of orders and the tracking numbers of shipments are never deleted.
How it works at checkout
At the shipping step Magento asks the module for the Delhivery price. Only products that need shipping count: virtual and downloadable products add no weight and are not included in the subtotal. The module first checks the countries, the cart weight and Show from subtotal. If free shipping applies, the price is 0 and no request goes to Delhivery. A Magento cart price rule with free shipping also makes the price 0.
For an Indian address with a valid 6-digit pincode, the module sends Delhivery the origin and destination pincodes, the cart weight in grams, the shipping mode and the payment type. The returned amount is converted from INR to your base currency; Magento then shows it in the customer's currency and adds tax on shipping if your store charges it. Each answer is cached for 1 hour. A failed request is cached for 10 minutes, so the checkout does not wait for Delhivery on every refresh. The API timeout is 10 seconds.
If there is no live rate, the price for the country or the fallback price is used. If neither is set, the method is hidden. The customer never sees an API error. The reason is written to the log.
The module calculates rates and gives customers a tracking link. It does not create shipments or waybills, print labels, request pickups or manifests, check pincode serviceability, estimate delivery dates, sync tracking statuses or quote international Delhivery rates. Outside India only the fixed prices are used.
Orders and tracking
When an order is placed with Delhivery, the module stores the shipping mode and the price source with the order. On the admin order page (Sales > Orders > View, Information tab) the Delhivery block shows Mode: (Express or Surface), Price: (live Delhivery rate, fixed price or free shipping) and the Delhivery AWB / tracking number, or Not entered yet.
Create the shipment in Delhivery One, then enter its AWB in Magento as the tracking number of the shipment: click Ship on the order page, under Tracking Information click Add Tracking Number, choose the carrier Delhivery and enter the AWB as the Number. For an existing shipment use Add Tracking Number on the shipment page. The Delhivery block then shows the AWB with a Track on delhivery.com link.
The customer sees the tracking number in the order in their account (or on the Orders and Returns page for guests). The tracking window links to the Delhivery tracking page. The shipment e-mail, if you send it, has the same tracking link. The block and the tracking link also work for older orders and when the module is switched off.
License key
The module works with a VibeFox license key from vibefox.net. The license block License — VibeFox Delhivery is the first row of the VibeFox Delhivery 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-delhivery 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 Delhivery 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
Delhivery does not appear at checkout: check that the license is active and Enable Delhivery is Yes for the website of the store. Check Ship to Applicable Countries and Ship to Specific Countries, the weight limits and Show from subtotal. Without a live rate, a country price or a Fallback price is needed.
Live rates do not appear: check the API token, a valid Origin pincode and, if your base currency is not INR, the conversion rate. The customer must enter a valid 6-digit Indian pincode. Turn on Debug log, reload the checkout and look at the Log field in the Advanced section. It shows the reason, for example a pincode that is not serviceable or an HTTP error from Delhivery.
GST is charged twice: Delhivery's total amount already includes GST. Set Rate amount to Gross amount (excluding GST), or do not tax shipping in Tax Class for Shipping.
Testing: set Environment to Staging and use a Delhivery test token.
Rates look outdated after a change: click Save Config on the Delivery Methods page. This clears the cached Delhivery rates.
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_DelhiveryShipping. It removes the data and the code.
Installed in app/code: run bin/magento module:uninstall --non-composer Vibefox_DelhiveryShipping to remove the data, then bin/magento module:disable Vibefox_DelhiveryShipping, delete the folder app/code/Vibefox/DelhiveryShipping 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 Delhivery settings and the log are removed too. If it is No, the settings are kept for a re-install. The Delhivery data of orders (mode and price source) and the tracking numbers of shipments stay with the orders.
Delhivery is a trademark of its respective owner. This module is not affiliated with or endorsed by Delhivery.