Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

Stock /GetStockItems

Allows 150 calls per minute

Response: GenericPagedResult<StockItem>



Use this call to retrieve report about "Found stock items"

Parameters

NameTypeDescription
keyWordString
locationIdNullable<Guid>
entriesPerPageInt32
pageNumberInt32
excludeCompositesBoolean
excludeVariationsBoolean
excludeBatchesBoolean

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/Stock/GetStockItems

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.

keyWord=sample string 1&locationId=6dddf1a8-ae02-4497-9be6-ab27ef7c6a73&entriesPerPage=1&pageNumber=1&excludeComposites=true&excludeVariations=true&excludeBatches=true

Response

This is an example of the response JSON. Results will vary depending on your data.

{
  "PageNumber": 1,
  "EntriesPerPage": 2,
  "TotalEntries": 3,
  "TotalPages": 2,
  "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": "9f7b1c0e-becf-4997-b718-45832c5518cd",
      "PostalServiceName": "sample string 13",
      "CategoryId": "202af431-1dc8-4e50-ba44-37ff50cc6fad",
      "CategoryName": "sample string 15",
      "PackageGroupId": "59970c30-1b92-446d-9bc9-2df5f924072e",
      "PackageGroupName": "sample string 17",
      "Height": 18.1,
      "Width": 19.1,
      "Depth": 20.1,
      "Weight": 21.1,
      "CreationDate": "2021-07-29T09:24:42.7312145+01:00",
      "InventoryTrackingType": 22,
      "BatchNumberScanRequired": true,
      "SerialNumberScanRequired": true,
      "StockItemId": "84228963-d2ac-4d6a-9913-9bd9aead6afb",
      "StockItemIntId": 26
    }
  ]
}