Installing the ShipperHQ Magento 1 Extension

Overview

Please follow these steps to install your extension. These installation instructions have been refined over the past 2 years and provide comprehensive installation guidance. If you do not follow these steps as indicated you may well see issues with your install, which may take some time to resolve. So please follow each step carefully and if the install fails re-check the steps.

Video Walkthrough

Note If you’re running a version of Magento other than the current most recent version, check our Magento Version Compatibility chart before installing to ensure that your version is compatible with the ShipperHQ extension.
Warning Since ShipperHQ replaced Magento’s shipping functionality, it’s advisable to uninstall any shipping extensions you may have installed on your Magento site prior to enabling ShipperHQ. Not doing so may cause conflicts.

Installation Process

Warning It is highly recommended to backup your server files and database before installing this module. No responsibility can be taken for any adverse effects it may cause. It is also recommended you install on a test server initially to carry out your own testing.
  1. Switch off the Magento Compiler if enabled under System->Tools->Compilation
  2. Ensure Cache is enabled in Admin under System -> Cache Management
  3. Extract all the Zip archive(s).
  4. Copy the contents of the app directory from the extracted Zip into your Magento base directory overwriting any files, except for the “etc” directory (which will be copied last). * Note: This does not overwrite any core files
    ShipperHQ_Installation_app
  5. Copy the contents of the other directories present in the extracted Zip (for example, “lib” and “skin”), except for the “docs” directory (which is documentation only).
    ShipperHQ_Installation_libskin
  6. Copy over the app/etc directory that was omitted in step #4. This greatly reduces the chance of the SQL not running correctly.
  7. Log out of admin and back in. If you do not do this you will get 404 Access Denied errors
  8. Disable cache in admin
    Disable cache
  9. Flush the magento cache storage in cache management by clicking the ‘Flush Magento Cache’ Button. (Or you can manually remove /var/cache and var/session contents)
  10. Open frontend of website to force extension to load (this will ensure that the SQL updates within extension are performed).
  11. If you’re using the compiler you need to recompile via System->Tools->Compilation. If you do not you will see an error similar to ‘Call to a member function toOptionArray() on a non-object…’ when accessing shipping methods. You may also see Fatal Errors for missing files
  12. You have now installed your extension and should see it present in relevant area of backend
  13. Re-enable cache in admin.

Post-Installation Steps

In order to successfully connect your Magento eCommerce site to ShipperHQ you’ll need to configure your website in ShipperHQ. The final step is to configure the ShipperHQ Magento extension.