📘Docs: Update source Linnworks page (#34788)

airbytehq · Feb 2, 2024 · 0c09afe · 0c09afe
1 parent ec92971
commit 0c09afe
Showing 1 changed file with 49 additions and 32 deletions.
diff --git a/docs/integrations/sources/linnworks.md b/docs/integrations/sources/linnworks.md
@@ -1,54 +1,71 @@
 # Linnworks
 
-## Sync overview
+This page contains the setup guide and reference information for the [Linnworks](https://www.linnworks.com) source connector.
 
-Linnworks source supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run.
+## Prerequisites
 
-Airbyte uses [Linnworks API](https://apps.linnworks.net/Api) to fetch data from Linnworks.
+- A Linnworks account
 
-### Output schema
+## Setup guide
 
-This Source is capable of syncing the following data as streams:
+### Generate Credentials in Linnworks
 
-- [StockLocations](https://apps.linnworks.net/Api/Method/Inventory-GetStockLocations)
-- [StockLocationDetails](https://apps.linnworks.net/Api/Method/Locations-GetLocation)
-- [StockItems](https://apps.linnworks.net//Api/Method/Stock-GetStockItemsFull)
-- [ProcessedOrders](https://apps.linnworks.net/Api/Method/ProcessedOrders-SearchProcessedOrders)
-- [ProcessedOrderDetails](https://apps.linnworks.net/Api/Method/Orders-GetOrdersById)
+1. The Linnworks platform has two portals: Seller and Developer. To generate the necessary credentials, log in to the [developer portal](https://developer.linnworks.com) 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](https://cloud.airbyte.com/workspaces) 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](https://docs.airbyte.com/cloud/core-concepts/#connection-sync-mode):
+
+| Stream Name                                                                                    | Full Refresh | Incremental  |
+| :--------------------------------------------------------------------------------------------- | :----------- | :----------- |
+| [ProcessedOrders](https://apps.linnworks.net/Api/Method/ProcessedOrders-SearchProcessedOrders) | ✓           | ✓            |
+| [ProcessedOrderDetails](https://apps.linnworks.net/Api/Method/Orders-GetOrdersById)            | ✓           | ✓            |
+| [StockItems](https://apps.linnworks.net//Api/Method/Stock-GetStockItemsFull)                   | ✓           | X             |
+| [StockLocations](https://apps.linnworks.net/Api/Method/Inventory-GetStockLocations)            | ✓           | X             |
+| [StockLocationDetails](https://apps.linnworks.net/Api/Method/Locations-GetLocation)            | ✓           | X             |
 
 ### Data type mapping
 
-| Integration Type | Airbyte Type | Notes                      |
+| Integration Type | Airbyte Type | Example                    |
 | :--------------- | :----------- | :------------------------- |
-| `number`         | `number`     | float number               |
-| `integer`        | `integer`    | whole number               |
-| `date`           | `string`     | FORMAT YYYY-MM-DD          |
-| `datetime`       | `string`     | FORMAT YYYY-MM-DDThh:mm:ss |
-| `array`          | `array`      |                            |
+| `number`         | `number`     | 50.23                      |
+| `integer`        | `integer`    | 50                         |
+| `date`           | `string`     | 2020-12-31                 |
+| `datetime`       | `string`     | 2020-12-31T07:30:00        |
+| `array`          | `array`      | ["Item 1", "Item 2"]       |
 | `boolean`        | `boolean`    | True/False                 |
-| `string`         | `string`     |                            |
-
-### Features
+| `string`         | `string`     | Item 3                     |
 
-| Feature                                   | Supported?\(Yes/No\) | Notes |
-| :---------------------------------------- | :------------------- | :---- |
-| Full Refresh Overwrite Sync               | Yes                  |       |
-| Full Refresh Append Sync                  | Yes                  |       |
-| Incremental - Append Sync                 | Yes                  |       |
-| Incremental - Append + Deduplication Sync | Yes                  |       |
-| Namespaces                                | No                   |       |
+## Limitations & Troubleshooting
 
-### Performance considerations
+<details>
+<summary>
 
-Rate limit varies across Linnworks API endpoint. See the endpoint documentation to learn more. Rate limited requests will receive a 429 response. The Linnworks connector should not run into Linnworks API limitations under normal usage.
+Expand to see details about Linnworks connector limitations and troubleshooting
 
-## Getting started
+</summary>
 
-### Authentication
+### Rate limits
 
-Linnworks platform has two portals: seller and developer. First, to create API credentials, log in to the [developer portal](https://developer.linnworks.com) and create an application of type `System Integration`. Then click on provided Installation URL and proceed with an installation wizard. The wizard will show a token that you will need for authentication. The installed application will be present on your account on [seller portal](https://login.linnworks.net/).
+Rate limits for the Linnworks API vary across endpoints. Use the [links in the **Supported Streams** table](#supported-streams-and-sync-modes) 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.
 
-Authentication credentials can be obtained on developer portal section Applications -> _Your application name_ -> Edit -> General. And the token, if you missed it during the install, can be obtained anytime under the section Applications -> _Your application name_ -> Installs.
+</details>
 
 ## Changelog