> 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&#x20;

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>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/patchworks-connectors/linnworks-prebuilt-connector.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.