Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

Linnworks Integration

Introduction

The SmartConsign App for Linnworks allows you to use your existing carrier accounts with the Linnworks order management system. Estimated setup time: 5–10 minutes

Key Features

The SmartConsign Linnworks integration allows you to:

  • Create labels
  • Print labels directly or include them in a packing note/invoice
  • Add a tracking number to the Linnworks order record
  • Cancel and reprint labels when required

Before You Start

To set up the integration, you will need:

  1. An active carrier account
  2. Access to the Linnworks web portal
  3. A SmartConsign account

You can create multiple SmartConsign integrations if you use multiple carrier accounts or services.
Repeat the setup process for each additional account.

Learn more about a SmartConsign Account

The following video demonstrates the full setup process:


Install the App

The app must be installed through the web portal, even if you use the desktop version of Linnworks.

  1. Sign in to the Linnworks web portal at www.linnworks.net.
  2. From the left-hand menu, select Apps.
  3. Click Application Store.
Apps Menu in the left-hand navigation
  1. In the search bar, enter SmartConsign.
  2. Select Manage next to the SmartConsign app.
  3. Click Install.
SmartConsign App

Configure the App

After installing the app, configure the SmartConsign integration.

  1. In Linnworks, select Shipping.
  2. Click Integrations.
Integrations menu in the left-hand navigation
  1. Click Add Integration.
  2. Locate SmartConsign 2020 in the list.
  3. Click Integrate.
Integration list showing SmartConsign 2020

Set Account Name

The account name can be any reference. It does not need to match your SmartConsign account.

  1. Enter a value for Account Name.
  2. Click Next.
Account Name

Enter API Key

  1. On the welcome page, click Next.
  2. Enter your SmartConsign API Key (provided when your SmartConsign account is created).
  3. Click Next.
API Key entry screen

Learn more about your API Key

Confirm Settings

  1. Review the configuration details.
  2. Select the confirmation checkbox.
  3. Click Next.

Select Carrier

  1. Select your Carrier from the dropdown list.
  2. Click Next.
Carrier selection dropdown

Finish Setup

  1. On the final page, click Next to close the wizard.
Final setup confirmation page

Configure Services

After creating the integration, add carrier services.

  1. Locate your SmartConsign integration.
  2. Click Services.
Integration list with Services selected
  1. Open the carrier service dropdown list.
  2. Select a service.
  3. Click Add.
  4. Repeat for each required service.
Service dropdown list

Optional Configuration

  1. Rename the Linnworks service if necessary.
  2. Click Edit on the added service to configure additional options (if available for your carrier).

Save Changes

  1. Click Finish.

Verify the Integration

  1. Open an order in Linnworks.
  2. Select a configured shipping service.
  3. Generate a test label.
  4. Confirm the label prints successfully 🎉

Label Management

Standard label management tasks are handled within Linnworks.

This includes:

  • Mapping services
  • Printing labels
  • Adding labels to invoices
  • Cancelling labels

For full instructions, see the Linnworks documentation:

Linnworks Label Printing Guide

Label Format

Labels generated by the SmartConsign app are formatted for:

  • Size: 4 × 6 inches
  • Orientation: Portrait

Labels can be:

  • Printed directly
  • Included in packing notes or invoices

Extended Order Properties

The following Extended Order Property is supported:

  • InsuranceValue

Add an Extended Order Property

  1. Open the order in Linnworks.

  2. Select Edit Order.

  3. Add a new Extended Property.

  4. Enter the Property Name exactly as:

    InsuranceValue

  5. Enter the required Property Value.

  6. Save the order.

Extended Properties section

More information:

https://docs.linnworks.com/articles/#!documentation/shipping-mapping-properties

Windsor Framework

Some carriers require additional Extended Item Properties when shipping to Northern Ireland.

Required properties:

  • HSTariffCode
  • CountryOfOrigin

Add Extended Item Properties

  1. Open the product in Inventory.
  2. Select Edit Product.
Product edit screen
  1. Add a new Extended Property.

  2. Enter the Name exactly as:

    • HSTariffCode
    • CountryOfOrigin
  3. Enter the required Value.

  4. Save the product.

Example showing both required properties

More information:

https://docs.linnworks.com/articles/#!documentation/product-details-extended-properties