Linnworks API Integration

Preparation

If you are a customer with an existing Tradebox subscription, please contact Tradebox for instructions on retrieving your Linnworks token.

For new users without a Tradebox licence, please search for Tradebox in the Linnworks app store and install the app from there. If you've not yet installed the Tradebox program on your PC, you'll need to follow our guide for installing Tradebox prior to creating the channel. When registering, we recommend you use the same email as your Linnworks user, to help Tradebox tie the two accounts together.

A full video walkthrough of both installing Tradebox and setting up a Linnworks integration is available from our Video Library.

Creating the Channel

Launch the New Sales Channel Wizard via Channels > New.

The wizard will take you through the necessary steps to create your channel. The options you choose during setup can be amended later by going to Channels and double-clicking the Linnworks channel.

Click Next.

On the next screen, you'll see two options. App installed on Linnworks App Store (new users) and 

App installed via URL provided by Tradebox (existing users). 

Please select the appropriate option. 

If you select App installed on Linnworks App Store, Tradebox will check to see if it can find a matching account on Linnworks and automatically populate your token if so. If not, you'll be prompted to create one:

When redirected to the Tradebox portal, please log into your existing account and click the green + button next to the User option:

Create a new user with the same email address as the Linnworks user that you used to install the app on Linnworks. Once you have done that, select the App installed on Linnworks App Store option again, and your token will automatically populate. 

If you are an existing user, and select App installed via URL provided by Tradebox (existing users) you will have received your token directly after contacting us. Please paste the token into the Access Token box. 

Once your token has been entered by either method, click Test Connection to ensure that Tradebox can successfully connect to your Linnworks account. This will then populate the Linnworks channel drop down where you can choose which Linnworks channel you would like to connect to.

If choosing Direct, you will then have the option to enter a Subsource, which must match exactly the subsource as it appears on the Details tab of the order on Linnworks. 

Enter a Name for the channel. This is purely a label to identify the channel and can be amended at any time.

Choose the Site Currency from the drop down list.

Click Next. 

Here, you'll choose which Linnworks orders are valid for download, based on their order status. Tradebox will automatically retrieve a list of all the order statuses available on Linnworks. 

First of all, in the Order Type to Download option, you can choose whether Tradebox will download only Processed orders, Open orders, or All orders. 

Then, you can further refine this by choosing which individual orders statuses should be brought through. To do this, click in the Tradebox Status column and choose the corresponding status from the list of internal Tradebox statuses. 

If there are statuses that you don't want Tradebox to download, or don't use on Linnworks, leave the Tradebox Status column blank.

Once you've chosen the appropriate statuses, click Next again.

On the final page of the setup wizard, you will choose the primary location for stock values to be uploaded to. This is only used if you are uploading stock levels from your accounts package to Linnworks through Tradebox. 

You can also choose which reference is used as the primary order number within Tradebox for the Linnworks orders: Reference, Secondary Reference, or External Reference. The Linnworks internal order number is also stored in a separate field automatically. 

Click Finish to complete the wizard.

If you are connecting Tradebox to your accounts package, you will then be prompted to set up an accounts link. See our guides for accounts links connecting to Sage 50 or to Xero.

See the Channel Configuration article for more information on tweaking the channel integration settings once the sales channel setup wizard is complete.