---
title: "GetStockItems"
method: GET
path: "/api/Stock/GetStockItems"
tags: ["Stock"]
---

# GetStockItems

`GET /api/Stock/GetStockItems`

## Request

- Base URL: `https://eu-ext.linnworks.net`
- URL: `https://eu-ext.linnworks.net/api/Stock/GetStockItems`
- Auth: API key in header `Authorization`

Use this call to retrieve report about "Found stock items"
<b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

## Query parameters

- `keyWord` string
- `locationId` string, uuid
- `entriesPerPage` integer
- `pageNumber` integer
- `excludeComposites` boolean
- `excludeVariations` boolean
- `excludeBatches` boolean

## Response `200`

OK

- GenericPagedResultStockItem: Order item object
  - `PageNumber` integer: Result page number
  - `EntriesPerPage` integer: Result page size, quantity of records per page
  - `TotalEntries` integer: Total records
  - `TotalPages` integer: Total pages
  - `Data` StockItem[]
    - `ItemDescription` string: Item Description(Metadata)
    - `Quantity` integer: Quantity in stock
    - `InOrder` integer: Quantity in order book
    - `Due` integer: Quantity due in purchase orders
    - `MinimumLevel` integer: Minimum level of stock item. -1 is not tracked. Null value when adding will use user default minimum level
    - `Available` integer: Available level. Quantity - InOrder
    - `IsCompositeParent` boolean: Item is a composite parent
    - `ShippedSeparately` boolean
    - `ItemNumber` string: SKU
    - `ItemTitle` string: Item title
    - `BarcodeNumber` string: Barcode number
    - `MetaData` string: Item description
    - `IsVariationParent` boolean: Is Variation Parent
    - `isBatchedStockType` boolean: Returns true is the stock item is tracked by batch
    - `PurchasePrice` number, double: Default item purchase price
    - `RetailPrice` number, double: Default item retail price
    - `TaxRate` number, double: Default item tax rate. Set -1 to use country tax rate
    - `PostalServiceId` string, uuid: Default postal service id
    - `PostalServiceName` string: Default postal service name
    - `CategoryId` string, uuid: Default category id
    - `CategoryName` string: Default category name
    - `PackageGroupId` string, uuid: Default package group id
    - `PackageGroupName` string: Default package group name
    - `Height` number, double: Item height
    - `Width` number, double: Item width
    - `Depth` number, double: Item depth
    - `Weight` number, double: Item weight
    - `CreationDate` string, date-time: Stock item creation date
    - `InventoryTrackingType` integer: Stock item tracking type. 0 = none. 1 = Ordered by Sell by Date. 2 = Ordered by Priority Sequence
    - `BatchNumberScanRequired` boolean: User must scan batch number when procesing orders
    - `SerialNumberScanRequired` boolean: User must scan item serial number when processing ordesr
    - `StockItemId` string, uuid: Stock Item Id
    - `StockItemIntId` integer: Stock Item interger Id

---

[API](https://skmtc.dev/linnworks/apis/stock-api.md) - [All operations](https://skmtc.dev/linnworks/apis/stock-api/llms.txt) - [OpenAPI document](https://skmtc.dev/linnworks/apis/stock-api/revisions/8b0b8312b9c4?raw)