Quick Start

This guide covers the three steps required to begin building with the Linnworks API: requesting a developer account, selecting the application type that matches your integration workflow, and creating your application in the developer portal. By the end of this guide you will have a registered developer account, a chosen application type, and an application created in the developer portal.

Requesting a Developer Account

Existing Linnworks account holders can log in to the developer portal directly using their account holder email address. If you do not yet have a Linnworks account, or require a separate developer account, you must submit a request to the support team.

Use Developer Access Request as the subject line and include the following information:

• Details about the application you plan to develop
• Your full name
• Company name
• Email address for the new Linnworks account
• Country of registration
• Phone number

Note: the developer portal can only be accessed using the Linnworks account holder email. A secondary developer account cannot share the same email address as an existing production account.

Choosing an Application Type

The application type you select determines how your integration communicates with Linnworks and which module types are available to you in the portal. Choose the type that matches the direction and trigger of your integration before creating your application.

System Integration / Mobile Application Your application authenticates using a token issued when a user installs it. This type is suited for integrations where your system initiates requests — for example, a 3PL pulling open orders, a warehouse management system syncing stock levels, or a mobile picking application. This is also used for Linnworks Macros.

Channel Integration Linnworks periodically calls the endpoints you expose. Your integration must implement those endpoints to receive calls for new orders, stock level requests, and dispatch updates. This type is appropriate when connecting to a sales marketplace not already listed in the Linnworks app store.

Shipping Integration Linnworks calls your endpoints only when a user explicitly requests an action, such as generating a shipping label or filing a manifest. Use this type for courier or carrier integrations where actions are user-triggered rather than scheduled.

Note: if your application is a 3PL or WMS integration, use System Integration. This allows your system to pull open orders and push stock updates on its own schedule.

Creating an Application in the Developer Portal

Once you have your developer account and have identified your application type, create your application in the developer portal.

1. Log in to the developer portal using your account holder email.
2. Navigate to the application creation section.
3. Fill in the Application Name, this will be displayed to users.
4. Select the Application Type identified in the previous step.
5. Fill in the fields required by your application type.
6. Save the application and record the credentials generated by the portal.

Next Steps

After creating, you will need to fill in manifest details dependent on the application type you chose. You can find guides on this here:

Channel Integration

Shipping Integration

System Integration / Mobile Application (Coming Soon)