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": "b719a42c-6dec-4e4d-9a4e-debe01674ed3"
}

Response

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

[
  {
    "Quantity": 1,
    "InOrder": 2,
    "Due": 3,
    "MinimumLevel": 4,
    "Available": -1,
    "CreationDate": "2018-10-03T11:12:34.5525466+01:00",
    "IsCompositeParent": true,
    "ItemNumber": "sample string 5",
    "ItemTitle": "sample string 6",
    "BarcodeNumber": "sample string 7",
    "MetaData": "sample string 8",
    "isBatchedStockType": false,
    "PurchasePrice": 9.1,
    "RetailPrice": 1.1,
    "TaxRate": 10.1,
    "PostalServiceId": "7fe448ee-94c2-49e4-9a4a-c9ba39097f8a",
    "PostalServiceName": "sample string 12",
    "CategoryId": "a3c29c2b-f8c4-48c8-b8c9-721797dd6efd",
    "CategoryName": "sample string 14",
    "PackageGroupId": "71430b24-cc89-4d39-8263-6a294d4b4f10",
    "PackageGroupName": "sample string 16",
    "Height": 17.1,
    "Width": 18.1,
    "Depth": 19.1,
    "Weight": 20.1,
    "InventoryTrackingType": 21,
    "BatchNumberScanRequired": true,
    "SerialNumberScanRequired": true,
    "StockItemId": "745a53af-6391-4cdd-939c-10006b45f9fc"
  },
  {
    "Quantity": 1,
    "InOrder": 2,
    "Due": 3,
    "MinimumLevel": 4,
    "Available": -1,
    "CreationDate": "2018-10-03T11:12:34.5525466+01:00",
    "IsCompositeParent": true,
    "ItemNumber": "sample string 5",
    "ItemTitle": "sample string 6",
    "BarcodeNumber": "sample string 7",
    "MetaData": "sample string 8",
    "isBatchedStockType": false,
    "PurchasePrice": 9.1,
    "RetailPrice": 1.1,
    "TaxRate": 10.1,
    "PostalServiceId": "7fe448ee-94c2-49e4-9a4a-c9ba39097f8a",
    "PostalServiceName": "sample string 12",
    "CategoryId": "a3c29c2b-f8c4-48c8-b8c9-721797dd6efd",
    "CategoryName": "sample string 14",
    "PackageGroupId": "71430b24-cc89-4d39-8263-6a294d4b4f10",
    "PackageGroupName": "sample string 16",
    "Height": 17.1,
    "Width": 18.1,
    "Depth": 19.1,
    "Weight": 20.1,
    "InventoryTrackingType": 21,
    "BatchNumberScanRequired": true,
    "SerialNumberScanRequired": true,
    "StockItemId": "745a53af-6391-4cdd-939c-10006b45f9fc"
  }
]