Back

Search

Search

Methods

Inventory

Orders

Stock /GetStockItems

Response: GenericPagedResult<StockItem>



Use this call to retrieve report about "Found stock items"

Parameters

NameTypeDescription
keyWordString
locationIdNullable<Guid>
entriesPerPageInt32
pageNumberInt32
excludeCompositesBoolean
excludeVariationsBoolean
excludeBatchesBoolean

HTTP Endpoint

Server /Stock / GetStockItems

Permissions


Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/Stock/GetStockItems HTTP/1.1
Host: eu-ext.linnworks.net
Connection: keep-alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.linnworks.net
Accept-Language: en
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Referer: https://www.linnworks.net/
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

keyWord=sample string 1&locationId=761a0daf-a7a9-4a21-a6ce-5f134ffffe89&entriesPerPage=1&pageNumber=1&excludeComposites=true&excludeVariations=true&excludeBatches=true

Response

This is an example response. Results may vary depending on your data.

{
  "PageNumber": 1,
  "EntriesPerPage": 2,
  "TotalEntries": 3,
  "TotalPages": 2,
  "Data": [
    {
      "ItemDescription": "sample string 1",
      "Quantity": 2,
      "InOrder": 3,
      "Due": 4,
      "MinimumLevel": 5,
      "Available": -1,
      "IsCompositeParent": true,
      "ItemNumber": "sample string 6",
      "ItemTitle": "sample string 7",
      "BarcodeNumber": "sample string 8",
      "MetaData": "sample string 9",
      "isBatchedStockType": false,
      "PurchasePrice": 10.1,
      "RetailPrice": 1.1,
      "TaxRate": 11.1,
      "PostalServiceId": "e1c0f55e-8e64-4438-86ae-2556191f9b3d",
      "PostalServiceName": "sample string 13",
      "CategoryId": "a53253f2-3eea-4509-8292-82a6ef2cd6e5",
      "CategoryName": "sample string 15",
      "PackageGroupId": "a6cbaee7-ab86-4590-ad25-637a32eec51b",
      "PackageGroupName": "sample string 17",
      "Height": 18.1,
      "Width": 19.1,
      "Depth": 20.1,
      "Weight": 21.1,
      "CreationDate": "2019-11-28T09:46:00.5844279+00:00",
      "InventoryTrackingType": 22,
      "BatchNumberScanRequired": true,
      "SerialNumberScanRequired": true,
      "StockItemId": "933d3b89-a86a-4186-86be-6788575dc6e5",
      "StockItemIntId": 26
    },
    {
      "ItemDescription": "sample string 1",
      "Quantity": 2,
      "InOrder": 3,
      "Due": 4,
      "MinimumLevel": 5,
      "Available": -1,
      "IsCompositeParent": true,
      "ItemNumber": "sample string 6",
      "ItemTitle": "sample string 7",
      "BarcodeNumber": "sample string 8",
      "MetaData": "sample string 9",
      "isBatchedStockType": false,
      "PurchasePrice": 10.1,
      "RetailPrice": 1.1,
      "TaxRate": 11.1,
      "PostalServiceId": "e1c0f55e-8e64-4438-86ae-2556191f9b3d",
      "PostalServiceName": "sample string 13",
      "CategoryId": "a53253f2-3eea-4509-8292-82a6ef2cd6e5",
      "CategoryName": "sample string 15",
      "PackageGroupId": "a6cbaee7-ab86-4590-ad25-637a32eec51b",
      "PackageGroupName": "sample string 17",
      "Height": 18.1,
      "Width": 19.1,
      "Depth": 20.1,
      "Weight": 21.1,
      "CreationDate": "2019-11-28T09:46:00.5844279+00:00",
      "InventoryTrackingType": 22,
      "BatchNumberScanRequired": true,
      "SerialNumberScanRequired": true,
      "StockItemId": "933d3b89-a86a-4186-86be-6788575dc6e5",
      "StockItemIntId": 26
    }
  ]
}