Magento 2 Install Instructions


To connect your Magento 2 store to Shiptheory, you need to install the the Shiptheory Magento extension on your store. To do so, please provide your Magento developer with the below installation instructions.


  1. Backup your Magento store files and database.
  2. Download the Shiptheory Magento 2 extension installation package.
  3. Upload the contents of the Shiptheory Magento 2 extension installation package to your store root directory.

  4. In the SSH console of your server, from your store rootdirectory, run the following commands:
    php bin/magento setup:upgrade
    php bin/magento setup:di:compile

  5. Logout and back into your Magento 2 admin panel and browse on the main menu to Sales -> Shiptheory > Configuration and copy and paste your API Key (available from your Shiptheory account) into the Api Key field and click the orange  Save Config  button. Following this, Enable Webhooks and click the  Save Config  button again.

    5a. If you Enable Webhooks the first time you click   Save Config  then you'll receive the following error;  
    Something went wrong while saving this configuration: Shiptheory setup API returned an incorrect http code (404) 

  6. The extension is installed. Return to your Shiptheory account and follow the tweak your preferences to match your requirement from the Magento 2 setup page.



Resaving or Resetting Your Magento 2.4 (and above) Connection 

This section s only applies to Magento 2.4 and newer versions of Magento.


If you try to save the extension configuration within Magento 2.4 + more than once without changing the Enable Webhooks option, you will see the error message "The integration with name "shiptheory" exists.". Do not worry, this message just means the extension is already saved and while this seems like an error, it is not.



If you are troubleshooting connection or permissions issues, you can reset your connection by browsing to System -> Integrations on your Mageno admin panel, finding the shiptheory user and clicking delete. Once deleted,, return to Sales -> Shiptheory > Configuration and resave the settings, you should then see a success message:




Magento 2 Uninstall Instructions


You can uninstall the extension by running the following commands, from the SSH console of your server, in your root store directory.


For extension version 1.0.7 and up:

php bin /magento module:disable Shiptheory_Shippingx
php bin/magento cache:clean


For extension version 1.0.6 or lower:

php bin /magento module:disable Shippingx_Shiptheory
php bin/magento cache:clean