Despatch Cloud
Welcome to the Despatch Cloud Documentation portal. If you need help, you’ve come to the right place. If you can't find what you're looking for, we welcome you to contact us. You can call us on 01377 455 180 or email hello@despatchcloud.com.
- Hand-Held Devices
- System Update Guide
- Sales Channels
- How to Get Your Shopify Location ID
- BigCommerce
- Shopify
- Squarespace
- Wish
- Wix
- Zoho Commerce
- WooCommerce
- BluePark
- Fruugo
- OnBuy
- Magento
- Magento V1
- OpenCart
- Bol.com
- PrestaShop
- Visualsoft
- eBay
- Etsy
- EKM
- Couriers
- Public API
- Silent Printing
- QZ Tray
Hand-Held Devices
Despatch Cloud has created a custom app to check stock levels, pick orders or search for locations with a tap on the screen. To find out more about the mobile app, please visit: https://despatchcloud.com/features/warehousing/#mobile-app
Recommended Devices
The Despatch Cloud mobile application will work on Andriod devices running 6.0+.
To guarantee the full functionality of our app, we recommend using a Zebra TC51, Zebra TC25 or Zebra TC20.
How to Set up a Zebra Device
You will need to first configure your DataWedge profile to work with DC Mobile. You can do this by downloading our pre-configured DataWedge profile here.
Alternatively, you can configure this manually by following the steps below:
- Go into the DataWedge application.
- Clone the DWDemo profile by long pressing on the profile.
- Name the new profile DCHandheld.
- In the DCHandheld profile, click on Decoders.
- From the list, enable Interleaved 2of5, Code11 and Code93.
- Go back to the DCHandheld menu and click Associated Apps.
- Click the three dots in the top right of the app and click Add New App.
- Scroll through the apps until you find Despatch Cloud and select it.
- Go back to the DCHandheld menu, scroll down to keystroke and disable it.
- Scroll further down to Intent Output and enable it.
- Click Intent action and type handheld.ACTION
- Intent category should be left blank.
- Click Intent Delivery and select Broadcast Intent.
Linking an Account to the Mobile Application
- Log into your Despatch Cloud account you wish to set the application up to.
- Click the Settings button in the top right-hand side of the screen.
- Navigate to General Settings.
- Click on Web Service in the navigation bar.
.png)
- Set Web Service Active to 'Yes'..png)
- Set a Web Service Key to a string of numbers and letters only you will know (this acts like a password to your mobile application)..png)
- Once you have entered a web service key, click Save Changes. .png)
- On the mobile device, enter your company name as it is shown in the webpage URL.
The webpage URL will be:
https://yourcompanyname.despatchcloud.co.uk
- The 'yourcompanyname' will be unique to your account and this is what needs to be entered.
- Enter the API key which will be the web service key you made earlier.
System Update Guide
To install a Despatch Cloud update, please follow the below step-by-step guide. If you would like support with an update, you can call us on 01377 455 180 or email hello@despatchcloud.com. Note: Automatic system updates are only available on Despatch Cloud version 3.4 and above. If you are on an older version of Despatch Cloud, please contact us to arrange your update.
Checking Your Despatch Cloud Version
To check which version of Despatch Cloud you are running, simply login to your account and from the dashboard scroll down to the bottom of the page where you will find your version number as shown in the screenshot below. If your version number shows as 3.4.X or above, you can install automatic system updates using the guide below.
Installing Your Update
To install your update, simply login to your account and from the dashboard click on the settings menu in the top right corner of the screen as shown in the screenshot below.
From the settings menu, click on the Engineer Menu option as in the screenshot below.
Now click on "Download & Install System Update" as in the screenshot below.
Sales Channels
How to Get Your Shopify Location ID
To obtain your Shopify Location ID, please follow the steps below:
- From your Shopify admin dashboard, navigate to Settings > Locations.
- Select the desired location to see its details.
- On the detail page, the Location ID will be in the URL of the page, as shown in the illustration below.
BigCommerce
If you click on Big Commerce you will see some fields such as Name, Client ID, Client Secret, Store Hash and, Order Statuses that we are going to show you how to fill out.
The first thing you need to do is to obtain the API Credentials from your BigCommerce store.
The following steps outline how to generate store API Credentials of BigCommerce:
- Log into the store, using your (owner’s) username/password.
- After logging in to your dashboard, navigate to Advanced Settings > API Accounts.
3. Click on the Create API Account.
4. Select "Create V2/V3 API Token".
5. Give the account a name (it will only be visible to store users).
6. In the "OAuth Scopes" section, select the scopes the app will require. You can see the recommended settings in the following pictures.
7. At the end click on "Save".
After clicking on the Save button, the BigCommerce API Credentials will be presented to you as following:
Also, a text file will be automatically downloaded which contains the Credentials:
Now you have the Client ID, Client Secret, and Access Token. But you also need "Store Hash". You can obtain the Store Hash from API Path:
https://api.bigcommerce.com/stores/<storehash>/v3/
which is shown in the below picture:
About Order Statuses, you can choose any of them by default. But we don't recommend you to choose anything other than Incomplete and Partially Shipped orders. Because we don't do anything with Shipped, Refunded, or Cancelled orders.
Shopify
To setup a Shopify store on Despatch Cloud, you must have the login credentials for the Shopify store you wish to setup. As you can see in the picture below, there are some fields like API Key and Password that you need to obtain from your Shopify store.
To obtain these credentials, you will need to login to your Shopify store and create a new Private App. In order to create a Private App follow the steps below:
Login to your Shopify store admin panel, select the "Apps" from the left pane.
A modal will appear asking to give your app a name and assign a developer. Give your App name as "Despatch Cloud".
Now we need to configure the app with the required access scopes to work with Despatch Cloud. Go to the "Configuration" tab and click the "Configure" button.
The next step is to Install the App, which will then give us an access token to use. Navigate to the "API credentials" tab and click the "Install app" button.
This will present you with this modal. Click the "Install" button to continue.
This will allow you to retrieve your access token. Click the "Reveal token once" link and you'll be presented with your access token. It will be in the format of: shpat_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.
Within Despatch Cloud (or Shipper), go to Install a Shopify store and complete the input fields in the modal.
For hostname, enter your Shopify subdomain (eg. if your Shopify domain is mystore.myshopify.com, then populate the hostname field as mystore).
Next, check the Use Access Token checkbox, and copy and paste the Shopify access token into the Access Token field.
Once this has been done, you can click Install/Submit and your Shopify store is now connected with Despatch Cloud.
Squarespace
As you can see in the picture below, there are some fields like API Key that you need to obtain from your Squarespace store to set up a Squarespace Channel on Despatch Cloud.
To create API Key follow the steps below:
- After logging in to your Squarespace store, In the Home Menu, click on "Settings"
2. Then select "Advanced"
3. Click on "Developer API Keys"
4. Then click on "Generate Key"
5. Enter a "Key Name"
6. Select the recommended "Permissions" for the API key as following:
7. At the end click on "Generate Key"
Now you have the Key Name and API Key which you can enter in the required field to set up your Squarespace Channel in Despatch Cloud.
Wish
To set up a Wish store on Despatch Cloud, you must have the login credentials for your Wish store. As you can see in the picture below, there are some fields like Client Key and Client ID that you need to obtain from the Wish store.
To obtain these credentials, you will need to create a new Private App in your Wish merchant account. In order to create a Private App follow the steps below:
1. Login with your Wish merchant account: https://merchant.wish.com/login
3. Click on "Register a private app" from the "Private app" section.
4. Enter an "App Name" and the link below as "Redirect URL"
https://staging.channelapi.co.uk/authorization/wish
6. Tick the checkbox and click on "Submit".
Now you have the Client Key and Client ID which you can enter in the required field to set up your Wish Channel in Despatch Cloud.
Wix
As you can see in the picture below, there are some fields like App ID and Secret Key that you need to obtain from your Wix account to set up a Wix Channel on Despatch Cloud.
To create these credentials follow the steps below:
1. Sign in to your Wix account.
2. Go to this URL: https://dev.wix.com/dc3/my-apps
3. If this is your first time creating an app, you will be presented with the page below. Then you should click on "Start Building"
Or, if you have already created an app before, click on the "Create New App" button.
4. Click on the "Permissions" from the left side menu.
5. Click on the "Add Permissions" button.
6. Click on "Permission Category" and select "Wix Stores"
7. Now tick Manage Products, Read Orders, Read Products, Manage Orders scopes (as you see in the picture below), and "Save".
8. Click on the "OAuth" from the left side menu in the next step.
9. Enter the link below in the "Redirect URL" and "App URL" fields and "Save".
https://staging.channelapi.co.uk/authorization/wix
Then you can copy the App ID and App Secret Key and fill the required fields to set up your Wix Channel in Despatch Cloud.
Zoho Commerce
To set up a Zoho Commerce store on Despatch Cloud, you must have the login credentials for your Zoho store. As you can see in the picture below, there are some fields like Client Key and Client Secret that you need to obtain from your Zoho store.
To obtain these credentials, follow the steps below:
1. Login to your Zoho Account
2. Open the link below
https://accounts.zoho.com/developerconsole
3. If this is the first time you are adding a client, click on "Get Started"
If you added a client before, click on "Add Client"
4. Choose "Server-based Applications" as Client Type.
5. Fill in the fields as follows:
Client Name: Any name can be given
Homepage URL: https://staging.channelapi.co.uk
6. Then click on "Create"
Now you can copy the Client ID and Client Secret, and enter in the required field to set up your Zoho Commerce Channel in Despatch Cloud.
WooCommerce
To set up a WooCommerce store on Despatch Cloud, you must have the login credentials for your WooCommerce store. As you can see in the picture below, there are some fields like Consumer Key and Consumer Secret that you need to obtain from your WooCommerce store.
To obtain these credentials follow the steps below:
1. Login to your WooCommerce Dashboard
https://woocommerce.YourStore/wp-admin/
3. Click on the "Advanced" Tab then "Rest API"
4. Click on "Add Key" button.
5. Define the API "Key Details" according to the image below. You can enter anything you want in "Description" but you should set the "Permissions" field as "Read/Write".
6. Then click on "Generate API key"
Now you can copy the Consumer Key and Consumer Secret and enter them in the required fields in Despatch Cloud.
BluePark
To add a Bluepark sales channel on Despatch Cloud, you must have the login credentials for it. As you can see in the picture below, there are some fields like API Username, API Key, and Domain that you need to obtain from your Bluepark store.
In order to create Credentials follow the steps below:
1. Login to your Bluepark Admin Manager.
3. Click on the green Plus button or select an existing admin user by clicking on the username or the pencil button to enter the "Admin Editor"
4. Scroll down the page to find the "Admin Panel Access and Authorisation" section and check the box to "Enable API Access"
5. Click on the floppy disk icon to Save your changes.
Now you can view all of your API access credentials which you could use to setup your Bluepark channel on Despatch Cloud.
Note: Enter the "API Access URL" in the "Domain" field.
Fruugo
To setup a Fruugo Sales Channel on Despatch Cloud, you must have the login credentials for the Fruugo store you wish to setup. As you can see in the picture below, the only credentials you need is the Username and Password which is the email and password you use to login to: https://retailer.fruugo.com/
OnBuy
To setup an OnBuy Sales Channel on Despatch Cloud, you must have the login credentials for the OnBuy store you wish to setup. As you can see in the picture below, there are some fields like Site ID, Consumer Key, and Secret Key that you need to obtain from your OnBuy store.
To obtain these credentials, follow the steps below:
1. Sign in with your OnBuy Seller Account by going to the URL: https://seller.onbuy.com
3. In the "Enabled Section" click on "OnBuy API", as you see in the picture below:
Now you have the Site ID, Consumer Key, and Secret Key which you can put into the required fields to setup your OnBuy channel in Despatch Cloud.
Note: use the Consumer Key and Secret Key fields in the "Live keys" section.
Magento
To setup a Magento sales channel on Despatch Cloud, you must have the login credentials for the Magento store you wish to setup. As you can see in the picture below, the only credentials you need are the Username and Password which is the email and password you use to log into your Magento Dashboard.
Note: In the "Domain" field please enter the store URL.
Magento V1
To add a Magento V1 sales channel on Despatch Cloud, you must have the login credentials for it. As you can see in the picture below, there are some fields like API Username and API Key that you need to obtain from your Magento V1 store.
In order to create these credentials follow the steps below:
1. Log in to your Magento Admin Panel.
3. Click on the "Add New Role" button.
4. Enter a name and the current admin password.
5. Click on the "Role Resources" tab and set "Resource Access" as "All"
6. Click on the "Save Role" button.
8. Click the "Add New User" button.
9. Fill in the fields as you see in the image below. Enter anything you want in the User Name and API Key fields, but don't forget to take note of them, these values are required to complete the integration.
10. Select the "User Role" and choose the Role you create before.
11. Click on the "Save User" button.
Now you have API Username and API Key which you can enter in the required field to set up your Magento Channel. But there are other fields that need to be filled:
Domain: In this field, you should enter the store URL.
Custom Fulfilment Status: If you tick the "Use Custom Fulfilment Status" checkbox, you can create custom statuses in Magento like Awaiting Courier, Awaiting Label, or Fulfilled, etc. You can define your own custom status here. This field says which status you would like to set when an order is fulfilled.
OpenCart
To setup an OpenCart sales channel on Despatch Cloud, you must have the login credentials for your OpenCart store. As you can see in the picture below, there are some fields like API Key and Name that you need to obtain from your OpenCart store.
To obtain these credentials, follow the steps below:
1. Login to your OpenCart Admin Panel.
3. Click on the Plus button.
4. Enter a name in "API Name" field and click on the "Generate" button. Also, select the "Enabled" option for "Status"
5. Click on the floppy disk icon to Save.
Now you have the Name and API Key which you could enter in the required field to setup your Opencart Channel on Despatch Cloud.
Note: In the "Domain" field please enter the store URL.
Bol.com
To add a Bol sales channel on Despatch Cloud, you must have the login credentials for it. As you can see in the picture below, there are some fields like Client ID and Client Secret that you need to obtain from your Bol store.
These credentials can be obtained through the Seller Dashboard (SDD). In order to create these credentials follow the steps below:
1. Log in to the Seller Dashboard,
2. Open the settings page, and find the section called "API Instellingen"
3. Fill in the details of the technical contact (Technisch contactpersoon) and click on "Opslaan" to save.
4. After saving the technical contact information, new sections will be available to create credentials. Press the "Anmaken" button.
5. After clicking on "Anmaken", a dialog window will be opened. Enter a name for the credentials in the field.
6. Press the blue button "Ja, voeg toe" to create the credentials.
The newly created credentials should now show up in the list.
7. To get the full set of credentials, click the "Toon secret" link below the "Client ID". A popup window will open containing the "Client Secret".
Now you have the Client ID and Client Secret that you can enter in the required field to set up your Bol sales channel on Despatch Cloud.
PrestaShop
To setup a PrestaShop sales channel on Despatch Cloud, you must have the login credentials for your PrestaShop store. As you can see in the picture below, there are some fields like Web Service Key that you need to obtain from your PrestaShop store.
In order to create a Web Service Key follow the steps below:
1. Log in to your PrestaShop Dashboard.
3. Click on the "Add new webservice key" button.
4. And click the "Generate Key" button or enter a unique one.
5. In the "Permissions" section, select the permissions as below:
products View (GET),
product_options View (GET),
product_option_values View (GET),
stock_availables View (GET), Modify (PUT)
orders View (GET),
order_invoices View (GET),
order_details View (GET),
order_carriers Modify (PUT),
addresses View (GET),
customers View (GET),
currencies View (GET),
combinations View (GET)
6. Finally copy the API Key and click the "Save" button.
Now you have the Web Service Key, you can enter into the required field to setup your channel in Despatch Cloud.
Note: Enter the store URL in the "Domain" field.
Visualsoft
To setup a Visualsoft channel on Despatch Cloud, you must have the login credentials for your Visualsoft store. As you can see in the picture below, there are some fields like Client ID, Username, and Password. To fill out this necessary information, you need to get in touch with the VisualSoft team.
Their contact information is available on https://www.visualsoft.co.uk/contact
But it is recommended you submit a ticket on https://support.visualsoft.co.uk/
eBay
In order to setup an eBay sales channel on Despatch Cloud follow the steps below:
1. As you can see in the picture, the only credentials you need is "Name". Enter a name in this field. It could be anything you want as long as it isn't taken before.
2. Then click on "Submit"
If you face an error as in the picture below, this means the name you picked is already taken and you have to try another name.
If you get a message like in the following picture then it means you created your channel successfully.
3. The next step is connecting the channel. In order to do that click on the Link Icon.
4. Click on the "I agree" button.
5. If you haven't logged in to eBay already, then you have to sign in to your account.
But, if you were already logged in to your eBay account, you will directly see the message below.
Now your eBay sales channel is added and connected successfully.
Etsy
To setup an Etsy sales channel on Despatch Cloud, you must fill out the credentials, then connect to the channel. In order to setup an Etsy sales channel on Despatch Cloud follow the steps below:
1. Enter a name in the "Name" field. It could be anything you want as long as it wasn't used already. Also, enter your "Shop Name".
2. Then click on "Submit"
If you face an error as in the picture below, this means the name you picked is already taken and you have to try another name.
If you get a message like in the following picture then it means you created your channel successfully.
3. The next step is connecting the channel. In order to do that click on the Link Icon.
4. Click on "Allow Access"
5. If you haven't logged in to Etsy already, then you have to sign in to your account.
But, if you were already logged in to your Etsy account, you will directly see the message below.
Now your Etsy sales channel is added and connected successfully.
EKM
In order to setup an EKM sales channel on Despatch Cloud follow the steps below:
1. As you can see in the picture, the only credentials you need is "Name". Enter a name in this field. It could be anything you want as long as it isn't taken before.
2. Then click on "Submit"
If you face an error as in the picture below, this means the name you picked is already taken and you have to try another name.
If you get a message like in the following picture, then it means you created your channel successfully.
3. If you haven't logged in to EKM already, you have to sign in to your account.
But, if you were already logged in to your EKM account, you will directly see the following:
4. Click on "Allow" and you will see the message below.
Now your EKM sales channel is added and connected successfully.
Couriers
Public API
Despatch Cloud 3.5 Public API
API Access is included in our Gold, Platinum and Enterprise plans you can find our latest API documentation at the below Postman link:
Despatch Cloud 3.4 Public API
API Access is included in our Gold, Platinum and Enterprise plans you can find our latest API documentation at the below Postman link:
3.4 is a legacy product and will be getting discontinued in Q1 2023 we strongly recommend upgrading your system to Despatch Cloud 3.5
Silent Printing
Silent Printing with Despatch Cloud
Despatch Cloud supports silent printing.
QZ Tray
QZ Tray (OSX)
To set up QZ Tray, follow the below steps. If you need help or have any questions, please contact us.
Step 1
Go to the QZ Tray website https://qz.io/
Click on the Download Now button (as below).
Step 3
Click on QZ Tray 2.0 (as below).
Step 4
You will see a new window open on your computer. When this happens, please click Save (as below).
Step 5
Once QZ Tray has successfully saved to your computer, double click on it and follow the required steps to install (as below).
Step 6
Click Continue.
Step 7
Click Continue.
Step 8
Click Install
Step 9
Once you have clicked Install, a pop-up will appear asking you to download Java 1.7. Click OK. (Java is required when using QZ Tray) (as below).
Step 10
You have successfully installed QZ Tray. Click Close (as below).
Step 11
You will now be re-directed to Java (https://java.com/en/download/). Click on Free Java Download (as below).
Step 12
You will now be asked to agree to start a download. Click on Agree and Start Free Download (as below).
Step 13
Once you have clicked on Agree and Start Free Download, a new window wil appear asking you to save Java. Click Save (as below).
Step 14
Once Java has successfully saved to your computer, double click on it follow the required steps to install (as below).
Step 15
Once you have double clicked on Java install, a new pop-up will appear. Click Next (as below).
Step 16
Make sure to UNTICK the checkbox which asks you to 'Get a Yahoo homepage and new tab page on Safari and Chrome' (By leaving this checkbox ticked, it will allow for unwanted malware to be installed on to your computer.) (as below).
Step 17
You have successfully installed Java. Click Close (as below).
Step 18
Now that you have successfully installed QZ Tray and Java, you will need to click on the small QZ Tray icon that will have appeared at the bottom of your screen, inside the task bar (or top, depending on the computer you are using). Click on the icon and select the option 'Automatically Start' (as below).
Step 19
Restart your browser.
Note: To set up QZ Tray with Despatch Cloud, you must have the login credentials for your Despatch Cloud account.