> For the complete documentation index, see [llms.txt](https://doc.wearepatchworks.com/product-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/linnworks-prebuilt-connector.md).

# Linnworks (prebuilt connector)

## Description

**Linnworks** is an eCommerce inventory and order management platform that helps retailers automate key processes.

## API documentation

API documentation for Linnworks (used to build this connector) can be found via the link below:

{% embed url="<https://apidocs.linnworks.net/reference/overview>" %}

## Authentication

When adding connector instances for Linnworks, the following authentication methods are supported:

* [AuthorizeByApplication](#authorizebyapplication)

### AuthorizeByApplication

When a user chooses to [add a connector instance](/product-documentation/connectors-and-instances/working-with-instances/adding-an-instance.md) using **AuthorizeByApplication** authentication, the credentials below are prompted:

<table><thead><tr><th>Credential</th><th data-type="checkbox">Required?</th><th>Notes</th></tr></thead><tbody><tr><td><code>Scope</code></td><td>true</td><td>The required scope to define what access permissions should be given to Patchworks.</td></tr><tr><td><code>Token</code></td><td>true</td><td>The token is provided when the Patchworks integration is added in the Linnworks developer portal.</td></tr><tr><td><code>Application id</code></td><td>true</td><td>The application id is created when the Patchworks integration is added in the Linnworks developer portal.</td></tr><tr><td><code>Application secret</code></td><td>true</td><td>The application secret is created when the Patchworks integration is added in the Linnworks developer portal.</td></tr><tr><td><code>Grant type</code></td><td>true</td><td>Set to <code>client_credentials</code>.</td></tr><tr><td><code>Response authentication token key</code></td><td>true</td><td>Set to <code>token.</code></td></tr></tbody></table>