Back

Search

Search

Methods

Inventory

Orders

Stock /GetStockItemsByKey

Response: List<StockItem>



Returns a list of Stock Items for the provided key and location

Parameters

NameTypeDescription
stockIdentifierSearch_Stock_ByKeyMade up of a string key, used to search Item Number, Barcode Number, Supplier Code and Supplier Basrcode Fields as well as Stock Location.

HTTP Endpoint

Server /Stock / GetStockItemsByKey

Permissions

GlobalPermissions.Inventory.Stock.StockReadNode

Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/Stock/GetStockItemsByKey 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

stockIdentifier={
  "Key": "sample string 1",
  "LocationId": "bb4a88ee-a7e9-446b-89bb-76593d2a062d"
}

Response

This is an example response. Results may vary depending on your 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": "0ca3f499-fb0f-4027-ab1e-7aa0791f10e1",
    "PostalServiceName": "sample string 13",
    "CategoryId": "9cc85d78-43fc-4981-8840-db1faff0234f",
    "CategoryName": "sample string 15",
    "PackageGroupId": "e40219b1-f867-46e1-8875-63a80b0a8ab1",
    "PackageGroupName": "sample string 17",
    "Height": 18.1,
    "Width": 19.1,
    "Depth": 20.1,
    "Weight": 21.1,
    "CreationDate": "2019-11-28T09:46:00.6003672+00:00",
    "InventoryTrackingType": 22,
    "BatchNumberScanRequired": true,
    "SerialNumberScanRequired": true,
    "StockItemId": "fb12067f-9d12-4618-bc50-1fb1fa44a70a",
    "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": "0ca3f499-fb0f-4027-ab1e-7aa0791f10e1",
    "PostalServiceName": "sample string 13",
    "CategoryId": "9cc85d78-43fc-4981-8840-db1faff0234f",
    "CategoryName": "sample string 15",
    "PackageGroupId": "e40219b1-f867-46e1-8875-63a80b0a8ab1",
    "PackageGroupName": "sample string 17",
    "Height": 18.1,
    "Width": 19.1,
    "Depth": 20.1,
    "Weight": 21.1,
    "CreationDate": "2019-11-28T09:46:00.6003672+00:00",
    "InventoryTrackingType": 22,
    "BatchNumberScanRequired": true,
    "SerialNumberScanRequired": true,
    "StockItemId": "fb12067f-9d12-4618-bc50-1fb1fa44a70a",
    "StockItemIntId": 26
  }
]