See how to set up your order channel in Webshipper, create your API credentials, and install the Webshipper module.
So you wish to get started with Magento? Great!
Before you begin with our guide, you should be aware that local FTP access is required in order to complete the integration.
1. Create API Credentials in Magento
The first step in integrating Webshipper with Magento is to create API credentials in your Magento setup, which will allow Webshipper to interact with Magento.
Start by logging into your Magento administration panel.
You will need to create a Web Service Role and a Web Service User.
Navigate to System > Web Services > SOAP/XML RPC – Roles
Click on Add New Role. Give the new role a name, e.g., webshipper, and input your administrator password.
Now select the tab Role Resources on the left, and choose the roles Catalog and Sales, and click on Save Role on the right side of the screen.
Navigate to System > Web Services > SOAP/XML RPC – Users, and click on Add New User. You may fill in the name-related fields to your liking. However, we would suggest using Webshipper for the username, and also to use your actual e-mail address. You will also need to input your administrator password.
The next step is entering an API key. Simply put a long password (preferably 10+ characters), that Webshipper will be able to use to authenticate with Magento.
Next, select the tab User Role on the left, and choose the role for Webshipper that you created just before. Finally, click on Save User to the right.
2. Creating a Magento order channel
Now log into Webshipper, and navigate to Connect > Order channels and click on New order channel.
Find Magento on the list of available order channel types and click on Connect.
- Input a store URL
- Input a store ID
- Input API username
- Input API Key created in the previous step
- Select a transfer status for orders. If you wish to use your own statuses, please enter these directly into the Magento plugin inside your store backend. This will not make your status visible in Webshipper but you should then set the synchronizing state to "Paused" to avoid double shipments. Select any transfer status in this case.
Please note that a transfer status has to be selected/defined and set to the same/identical transfer status in Webshipper in order for the two systems to communicate correctly.
- Select weight unit
- Select close order status. If you are using your own statuses to close orders, it is necessary to mark the option "create invoice in Magento" in order for the status to change in your store backend.
- Specify if Magento should create shipments
- Specify if Magento should create invoices (connected to "Close order status")
- Specify if you wish to ignore virtual orders
- Specify if you wish to ignore virtual products
- Add any additional order attributes you wish to import to Webshipper
- Specify if Magento should send invoices
- Add any additional item attributes you wish to import to Webshipper
- Specify if you wish to save product options as additional item attributes
- Select in the dropdown menu what to do with bundled products.
- Specify your locations
- Specify if orders should be fulfilled automatically
- Specify details regarding your parcel slip
- Set up your print settings as desired
Finally, click on Create order channel and your order channel has successfully been created in Webshipper.
Note: Webshipper will not begin to synchronize orders with Magento
3. Installing the Webshipper add-on module for Magento
To provide shipping rates and drop points during checkout, you will need to install the Webshipper add-on module for Magento.
To get started, log into Webshipper and navigate to Settings > Order channels and select your Magento v1 order channel. Under "Module configuration" on the right, click on "Download module", you will then be provided with a ZIP file containing the module which you need to save on your computer. Before moving on, you need to copy the configuration token (the text string contained in the blue field) which you will need later.
Open the folder to which you saved the ZIP file, right-click on the ZIP file and extract it. You should now have a folder named "Webshipper" which should contain a folder named "app".
At this point, you need to use an FTP/SFTP program to connect to your web server. Once you are logged in via FTP/SFTP, navigate the directory structure of your Magento installation. Upload the "app" folder from the module to the root of your Magento installation. This will cause the "app" folder of the module to be merged into the existing "app" folder of your Magento installation.
When the "app" folder has been uploaded, the Webshipper add-on module should be installed.
4. Configure shipping rates and drop points
After installing the Webshipper add-on module for Magento, you need to return to the Magento administration panel and navigate to:
System > Configuration > General and select "Webshipper"
Insert the configuration token from Webshipper, which you copied earlier, and click "Save Config".
5. Sending additional attributes to Webshipper (optional)
If you wish to add additional attributes to your orders in Webshipper, all you have to do is add the desired attributes inside Magento and copy those attributes into your Magento integration in Webshipper. Click here to see the full guide on Magento attributes