Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

Stock /GetStockItemsByKey

Allows 250 calls per minute

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.

Permissions

GlobalPermissions.Inventory.Stock.StockReadNode

Example Request

The following request format is required for this method.

Endpoint URL

GET | POST https://eu-ext.linnworks.net/api/Stock/GetStockItemsByKey

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

stockIdentifier={
  "Key": "sample string 1",
  "LocationId": "a6cd227d-b1cc-4fbc-a38c-c0b21a1a11ad"
}

Response

This is an example of the response JSON. Results will 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",
    "IsVariationParent": true,
    "isBatchedStockType": false,
    "PurchasePrice": 11.1,
    "RetailPrice": 1.1,
    "TaxRate": 12.1,
    "PostalServiceId": "5f4815bd-2446-40d1-b451-03b7b3d0e31b",
    "PostalServiceName": "sample string 14",
    "CategoryId": "df85ddef-87e2-4bbc-9cab-999fffaa7173",
    "CategoryName": "sample string 16",
    "PackageGroupId": "aae263ac-d000-4203-9bba-15f0f9dffc12",
    "PackageGroupName": "sample string 18",
    "Height": 19.1,
    "Width": 20.1,
    "Depth": 21.1,
    "Weight": 22.1,
    "CreationDate": "2022-08-03T16:02:31.7205717+01:00",
    "InventoryTrackingType": 23,
    "BatchNumberScanRequired": true,
    "SerialNumberScanRequired": true,
    "StockItemId": "0cab4d0f-43d2-4152-ab8f-b4c9b3adcfdc",
    "StockItemIntId": 27
  }
]