Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

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

GET | 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=21094734-5529-4596-88db-75934b5dfb2d&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,
      "ShippedSeparately": true,
      "ItemNumber": "sample string 7",
      "ItemTitle": "sample string 8",
      "BarcodeNumber": "sample string 9",
      "MetaData": "sample string 10",
      "IsVariationParent": true,
      "isBatchedStockType": false,
      "PurchasePrice": 12.1,
      "RetailPrice": 1.1,
      "TaxRate": 13.1,
      "PostalServiceId": "40662b60-1366-443d-93c8-70b3e367fb3a",
      "PostalServiceName": "sample string 15",
      "CategoryId": "70a5cd40-fa82-45f9-8336-97d53a4f20f9",
      "CategoryName": "sample string 17",
      "PackageGroupId": "f45b9b89-1d2e-441c-acae-265807688676",
      "PackageGroupName": "sample string 19",
      "Height": 20.1,
      "Width": 21.1,
      "Depth": 22.1,
      "Weight": 23.1,
      "CreationDate": "2022-09-05T15:10:03.636973+03:00",
      "InventoryTrackingType": 24,
      "BatchNumberScanRequired": true,
      "SerialNumberScanRequired": true,
      "StockItemId": "af47fd41-ec9d-4382-8440-1ce17b387425",
      "StockItemIntId": 28
    }
  ]
}