How to integrate your Magento V2 store

This guide explains how to connect your Click & Drop account to your Magento store. This will allow you to download, manage, and generate postage labels for your Magento orders.

If you have an issue with an existing Magento integration, please see Troubleshooting your Magento Integration.

 

Within Click & Drop, click the 'Settings' link.

settings-help-new-logo.png

The 'Settings / Overview' page will open. In the 'Integrations' section, click the 'Go' button.

settings-overview.png

You will be taken to your 'Integrations' page. Click the 'Add new integration' button.

AddIntegrationButton-new.png

A new pop window will appear asking you to choose which marketplace store that you would like to connect to. Click ‘Magento.’

AddANewIntegration.png

A drop down box will ask you to choose your Magento version. Select 'v2.x'.Selectv2.png

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.

CallBackURL.png

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

3.png

Select 'Integrations'.

5.png

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

Addnewintegration.png

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 Click & Drop into the corresponding fields in Magento.

IntegrationInfo.png

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 Click & Drop has privileges to download, 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.

Additional note: When creating integrations, we often must request full access to your store in order for the integration to work properly. Click & Drop will only import the data we need for producing Royal Mail shipping labels and other documents. 

RoleResources.png

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 Click & Drop integration will be visible at the end of your list.

Magento API 2.4.4 and Later - Additional Steps

If you are integrating using version 2.4.4 of the Magento API or later, you must complete these additional steps to successfully integrate your Magento store with Click & Drop.

Go to:

Stores > Configuration > Services > OAuth > Consumer Settings

Then, change the setting "Allow OAuth Access Tokens to be used as stand-alone Bearer tokens" to 'Yes' as show in the screenshot below:

mceclip0.png

You can now return to System > Integrations

This is the end of Api version 2.44 and later specific steps.

Click 'Activate'.
Activateintegration.png

A new pop-up window will return you to Click & Drop.
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.'
PopupDetected.png

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

Click on the words 'Click & Drop' in red text and this will return you to your Click & Drop 'Integrations' page to finalise the process.

There are some additional options you will need to check:

Trading name: Select your Click & Drop trading name from the list.

Integration name: This is the name of the integration within Click & Drop, and will be visible against your downloaded 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 Click & Drop. 

Upload delivery confirmation to channel: Check this box if you wish for delivery confirmation numbers to be added to your Magento orders once marked as despatched. 

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 downloading into Click & Drop.

Download customs data from product: Check this box if you wish for any customs information, such as customs code, customs description, or country of origin to be downloaded and saved to your product data in Click & Drop.

MagentoV2Settings.png
Click on the 'Update and activate' button to begin downloading 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 download into Click & Drop.

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

 

Can I download customs information from my Magento Store? 

If you want Click & Drop to download certain customs information from your Magento store, you will need to specify some attributes first.

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

MagentoCustoms.png

Four additional options will appear asking you to type in the attributes you would like Click & Drop to download 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 Click & Drop to use for 'Country of origin'.

Customs code attribute name: Type the attribute you would like Click & Drop 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 Click & Drop 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 Click & Drop orders as click & Drop 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 Click & Drop. In the 'Integrations' section, click anywhere within the Magento integration row to expand it. To disconnect the link between Magento and Click & Drop, simply click the 'Delete' button. Once you have disconnected, you will not be able to download and process any more orders from the store.

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

 

How does Click & Drop handle products from Magento?

Whenever an order imports into Click & Drop from Magento, we will check for any SKU included with the order. If you already have a product in Click & Drop with the same SKU, we will be able to add key product data to the order, such as weight, product names, and any required electronic customs information.

If an order imports from Magento with a SKU value that does not already have a matching product in Click & Drop, we will automatically create one when the order is marked as despatched.

We will not automatically use order weights imported from Magento the first time a SKU is imported. This is so you can check the weight of the package is correct.

For efficient order processing, we recommend that you import information on your products into Click & Drop before processing orders.

For more information on how to create, import, or edit products, please see the following section of our help guides: How to create and import products.