Disabling & Uninstalling the ShipperHQ Extension for Magento

Overview

Sometimes it is necessary to disable the ShipperHQ extension in Magento. If the extension is conflicting on the site you can disable its functionality until it is resolved. There may also be occasions (such as when upgrading) that you need to uninstall our extension completely. Below are steps for both.

If you are having difficulty with the configuration please contact us for assistance.
Caution! Some attributes used by ShipperHQ are also used by WebShopApps extensions. If you have WebShopApps extensions that are still required those attributes must not be deleted.

This article assumes that you have working knowledge of MySQL.

Magento 1

How to Disable the ShipperHQ Magento Extension

Follow these steps:

  1. Open the relevant extension file in app/etc/modules
  2. Set active to false
  3. Save file back to file system
  4. Refresh cache

If your backend is broken and you cannot refresh cache you can manually remove the contents of var/cache.

If you’re still having issues with the frontend of the site after disabling ShipperHQ then the problem may be caused by some external factor (E.g: Third-party extension).

Please be aware that you may have problems viewing/saving products/customers if you disable ShipperHQ. This is because the data entries are tied to files in ShipperHQ. The only way to resolve that is to remove the ShipperHQ attributes from the database.

Manually Uninstalling the ShipperHQ Extension

Follow these steps:
  1. Disable the cache (if enabled) and compiler (if enabled).
  2. Edit the eav_attribute table and change is_user_defined to 1 for all ShipperHQ attributes:
    • carrier_id
    • carrier_type
    • carriergroup
    • carriergroup_id
    • carriergroup_shipping
    • carriergroup_shipping_details
    • carriergroup_shipping_html
    • checkout_display_merged
    • destination_type
    • freight_class
    • is_checkout
    • must_ship_freight
    • ship_height
    • ship_length
    • ship_separately
    • ship_width
    • shipperhq_availability_date
    • shipperhq_declared_value
    • shipperhq_dim_group
    • shipperhq_handling_fee
    • shipperhq_hs_code
    • shipperhq_malleable_product
    • shipperhq_master_boxes
    • shipperhq_nmfc_class
    • shipperhq_nmfc_sub
    • shipperhq_poss_boxes
    • shipperhq_shipping_fee
    • shipperhq_shipping_group
    • shipperhq_volume_weight
    • shipperhq_warehouse
    • shq_delivery_date
    • shq_dispatch_date
    • split_rates
    • validation_status
  3. Remove all ShipperHQ attributes from all of the attribute sets.
  4. Disable the extension’s files. This will be any XML files prefixed by “shipperhq_”, “Hackathon_GridControl.xml” (not present in modern versions) and “Webshopapps_Wsalogger.xml”.
    NB: If you have any WebShopApps extensions installed the Logger extension is required and should not be removed.
  5. Remove files from app/code/community/Webshopapps (unless you are using WebShopApps extensions), app/code/community/hackathon and app/code/community/shipperhq  relating to the extension.
  6. Remove the XML files from step 2 from app/etc/modules
  7. Remove files from app/design, app/locale, js,  lib and skin directories that have “shipperhq” in the name of the directory or “shipperhq_” as the file prefix.
  8. Remove any references to shipperhq from the core_config_data MySQL database table.
  9. Verify removal on admin/frontend
  10. All of the attributes from step 2 can be removed if they are no longer required.
  11. Enable cache and compiler (if previously enabled).
All of our extensions sit in the app/code/community areas, so there is no impact on core code.

Magento 2

How to Disable ShipperHQ Modules

From the command line disable the modules via:

php bin/magento module:disable --clear-static-content ShipperHQ_Common ShipperHQ_Logger ShipperHQ_Shipper

If you have any of the optional modules enabled these will can be disabled similarly to the above command:

php bin/magento module:disable --clear-static-content ShipperHQ_Pickup ShipperHQ_Option ShipperHQ_Calendar

Lastly, run the standard cleanup commands:

php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento indexer:reindex
php bin/magento cache:clean

Composer Uninstaller

As of version 20.35.0 the modules can be uninstalled using Composer:

php bin/magento module:uninstall -r ShipperHQ_Shipper

This WILL remove your ShipperHQ attributes and data from your database. Omit the “-r” parameter if you’d like to retain your data

If you see an error like this:

Class "ShipperHQ\Shipper\Model\Carrier\Shipper" does not exist

you may need to run this SQL manually due to a Magento issue preventing all ShipperHQ data being removed during uninstall:

DELETE FROM `core_config_data` WHERE `value` LIKE 'ShipperHQ\\\\Shipper\\\\Model\\\\Carrier\\\\Shipper'

You will need to refresh cache after running this SQL

You can find the details to update to 20.35.0 or newer on our Installation Article

How to Manually Uninstall the ShipperHQ Modules

Follow these steps:

  1. Disable the cache (if enabled) and compiler (if enabled)
  2. Edit the eav_attribute table and change is_user_defined to 1 for all ShipperHQ attributes.
  3. Remove all ShipperHQ attributes from all of the attribute sets. The attributes to remove include: List of ShipperHQ Attributes to remove
  4. Run: composer remove shipperhq/module-logger
  5. Run: composer remove shipperhq/module-shipper
  6. Run: php bin/magento setup:upgrade
  7. Run: php bin/magento setup:di:compile (if the compiler is enabled).
  8. Remove any references to shipperhq from the core_config_data MySQL database table.
  9. Verify removal on admin/frontend
  10. All of the attributes from step 2 can be removed if they are no longer required.
  11. Enable cache (if previously enabled).
  12. If you have Redis installed you might also need to flush its caches: redis-cli FLUSHALL
  13. Re-test in Private Browsing/Incognito Mode to ensure that your browser is not caching the checkout

Was this doc helpful?