Royal Mail Click & Drop
Royal Mail Click & Drop is an easy way to buy postage online for items that you post through Royal Mail. To send items using Click & Drop you will enter a weight, select a package size and choose a service (e.g. ‘Royal Mail Special Delivery’). You can then pay for and generate the shipping label. Once the label has been generated, print and attach it to your package, and drop it off at your local post office.
ShopWired's Click & Drop app helps you speed up this process by automatically sending your orders to the Click & Drop website.
Orders can be exported in one of two ways, either automatically when you change the status of the order or manually through the app.
To install the app select INSTALL THIS APP.from the menu. Find and select the ‘Royal Mail Click & Drop’ app and select
The ShopWired support team are unable to provide help or support with regards to your use of Click & Drop. We can only support you on the functions that our app provides.
Adding your API key
After installing the Click & Drop app in your ShopWired account, your first step is to add your Click & Drop API key, which you can find in your Click & Drop account.
If you don't already have a Click & Drop account, you can create one here.
Once you've logged into Click & Drop, select Dashboard from the top menu, and then click the Integrate your online stores button:
Next, select the Add a new integration button in the top right:
From the list of options select the Click & Drop API button:
In the popup window choose your settings, and then select the Save and connect button:
Once the integration has been created click on its name in the integrations list, as shown in the example below:
In the box that opens click the clipboard button next to the API key to copy the key to your computer's clipboard. Then click the Update and connect button:
Navigate to the Click & Drop app in your ShopWired account by selectingfrom the menu. Paste the API key into the 'Royal Mail Click & Drop API Key' field:
Then select save changes at the bottom of the section.
Once your ShopWired account is linked with your Click & Drop account you should adjust the settings within the ShopWired Click & Drop app to suit your needs.
How orders should be exported
Orders can be exported in one of two ways, either automatically or manually through the app. In both cases the app 'listens' for changes to an order's status, and when it detects an order has a particular status it will act to export it.
If you would like orders to be automatically exported to Click & Drop, tick the 'Send orders automatically' tick box and select the order status an order should have in order to be exported:
If you would like to send orders manually to Click & Drop (through the 'manual export' section in the app) tick the 'Send orders manually' tick box. Then select the status an order needs to have to appear in the manual export section:
You can use both automatic and manual export options if you want to.
You can read more details about both the automatic and manual export options below.
Select what status an order should be changed to after being exported to Click & Drop
When an order has been successfully exported to Click & Drop the app can automatically change the status of the order. You can select what status you'd like orders to be given, e.g. 'dispatched', from the drop-down setting.
Send the customer’s billing address to Click & Drop (in addition to the shipping address)
Select this option to send the customer's billing address to the Click & Drop service when an order is exported. For more information about this setting you should contact Click & Drop support.
Include your (company) details on the order sent to Click & Drop
Select this option to send your company details (taken from your ShopWired account) to the Click & Drop service when an order is exported. For more information about this setting you should contact Click & Drop support.
Mapping delivery rates
Each delivery rate that is set up in your ShopWired account can be 'mapped' to a corresponding Royal Mail Service and Package Size. If you are using automatic export you will need to ensure that delivery rates available in your online store are mapped to a Royal Mail Service Code & Package Size. If orders using some shipping rates will be sent using another service, e.g. DHL or FedEx, then you don't need to map them.
For each delivery rate select the 'Service' and 'Package Size' from the drop-down lists:
To export an order automatically to Click & Drop, change the status of the order to the one selected for automatic export in the app settings section.
Each order will take up to 2 minutes to export successfully. Orders exported automatically will then be displayed within Click & Drop for you to approve postage options and pay for and print the shipping label.
Where an order fails to export automatically it will appear in the export errors section of the app.
Where an order has exported successfully it will be displayed in the 'exported orders' table of the app.
To export an order manually, change the status of the order to the one selected for manual export in the app settings section.
The order will appear in the manual export section of the app page within 2 minutes. To get started with exporting the order, click the apply postage button:
A new section will appear for you to complete. You'll need to create at least one package for the order. Each package will then be sent to Click & Drop. An order can be split across multiple packages if needed.
Total weight - in this field the system will prefill the total weight of the products in the order. You should adjust this value to make sure it is the total weight for the items included in the package.
Package size - select the size of the package that you're sending. The app will adjust the available package sizes to choose from based on the weight of the package.
Service - select the service that you'll be using for the package.
If you are shipping the order outside of the UK then you should select each product that's included in the package. Click & Drop will use this information for customs declarations.
Custom service codes
The app includes the 12 default service codes for delivery in the UK and 4 default service codes for delivery internationally.
If you need to use alternative service codes (for example provided through your OBA account) you can do so by using the 'Custom Service Codes' section:
Enter your description for the service code (this is used for internal purposes only) into the Description field and the service code provided by Royal Mail in the Service Code field, as shown in the example above. Click the save changes button to add the code.
The service code will then be available for you to map to your delivery rates. UK and international service codes are added in the same place.
Existing custom service codes can be deleted by clicking the 'delete' button and confirming your selection.
Where an order fails to export to Click & Drop it will be displayed in the 'Exported Errors' section. Orders can fail to export for a number of reasons. For example, the shipping rate selected on the order might not have been mapped to a corresponding Royal Mail Service & Package Size.
Where an order has failed to export you can fix the error (if possible) and click the retry export button to try again. Alternatively, you can click the move to manual export button and export the order manually.
A list of common errors and the root cause is shown in the table below.
|An error occured due to missing information||
The app failed to find a valid value for one or more of the following; number of packages, who to notify for tracking, Royal Mail service, recipient address, sub-total, total, the shipping charge or the order reference number.
• Check the order, to ensure the sub-total and total are present and positive numbers.
|The service was missing or invalid||
The app failed to find a valid Royal Mail service for the delivery rate being used by the order.
• Check the delivery rate mapping in the app to ensure a valid service has been selected for the delivery rate being used in the order.
|A package had an invalid combination of either service, package size, weight or country||
The app could not find a valid Royal Mail service, a valid package format, valid package weight or valid delivery country in the order
• Check that the order products contain the correct weights.
|A package had a missing or invalid weight or package size||
The app could not find a valid package weight or package format.
• Check that the products within the order have the correct weights and check the delivery rate mapping in the app to ensure a package format has been selected for the delivery rate in use.
|The order had no recognisable packages||
The app couldn’t find any valid products to put into the Royal Mail order.
• Check that all products in the order have a valid price and weight.
|No API key found||
The app has received a valid order but cannot find an API key. This error means that the user either has not provided an API key in the app settings, or they have provided an invalid API key.
• Check there is a valid API key within the “Royal Mail Click & Drop API Key” setting inside of the “App Configuration” section.
|Royal Mail's API rejected the order...||
The app attempted to send the order to Royal Mail, but they have rejected the order. The app has not received a reason for the rejection from Royal Mail’s API.
• Review the order looking for incorrect combinations of product weights, package formats and service codes. If no reason can be identified for the error, contact support.
|An error occurred while connecting to Royal Mail||
The app failed to generate a valid connection to the Royal Mail API.
This is either caused by an outage with the app, or an outage with Royal Mail’s API.
• Please report this error to support
|Royal Mail Error Message: ...||
These error messages are generated directly by Royal Mail. These can be caused by various things, but the error message should explain what the issue is.
• The error message generated by Royal Mail should inform the user what went wrong with the order. If no solution is obvious, contact the developer.
|Royal Mail Error Message: Property ‘PhoneNumber’ max length is 25, provided length is ...||
This error message is caused by the phone number for either the recipient address, billing address or sender address being longer than 25 characters.
• Check the phone number length on the shipping and billing address for the order.
International shipping (product requirements)
If you are shipping orders internationally (outside of the UK), Royal Mail requires the following 'customs information' to be sent about each product in the order:
The HS Tariff Code - which is a system where each type of product has its own unique code. You can add the HS Tariff Code for each product in the 'Stock & Delivery Management' section when creating/editing the product:
A Customs Description - you will need to enter an accurate and detailed description for each product. You can add this using the Royal Mail - Customs Description field in the 'Custom Fields' section when creating/editing a product.
The Origin country - you will need to enter the country of origin for each product. You can add this using the Royal Mail - Origin Country field in the 'Custom Fields' section when creating/editing a product. Use the drop-down list to select from the 20 most common countries, or alternatively, select the custom country code option and in the Royal Mail - Custom Origin Country field enter the 3 digit ISO code for the country. You can view a full list of country codes at https://www.iban.com/country-codes. For example, for Australia you would enter 'AUS':
This information can also be added using the product import/export system.