Magento 2 Installation Guide
Install the Hello Retail Business Magento 2 Extension
In this guide, you can read and learn about how to install the extension for Magento 2.
Our Magento 2 extension is developed for Magento 2.2 and higher but should be compatible with 2.0 and 2.1 as long as PHP 7 is used in your environment.
Our category feed is dependent on API features released in Magento 2.2 which means it will not work in 2.0 or 2.1.
Steps - Magento Marketplace
Our Magento extension can easily be installed via the web setup wizard and Magento marketplace.
- Go to marketplace.magento.com and login to your Magento account.
- Locate the search bar at the top of the page and type in "addwish" in the search field. When prompted in the search results, then click on the one with M2.
- Click on the Add to Cart button and proceed to checkout - once the purchase is complete then you can leave this site.
- Next, go to your Magento 2 backend.
- On the dashboard view, navigate to the left-hand side menu. Navigate to System and then click on Web Setup Wizard.
- Enter the Extension Manager - Make sure that you are connected to the Magento Marketplace Account on which you have purchased the Addwish extension.
- Click on the Review and Install button under the heading called Extensions Ready to Install.
- If you are connected to a Magento Marketplace Account that has purchased the Addwish extension, you should be able to locate the Addwish extension from the list. When you have located it, then click on Install from under the Action column.
- We encourage that you check with your developer on whether or not to do a backup.
- Click on the Install button - As a default, your shop will go in maintenance mode while installing the extension. For this, we recommend that you do this when there is little traffic on your site.
- If everything went smoothly, you should get a success notification. If errors occur, please forward them to Support at support@helloretail.com and possibly also have your developer look at it.
-
The final step is to locate ADDWISH from the left-hand side menu. Click on Module Configuration and next on Module Configuration.
Input your addwish partner ID in the Addwish ID field. This is the same id also known as the partner ID. In order to connect the Magento extension with your Hello Retail account, you will need to find your Hello Retail partner ID.
If needed, you can read this guide about it here on how to locate your partner ID in your Hello Retail account.
Please enable all feed and tracking options, so Hello Retail has all the relevant data available.
-
When you've completed these steps then simply click on the Save Config button.
Installation via manual upload
If you are comfortable with FTP and have shell access then you can download and install our extension manually.
- Click here: to download version 1.1.30.
- Navigate to <magento_main_dir>/app/code/
If the code folder is not present then you can create it and name the folder Addwish.
- Inside the Addwish folder, you create another folder called Awext so you end up with a folder structure like this:
<magento_main_dir>/app/code/Addwish/Awext
- Unpack the zip file and copy all the files inside the folder (not the folder itself, just the files inside) to the location we just created: <magento_main_dir>/app/code/Addwish/Awext
- Run these commands in your shell:
php bin/magento module:enable Addwish_Awext php bin/magento setup:upgrade php bin/magento setup:di:compile
- Once the extension has been installed, locate ADDWISH from the left-hand side menu. Click on Module Configuration and next on Module Configuration.
Input your addwish partner ID in the Addwish ID field. This is the same id also known as the partner ID. In order to connect the Magento extension with your Hello Retail account, you will need to find your Hello Retail partner ID.
If needed, you can read this guide about it here on how to locate your partner ID in your Hello Retail account.
Installation via composer:
The addwish extension is in the Magento repository at marketplace.magento.com.
To access this, you need to make sure that this repository is in your Magento's composer.json file. It should be det as a default.
You may also want to add your Magento Marketplace private and public key to your magento's auth.json file.
Next, you need to follow steps 1-3 in the above guide "Installation via Magento Marketplace"
When this is done you should be able to install with the following commands:
composer require addwish/awext php bin/magento module:enable Addwish_Awext php bin/magento setup:upgrade php bin/magento setup:di:compile
Once the extension has been installed, navigate to addwish > Module Configuration.
Here you must insert your addwish partner ID (you find this in the setup flow or by logging in to your addwish business account and navigate to Settings > Tracking script).
On this page, you can also control the settings of the extension.
Updating Hello Retail extension - Magento 2
If you are using Hello Retail with your Magento 2 shop platform, chances are you have installed the Hello Retail Magento 2 extension that automates a lot of the setup and daily processes. As we encounter bugs or update the Hello Retail's services, the extension will also be updated, and here we will show you how to perform an update.
The process of updating the extension depends on how you installed it in the first place. There are three ways you can have installed the extension; via Composer, Package Manager, or via a manual upload.
Composer
If you originally installed the Hello Retail extension through Composer, this is also where you should update it. You complete the update through a short series of command lines. Run each line after the other:
composer update addwish/awext php bin/magento setup:upgrade php bin/magento setup:di:compile php bin/magento cache:clean
Extension Manager
Navigate to Extension Manager and locate addwish/awext in the list of extensions.
After pressing Update, a wizard will guide you through the updating process, and the extension will be updated when you finish it.
Manual upload
The process of updating the extension is the same as with the original installation, but instead, you overwrite the existing files with the updated versions. You can find an extensive guide on manual installation here.
If you have any questions about this guide, then please contact Support or your designated account manager about this.
