How to integrate your Magento V1 store

This guide explains how to connect your ChannelShipper account to your Magento store. This will allow you to import, manage, and generate postage labels for your Magento orders.

Within ChannelShipper, click 'Settings, and then click the 'Integrations' tile. 


Your 'Integrations page will open. Click the 'Add a new integration' button. A new pop window will appear asking you to choose the marketplace or store that you would like to connect to. Click ‘Magento.’


A drop down box will ask you to choose your Magento version. Select ‘v.1x’.


Another window will appear with several fields that must be filled in correctly in order for ChannelShipper to integrate with your Magento store.

Trading name: Select your ChannelShipper trading name from the list.

Store name: This is the name of the store within Click & Drop, and will be visible against your imported orders. This will be automatically filled once you enter your Trading name, but you can edit this if you wish.

Store URL: To find your Store URL, look at the address bar at the top of the browser tab or window where your Magento store is open. Ensure when you type or copy this into the field in ChannelShipper, you include the https:// at the start.

Please note that if any redirects are in place, you may need to enter the URL that the redirects point to.

User name: This is obtained as part of the next steps below.

API key: This is obtained as part of the next steps below.

Mark orders as despatched on channel: Check this box if you wish for your Magento orders to be marked as 'complete' once they have been marked as despatched within ChannelShipper. 

Import orders of the following status: If you use a status code other than 'processing' for the orders in your store, type the code in the box. 

Please be aware that incorrectly changing this status may result in your orders not importing into ChannelShipper.


To obtain the information for the ‘User name’ and ‘API key’ fields, you will need to log into your Magento admin panel in a different browser window or tab.


Within your Magento admin panel, you will need to set up a New Role especially for ChannelShipper. To do this, go to ‘System’ – ‘Web Service’ – ‘SOAP/XML-RPC-Roles’ and click the ‘Add New Role’ button as circled:


You will be required to give the new user role a name. Once you have done so, click the ‘Save Role’ button:


Copy or type this name into the ‘User name’ field in ChannelShipper.

Now, select your newly created Role from the list and select ‘Role Resources’ from the tab on the left hand side of the page. Ensure the drop down box is set to ‘All’:

magentov1_7.jpgNext, you will have to set up a new user for ChannelShipper. To do this, navigate to ‘System’ – ‘Web Service’ – ‘SOAP/XML-RPC-Users and click the ‘Add New User’ button.


You will be required to fill in the following fields. For ‘User Name’ and ‘API Key’, this can be anything you like, as long as you input the exact same information into ChannelShipper.


Once you have completed the form, click the ‘Save User’ button.

You will now be able to complete the Username and API key fields  within ChannelShipper.


Next, click the ‘Update and connect store’ button.

If your details are all correct, a drop down box will appear asking you to select the store you would like to integrate with. If you have only one Magento store, select ‘Default Store View’ from the list.

Otherwise, select which of your stores you would like ChannelShipper to integrate with:

AddStoreView.pngClick the ‘Update and Connect Store’ button again and you will now be returned to your ‘Integrations’ page where you will see your newly connected Magento store listed.

A green ‘chain link’ icon will indicates the connection has been successful. Any eligible Magento orders will begin importing into ChannelShipper within 10-15 minutes.

If the ‘chain link’ icon is red, please double check your data has been entered correctly.


Store order status and import frequency

Your orders must be in the status entered in your integration settings and no older than 7 days for them to import into ChannelShipper.

Eligible orders will import into your ChannelShipper account approximately every 15-30 minutes. We will attempt to update the status of orders in your Magento store approximately every 30 minutes. 

You can also trigger imports on demand by clicking 'Last import' on your Integrations settings page. The date will change to let you know the last successful date and time that orders were imported. 


Can I import customs information from my Magento Store? 

If you want ChannelShipper to import certain customs information from your Magento store, you will need to specify some attributes first.

From your 'Integrations' settings page within ChannelShipper, click your integration to expand it. Click the 'Import customs data from product' checkbox, and four text boxes will become available as shown in the image below:


Four additional options will appear asking you to type in the attributes you would like ChannelShipper to import with your orders. There is no standard template for this, as attributes will vary depending on your individual Magento store set up.

Customs country of origin attribute name: Type the attribute you would like ChannelShipper to use for 'Country of origin'.

Customs code attribute name: Type the attribute you would like ChannelShipper to use for 'Customs code'. Please note this should be a numeric code 6, 8, or 10 digits long. 

Customs description attribute name: Type the attribute you would like ChannelShipper to use for 'Customs description'.

Product weight unit: Choose the weight unit of your Magento products from the drop down list. Please note that this value will not be saved immediately to your ChannelShipper orders as ChannelShipper requires the weight of the product plus the packaging. The final weight will be saved as you apply postage to your order. 


Can I disconnect from Magento?

You are free to disconnect from Magento at any time via ChannelShipper. In the 'Integrations' section, click anywhere within the Magento integration row to expand it. To disconnect the link between Magento and ChannelShipper, click the 'Delete' button. Once you have disconnected, you will not be able to import and process any more orders from the store.

If you need to reconnect the store at a later date, simply repeat the connection process.