Generating an API Key

For a more comprehensive overview of each step, refer to the Quick Start Guide and the System Integration Setup Guide. It is important to know which application type to use based on your workflow.

Logging in to the Developer Portal

Navigate to the Linnworks developer portal and log in using your Linnworks account holder email address.

If you do not yet have a Linnworks account, or require a separate developer account, follow this process.

Creating an Application

Once logged in, create a new application in the developer portal:

1. Navigate to the application creation section.
2. Enter an Application Name.
3. Select System Integration as the application type.
4. Save the application.

The portal will generate an Application ID and Application Secret. You will need them to authorize API calls.

Installing the Application

Navigate to the App Modules tab and then click Create New Version in the top right.

To generate a Permanent Token, install the application onto a Linnworks account using the Installation URL found on the General page of your application in the developer portal.

After completing installation you will be presented with a Permanent Token. You will use it in the next step to obtain a session token for API calls.

Authorizing with the API

Before making any API calls, exchange your Permanent Token for a session token using the AuthorizeByApplication endpoint. This must be done each time you begin a new session. The session token expires after 20 minutes of inactivity — re-authorize using the same Permanent Token when it expires.

Endpoint: POST https://api.linnworks.net/api/Auth/AuthorizeByApplication

A successful response returns a session token in the Token field. Include this session token in the header of every subsequent API request. The full list of available endpoints can be found in the API Reference.