Sendcloud: integration guide
About this document
This document describes how to set up a connection between shipping software Sendcloud and ChannelEngine.
Table of contents
- Selecting the integrator
- Account details
- Integration configuration
- ChannelEngine’s custom fields
- Configuring 'Weight' and 'Weight unit'
- Configuring 'Shipping method name'
Sendcloud gives you access to multiple carriers worldwide. By connecting Sendcloud to ChannelEngine, you allow it to acknowledge orders and manage shipments.
|Get product content (custom field)||Get product content (all content)|
|Get order||Post stock update|
|Post order acknowledgement||Get returns|
| Post shipment details
||Post order cancelation|
- Active account on Sendcloud
- Active merchant account on ChannelEngine
To establish a successful connection between Sendcloud and ChannelEngine, you need to set up your integration with ChannelEngine within your Sendcloud account. To do so, follow the steps below.
On Sendclound, select ChannelEngine as the preferred integrator. Go to Sendcloud and select User Panel > Settings > Integrations, select ChannelEngine and finally Connect.
Set up your integration by configuring the required details.
Name should correspond to your Sendcloud’s shop name, while Account name and API key can be retrieved from your ChannelEngine account.
Retrieve your Account name and API key from your ChannelEngine account.
In the field Account name, add your ChannelEngine API URL subdomain. To retrieve it, access your ChannelEngine account and go to Dashboard > Settings > Merchant API keys. Copy-paste the subdomain from the API URL:
Add your ChannelEngine Merchant API key to the field API key. To retrieve it, access your ChannelEngine account and go to Dashboard > Settings > Merchant API keys and copy-paste the API key.
Note that if you have not added an API key to your ChannelEngine account, you can do so by selecting Add.
For more information on how to retrieve the API Key from ChannelEngine, check out the Getting API access guide.
Once your API credentials are successfully configured – though before you can proceed with your connection and start processing real time orders –, you must map three custom fields from your ChannelEngine product feed to your Sendcloud account: product Weight, Weight unit, and preferred Shipping method name. You can do this by selecting Go to integrations.
You are then be redirected to the mapping page, where you can configure the Weight, Weight unit, and Shipping method name.
There are three ways to add custom fields to ChannelEngine: via the interface, via a product feed, and via the API. For more information on this, check out the ChannelEngine: product custom fields/extra data fields article.
When you are done adding the Weight, Weight unit, and Shipping method name fields, go to Products > Custom fields on ChannelEngine to see an overview of your custom fields. Here you must configure the custom field with Key, Type, and IsPublic options, according to the information from your product feed.
Note that by default Key is empty, Type is set to Text, IsPublic is set to No, and you must adjust each option before saving.
Using the product feed example from above, the custom fields should be created in the following way:
- Custom field = Weight
- Key = weight
- Type = number
- IsPublic = yes
- Custom field = Weight unit
- Key = weight_unit
- Type = text
- IsPublic = yes
IsPublic must always be set to Yes for Sendcloud to have access to the custom fields created on ChannelEngine.
After saving all the newly created custom fields, you can see them listed on your ChannelEngine Custom fields page. Make sure to double check that all fields are configured correctly.
For more information on ChannelEngine’s custom fields, check out the Product custom fields/extra data field management guide.
Once your custom fields are created on ChannelEngine, you can map them on Sendcloud’s mapping page. This enables Sendcloud to fetch the data for each product ChannelEngine is ingesting from your product feed. Based on the previous examples, the mapping on Sendcloud should be saved in the following way:
- Weight = weight
- Weight unit = weight_unit
Note that each of the mapping fields is configured with the title of the corresponding custom fields created on ChannelEngine. This tells Sendcloud the exact place from which the data should be ingested within your ChannelEngine product feed.
To automatically detect the shipping method selected by the buyer on each marketplace, you need to manually insert the text "SHIPPING_METHOD" to the Shipping method name field.
- Why are my orders stuck on status 'New'?
Please consult the ChannelEngine: why are my orders not being imported? article.