How to integrate your Magento V2 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 'v2.x'.


Next, another popup window will appear with your Callback URL and Identity Link. be sure to keep this page open, as you will need to copy and paste these details into your Magento account in order for the integration to work.ConfigureV2.png

In a new tab or window, sign into your Magento account and click the 'System' icon on your dashboard. 


Select 'Integrations'.


You will be taken to your list of integrations. Click the 'Add New Integration' button in the bottom right hand corner of the page.


There are two separate tabs on the page: 'Integration Info' and 'API'. The page will be open on 'Integration Info' by default.

Here you will need to input your name, email address and password, and copy and paste the 'Callback URL' and 'Identity Link URL' from ChannelShipper into the corresponding fields in Magento.


Once you have done this, the next step is to set the application API privileges. To do this, click the 'API' tab on the left of your page as shown. You don't need to click the 'Save' button at this point. To ensure ChannelShipper has privileges to import, process, and mark your orders as despatched, select 'All' from the drop down box labelled 'Resource Access'. All boxes on the page will then be checked.

Please note that some browsers or Magento versions may behave differently at this point, so if you have selected 'All' for resources and the boxes are not checked, you may need to select 'Custom' access and check each box individually.


The last step is to click the 'Save' button to finish the process, and you will be taken back to your 'Integrations' page. Your new ChannelShipper integration will be visible at the end of your list. Click 'Activate'.

A new pop-up window will return you to ChannelShipper.
Please note, some browers may warn you they have blocked the pop-up. You will need to unblock the pop up in order to continue. In most browsers, this can be found in the top right corner. You will need to select to 'allow pop-ups for Magento.'

A pop-up window will open to confirm your Magento store is connected to Click & Drop, but that the channel is currently inactive.

Lastly, return to ChannelShipper to finalise the integration. There are some additional options you will need to check:

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

Integration name: This is the name of the integration within ChannelShipper, 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.

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.

Update order cancellation status: Check if you want us to mark your orders as cancelled in ChannelShipper if your customer cancels the order in your Magento store. 

Import Product Variant: Check if you want us to import any product variant information and display this on your orders as Order tags.

Click on the 'Update and activate' button to begin importing and processing your orders. The red chain link icon will turn green to show your integration has been successful.

Store order status and import frequency

Your orders must be in the status of ‘Processing’ 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, simply 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.