---
title: "GetStockItemsFull"
method: POST
path: "/api/Stock/GetStockItemsFull"
tags: ["Stock"]
---

# GetStockItemsFull

`POST /api/Stock/GetStockItemsFull`

## Request

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

Used to get inventory information at a basic level
<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

## Request body

- StockGetStockItemsFullRequest
  - `keyword` string: Your seearch term
  - `loadCompositeParents` boolean: Whether you want to load composite parents or ignore them
  - `loadVariationParents` boolean: Whether you want to load variation parents
  - `entriesPerPage` integer: The amount of entries you require. Maximum 200.
  - `pageNumber` integer: The current page number you are requesting
  - `dataRequirements` string[]: The data you require. eg. StockLevels will load the stock levels for each location
  - `searchTypes` string[]: The parameters that you would like to search by

## Response `200`

OK

- StockItemFull[]
  - `Suppliers` StockItemSupplierStat[]: Suppliers
    - `IsDefault` boolean: If supplier information is default
    - `Supplier` string: Supplier name
    - `SupplierID` string, uuid: Supplier ID
    - `Code` string: Supplier code
    - `SupplierBarcode` string: Supplier barcode
    - `LeadTime` integer: Supplier lead time
    - `PurchasePrice` number, double: Supplier purchase price
    - `MinPrice` number, double: Minimum price
    - `MaxPrice` number, double: Maximum price
    - `AveragePrice` number, double: Average price
    - `AverageLeadTime` number, double: Average lead time
    - `SupplierMinOrderQty` integer: Minimum order quantity from this supplier
    - `SupplierPackSize` integer: Supplier pack size
    - `SupplierCurrency` string: Supplier's default currency
    - `StockItemId` string, uuid: Stock Item Id
    - `StockItemIntId` integer: Stock Item interger Id
  - `StockLevels` StockItemLevel[]: Stock Levels
    - `Location` InventoryStockLocation
      - `StockLocationId` string, uuid
      - `StockLocationIntId` integer
      - `LocationName` string
      - `LocationTag` string
      - `IsFulfillmentCenter` boolean
      - `IsWarehouseManaged` boolean
      - `BinRack` string
    - `StockLevel` integer: Stock level
    - `StockValue` number, double: Stock value
    - `MinimumLevel` integer: Minimum level
    - `InOrderBook` integer: Currently in open orders
    - `Due` integer: Due to come in purchase orders
    - `JIT` boolean: Stock Item Just In Time (JIT) status
    - `InOrders` integer: Currently in open orders
    - `Available` integer: StockLevel - InOrders
    - `UnitCost` number, double: if( Quantity == 0 ) dbo.StockItem.PurchasePrice Else CurrentStockValue / Quantity
    - `SKU` string: Product SKU
    - `AutoAdjust` boolean: If level is auto adjusted
    - `LastUpdateDate` string, date-time: Last time stock level was adjusted
    - `LastUpdateOperation` string: Name of last update operation
    - `rowid` string, uuid: dbo.StockLevel.rowid
    - `PendingUpdate` boolean: dbo.StockLevel.PendingUpdate
    - `StockItemPurchasePrice` number, double: Stock item purchase price. It's used to calculate UnitCost
    - `StockItemId` string, uuid: Stock Item Id
    - `StockItemIntId` integer: Stock Item interger Id
  - `ItemChannelDescriptions` StockItemDescription[]: List of item descriptions
    - `pkRowId` string, uuid: Record row ID (generate random GUID)
    - `Source` string: ChannelName/Source (e.g. EBAY)
    - `SubSource` string: Channel subsource (e.g EBAY1)
    - `Description` string: Product description
    - `StockItemId` string, uuid: Stock Item Id
    - `StockItemIntId` integer: Stock Item interger Id
  - `ItemExtendedProperties` StockItemExtendedProperty[]: List of extended properties
    - `pkRowId` string, uuid: Record row ID (generate random)
    - `fkStockItemId` string, uuid: Stock Item ID
    - `ProperyName` string: Property name
    - `PropertyValue` string: Property value
    - `PropertyType` string: Property type
  - `ItemChannelTitles` StockItemTitle[]: List item titles
    - `pkRowId` string, uuid: Record row id (generate random)
    - `Source` string: ChannelName/Source (e.g. EBAY)
    - `SubSource` string: SubSource (EBAY1)
    - `Title` string: Item title
    - `StockItemId` string, uuid: Stock Item Id
    - `StockItemIntId` integer: Stock Item interger Id
  - `ItemChannelPrices` StockItemPrice[]: List of item prices
    - `Rules` StockItemPricingRule[]: Pricing rule
      - `pkRowId` integer: Record row ID (optional)
      - `fkStockPricingId` string, uuid: Stock pricing ID
      - `Type` string: Type
      - `LowerBound` integer: Lower level
      - `Value` number, double: Value/Price level
    - `pkRowId` string, uuid: Record row ID (generate random)
    - `Source` string: ChannelName/Source (e.g. EBAY)
    - `SubSource` string: SubSource (e.g. EBAY1)
    - `Price` number, double: Channel price
    - `Tag` string: Product price tag
    - `UpdateStatus` 'NoChange' | 'Pending' | 'SentNotConfirmed' | 'Success' | 'Error'
    - `StartDate` string, date-time: Start of sale for sale prices
    - `EndDate` string, date-time: End of sale for sale prices
    - `StockItemId` string, uuid: Stock Item Id
    - `StockItemIntId` integer: Stock Item interger Id
  - `Images` StockItemImage[]: Image urls
    - `Source` string: URL to thumnail image
    - `FullSource` string: Url to full size image
    - `CheckSumValue` string: Image check sum
    - `pkRowId` string, uuid: Unique id of image
    - `IsMain` boolean: Is the image the main image
    - `SortOrder` integer: Sort order for the image
    - `ChecksumValue` string: Internal checksum value
    - `RawChecksum` string: Raw file checksum (Used for UI to determine if the image file is the same before submitting for upload)
    - `StockItemId` string, uuid: Stock Item Id
    - `StockItemIntId` integer: Stock Item interger Id
  - `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)