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=29d9a5c3-d70a-4f0b-9823-f25bcd8084aa&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": [
    {
      "Quantity": 1,
      "InOrder": 2,
      "Due": 3,
      "MinimumLevel": 4,
      "Available": -1,
      "CreationDate": "2018-02-19T16:57:07.017513+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": "9ce5fe13-bbbd-431b-a2b5-82b463d83d09",
      "PostalServiceName": "sample string 12",
      "CategoryId": "43ab4d70-fcc1-47b5-82a8-97e8fb3064d9",
      "CategoryName": "sample string 14",
      "PackageGroupId": "0bd49045-d5ce-41fe-8f2b-f0407b22b897",
      "PackageGroupName": "sample string 16",
      "Height": 17.1,
      "Width": 18.1,
      "Depth": 19.1,
      "Weight": 20.1,
      "InventoryTrackingType": 21,
      "BatchNumberScanRequired": true,
      "SerialNumberScanRequired": true,
      "StockItemId": "7a76d164-87a9-4a74-91e0-ddd5b1daff3e"
    },
    {
      "Quantity": 1,
      "InOrder": 2,
      "Due": 3,
      "MinimumLevel": 4,
      "Available": -1,
      "CreationDate": "2018-02-19T16:57:07.017513+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": "9ce5fe13-bbbd-431b-a2b5-82b463d83d09",
      "PostalServiceName": "sample string 12",
      "CategoryId": "43ab4d70-fcc1-47b5-82a8-97e8fb3064d9",
      "CategoryName": "sample string 14",
      "PackageGroupId": "0bd49045-d5ce-41fe-8f2b-f0407b22b897",
      "PackageGroupName": "sample string 16",
      "Height": 17.1,
      "Width": 18.1,
      "Depth": 19.1,
      "Weight": 20.1,
      "InventoryTrackingType": 21,
      "BatchNumberScanRequired": true,
      "SerialNumberScanRequired": true,
      "StockItemId": "7a76d164-87a9-4a74-91e0-ddd5b1daff3e"
    }
  ]
}