Used to get inventory information at a basic level
Name | Type | Description |
---|---|---|
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 | Int32 | The amount of entries you require. Maximum 200. |
pageNumber | Int32 | The current page number you are requesting |
dataRequirements | List<StockInformationDataRequirement> | The data you require. eg. StockLevels will load the stock levels for each location |
searchTypes | List<StockInformationSearchType> | The parameters that you would like to search by |
The following request format is required for this method.
GET | POST https://eu-ext.linnworks.net/api/Stock/GetStockItemsFull
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
This is an example of the request structure. Results will vary depending on your data.
keyword=sample string 1&loadCompositeParents=true&loadVariationParents=true&entriesPerPage=1&pageNumber=1&dataRequirements=[
0
]&searchTypes=[
0
]
This is an example of the response JSON. Results will vary depending on your data.
[
{
"Suppliers": [
{
"IsDefault": true,
"Supplier": "sample string 2",
"SupplierID": "7a81fc6d-6adb-4406-88b8-f7aedac22b7d",
"Code": "sample string 4",
"SupplierBarcode": "sample string 5",
"LeadTime": 6,
"PurchasePrice": 7.1,
"MinPrice": 8.1,
"MaxPrice": 9.1,
"AveragePrice": 10.1,
"AverageLeadTime": 11.1,
"SupplierMinOrderQty": 12,
"SupplierPackSize": 13,
"SupplierCurrency": "sample string 14",
"StockItemId": "410aeaca-7788-49e4-b881-b6f586a5313c",
"StockItemIntId": 16
}
],
"StockLevels": [
{
"Location": {
"StockLocationId": "c2146c19-3fba-4fbc-8a6a-7a7f331e48e7",
"StockLocationIntId": 2,
"LocationName": "sample string 3",
"IsFulfillmentCenter": true,
"LocationTag": "sample string 5",
"BinRack": "sample string 6",
"IsWarehouseManaged": true
},
"StockLevel": 1,
"StockValue": 2.1,
"MinimumLevel": 3,
"InOrderBook": 4,
"Due": 5,
"JIT": true,
"InOrders": 4,
"Available": -3,
"UnitCost": 2.1,
"SKU": "sample string 7",
"AutoAdjust": true,
"LastUpdateDate": "2023-01-10T13:49:55.0340899+00:00",
"LastUpdateOperation": "sample string 10",
"rowid": "dfb24fb9-ccc5-41c5-8512-3f7ce66c9bde",
"PendingUpdate": true,
"StockItemPurchasePrice": 13.1,
"StockItemId": "bfeeb3b7-4164-4ff3-b80d-61e4fbbc0e62",
"StockItemIntId": 15
}
],
"ItemChannelDescriptions": [],
"ItemExtendedProperties": [],
"ItemChannelTitles": [],
"ItemChannelPrices": [],
"Images": [
{
"Source": "sample string 1",
"FullSource": "sample string 2",
"CheckSumValue": "sample string 3",
"pkRowId": "50bea1f9-e385-494f-af4e-79d3cf5fb7d9",
"IsMain": true,
"SortOrder": 6,
"ChecksumValue": "sample string 7",
"RawChecksum": "sample string 8",
"StockItemId": "61334f09-7636-474a-b279-bab09b678edd",
"StockItemIntId": 10
}
],
"ItemNumber": "sample string 1",
"ItemTitle": "sample string 2",
"BarcodeNumber": "sample string 3",
"MetaData": "sample string 4",
"IsVariationParent": true,
"isBatchedStockType": false,
"PurchasePrice": 6.1,
"RetailPrice": 1.1,
"TaxRate": 7.1,
"PostalServiceId": "09e15118-5d49-4ed8-88d4-2dc28c679f27",
"PostalServiceName": "sample string 9",
"CategoryId": "10ea52b6-435e-4e24-be02-c14b0fabf723",
"CategoryName": "sample string 11",
"PackageGroupId": "3b4de4f2-2718-427d-9113-bb4f5e512b90",
"PackageGroupName": "sample string 13",
"Height": 14.1,
"Width": 15.1,
"Depth": 16.1,
"Weight": 17.1,
"CreationDate": "2023-01-10T13:49:55.0330875+00:00",
"InventoryTrackingType": 18,
"BatchNumberScanRequired": true,
"SerialNumberScanRequired": true,
"StockItemId": "d3aa46d5-6e1d-4428-8219-22d1ff6e558d",
"StockItemIntId": 22
}
]