Skip to main content

Linnworks API Endpoints

The Linnworks API endpoints the iPaaS.com integration uses, grouped by entity, for firewall, troubleshooting, and deprecation reference.

This article lists the Linnworks API endpoints the iPaaS.com integration calls, grouped by entity. Use it as a reference for firewall allow-listing, troubleshooting, and checking whether the integration is affected when Linnworks publishes an API change.

API Endpoints Intro

The Linnworks API is a REST API. Requests use JSON, and most operations are sent with the POST method.

Data requests are sent to the region-specific base URL configured in your subscription's API Url setting — for example, https://eu-ext.linnworks.net/api for EU-hosted accounts. Throughout this article, [Base URL] stands for that value. Authorization is handled separately by a fixed Linnworks authorization server (see Authorization Endpoint below).

For full request and response details, see the Linnworks API documentation at https://apidocs.linnworks.net.

Table of Contents

  • Order Endpoints

  • Inventory and Product Endpoints

  • Stock Endpoints

  • Postal Service Endpoints

  • Authorization Endpoint

Order Endpoints

Search Orders (POST)

[Base URL]/OpenOrders/SearchOrders

Finds an open order from a search term (such as an order number) so it can be retrieved by its identifier.

Get Open Orders (POST)

[Base URL]/OpenOrders/GetOpenOrders

Retrieves pages of open orders. Used to detect new and updated orders on the polling schedule.

Get Open Order Details (POST)

[Base URL]/OpenOrders/GetOpenOrdersDetails

Retrieves the full details of one or more open orders, including line items, addresses, and totals.

Get Order Notes (POST)

[Base URL]/Orders/GetOrderNotes

Retrieves the notes attached to an order.

Set Order Shipping Info (POST)

[Base URL]/Orders/SetOrderShippingInfo

Sets or updates the shipping and tracking information on an order.

Inventory and Product Endpoints

Get Inventory Item by SKU (GET)

[Base URL]/Inventory/GetInventoryItem?sKU={SKU}

Retrieves a single inventory item (product) by its SKU.

Add Inventory Item (POST)

[Base URL]/Inventory/AddInventoryItem

Creates a new inventory item (product or variant) in Linnworks.

Update Inventory Item (POST)

[Base URL]/Inventory/UpdateInventoryItem

Updates an existing inventory item (product or variant) in Linnworks.

Get Categories (GET)

[Base URL]/Inventory/GetCategories

Retrieves the list of product categories, used to match a category name to its Linnworks category.

Get Stock Locations (GET)

[Base URL]/Inventory/GetStockLocations

Retrieves the list of stock locations, used to match a location name to its Linnworks location.

Stock Endpoints

Get Stock Items (GET)

[Base URL]/Stock/GetStockItemsFull

Retrieves full stock item details.

Set Stock Level (POST)

[Base URL]/Stock/SetStockLevel

Sets the stock level for a product or variant at a location.

Create Variation Group (POST)

[Base URL]/Stock/CreateVariationGroup

Creates a variation group (a parent product that groups its variants).

Add Variation Items (POST)

[Base URL]/Stock/AddVariationItems

Adds variant items to a variation group.

Postal Service Endpoints

Get Postal Services (GET)

[Base URL]/PostalServices/GetPostalServices

Retrieves the list of postal services, used to match a postal service name to its Linnworks service.

Authorization Endpoint

Authorize by Application (POST)

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

Exchanges the Application Id, Application Secret, and installation token for an access token used to authorize all subsequent data requests. This authorization server is fixed and is not region-specific.

Related Documents

Did this answer your question?