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.

Get

Endpoint URL

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

GET https://eu-ext.linnworks.net/api/Stock/GetStockItems?keyWord=sample%20string%201&locationId=57008948-c7f7-47b6-98cc-8d56361f2fe7&entriesPerPage=1&pageNumber=1&excludeComposites=true&excludeVariations=true&excludeBatches=true

Headers

Connection: keep-alive
Accept: application/json
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Post

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=57008948-c7f7-47b6-98cc-8d56361f2fe7&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": "a3b309f1-966f-4c22-8620-ab54c57a1394",
      "PostalServiceName": "sample string 13",
      "CategoryId": "dbe94526-356a-496a-860a-ad30e089b0dd",
      "CategoryName": "sample string 15",
      "PackageGroupId": "37e24ad0-c9a6-46a7-bfe0-4543c5d665f4",
      "PackageGroupName": "sample string 17",
      "Height": 18.1,
      "Width": 19.1,
      "Depth": 20.1,
      "Weight": 21.1,
      "CreationDate": "2022-01-13T12:45:46.1409096+00:00",
      "InventoryTrackingType": 22,
      "BatchNumberScanRequired": true,
      "SerialNumberScanRequired": true,
      "StockItemId": "fe8c633f-6662-4c9b-ad99-ddc855bc397c",
      "StockItemIntId": 26
    }
  ]
}