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) (apikey=&username=&password=&url=&)


  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.



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.


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