Skip to main content

Linnworks

This page contains the setup guide and reference information for the Linnworks source connector.

Prerequisites

  • A Linnworks account

Setup guide

Generate Credentials in Linnworks

  1. The Linnworks platform has two portals: Seller and Developer. To generate the necessary credentials, log in to the developer portal and select + New App.
  2. Input a name for your application and set the Application Type to System Integration.
  3. Select Edit for your new application. In the General tab, find and copy your Application ID and Application Secret. Click on the Installation URL to complete the installation of your app and acquire your API Token.
tip

The value of your API Token can be viewed at any time from the main dashboard of your account, listed in your app's Installs table.

Set up the connector in Airbyte

  1. Log in to your Airbyte Cloud or Airbyte Open Source account.
  2. From the Airbyte UI, click Sources > + New Source.
  3. Select Linnworks from the list of available sources.
  4. Enter a Name of your choosing.
  5. Enter your Application ID, Application Secret and API Token.
  6. Enter a Start date using the provided datepicker. When using Incremental sync mode, only data generated after this date will be fetched.
  7. Select Set up source and wait for the connection test to complete.

Supported streams and sync modes

The Linnworks source connector supports the following streams and sync modes:

Stream NameFull RefreshIncremental
ProcessedOrders
ProcessedOrderDetails
StockItemsX
StockLocationsX
StockLocationDetailsX

Data type mapping

Integration TypeAirbyte TypeExample
numbernumber50.23
integerinteger50
datestring2020-12-31
datetimestring2020-12-31T07:30:00
arrayarray["Item 1", "Item 2"]
booleanbooleanTrue/False
stringstringItem 3

Limitations & Troubleshooting

Expand to see details about Linnworks connector limitations and troubleshooting

Rate limits

Rate limits for the Linnworks API vary across endpoints. Use the links in the Supported Streams table to view each endpoint's limits. Rate limited requests will receive a 429 response, but the Linnworks connector should not run into Linnworks API limitations under normal usage.

Reference

Config fields reference

Field
Type
Property name
string
application_id
string
application_secret
API Token
required
string
token
string
start_date

Changelog

VersionDatePull RequestSubject
0.1.72024-02-2235557Manage dependencies with Poetry
0.1.62024-01-3134717Update CDK and migrate to base image
0.1.52022-11-2019865Bump Version
0.1.42021-11-248226Source Linnworks: improve streams ProcessedOrders and ProcessedOrderDetails
0.1.32021-11-248169Source Linnworks: refactor stream StockLocations
0.1.22021-11-238177Source Linnworks: add stream ProcessedOrderDetails
0.1.02021-11-097588New Source: Linnworks