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.StockRead.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": "3f830fab-576c-41fb-8373-7ccdd1458844"
}

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-02-19T16:57:07.0255322+00: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": "bf6156e2-3f0e-4996-9c92-1df3558b44d7",
    "PostalServiceName": "sample string 12",
    "CategoryId": "9fee8f35-7658-4f24-8977-bd8bad9aeac8",
    "CategoryName": "sample string 14",
    "PackageGroupId": "60641df4-cf45-4219-973f-4e01c009ef0e",
    "PackageGroupName": "sample string 16",
    "Height": 17.1,
    "Width": 18.1,
    "Depth": 19.1,
    "Weight": 20.1,
    "InventoryTrackingType": 21,
    "BatchNumberScanRequired": true,
    "SerialNumberScanRequired": true,
    "StockItemId": "8e2d711e-0d91-4b6d-92cc-30c7ce41acac"
  },
  {
    "Quantity": 1,
    "InOrder": 2,
    "Due": 3,
    "MinimumLevel": 4,
    "Available": -1,
    "CreationDate": "2018-02-19T16:57:07.0255322+00: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": "bf6156e2-3f0e-4996-9c92-1df3558b44d7",
    "PostalServiceName": "sample string 12",
    "CategoryId": "9fee8f35-7658-4f24-8977-bd8bad9aeac8",
    "CategoryName": "sample string 14",
    "PackageGroupId": "60641df4-cf45-4219-973f-4e01c009ef0e",
    "PackageGroupName": "sample string 16",
    "Height": 17.1,
    "Width": 18.1,
    "Depth": 19.1,
    "Weight": 20.1,
    "InventoryTrackingType": 21,
    "BatchNumberScanRequired": true,
    "SerialNumberScanRequired": true,
    "StockItemId": "8e2d711e-0d91-4b6d-92cc-30c7ce41acac"
  }
]