Back

Search

Search

Methods

Inventory

Orders

Stock /GetStockItemsFull

Response: List<StockItemFull>



Used to get inventory information at a basic level

Parameters

NameTypeDescription
keywordStringYour seearch term
loadCompositeParentsBooleanWhether you want to load composite parents or ignore them
loadVariationParentsBooleanWhether you want to load variation parents
entriesPerPageInt32The amount of entries you require. Maximum 200.
pageNumberInt32The current page number you are requesting
dataRequirementsList<StockInformationDataRequirement>The data you require. eg. StockLevels will load the stock levels for each location
searchTypesList<StockInformationSearchType>The parameters that you would like to search by

HTTP Endpoint

Server /Stock / GetStockItemsFull

Permissions


Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/Stock/GetStockItemsFull HTTP/1.1
Host: eu-ext.linnworks.net
Connection: keep-alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.linnworks.net
Accept-Language: en
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Referer: https://www.linnworks.net/
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

keyword=sample string 1&loadCompositeParents=true&loadVariationParents=true&entriesPerPage=1&pageNumber=1&dataRequirements=[
  0,
  0
]&searchTypes=[
  0,
  0
]

Response

This is an example response. Results may vary depending on your data.

[
  {
    "Suppliers": [
      {
        "IsDefault": true,
        "Supplier": "sample string 2",
        "SupplierID": "bff1672a-b898-4757-b9ca-0048812ae969",
        "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": "523dae09-45d8-40f2-a8ee-ce349fbd4fbf"
      },
      {
        "IsDefault": true,
        "Supplier": "sample string 2",
        "SupplierID": "bff1672a-b898-4757-b9ca-0048812ae969",
        "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": "523dae09-45d8-40f2-a8ee-ce349fbd4fbf"
      }
    ],
    "StockLevels": [
      {
        "Location": {
          "StockLocationId": "d0522db6-6c2e-45ca-addd-b9afbe39a902",
          "LocationName": "sample string 2",
          "IsFulfillmentCenter": true,
          "LocationTag": "sample string 4",
          "BinRack": "sample string 5",
          "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": "2018-10-03T11:12:34.5665561+01:00",
        "LastUpdateOperation": "sample string 10",
        "rowid": "7e15169e-8fb2-47ee-a14d-0fc0b8d21ca2",
        "PendingUpdate": true,
        "StockItemPurchasePrice": 13.1,
        "StockItemId": "eec9be52-ffd3-4dd8-a399-6a525ebcf03b"
      },
      {
        "Location": {
          "StockLocationId": "d0522db6-6c2e-45ca-addd-b9afbe39a902",
          "LocationName": "sample string 2",
          "IsFulfillmentCenter": true,
          "LocationTag": "sample string 4",
          "BinRack": "sample string 5",
          "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": "2018-10-03T11:12:34.5665561+01:00",
        "LastUpdateOperation": "sample string 10",
        "rowid": "7e15169e-8fb2-47ee-a14d-0fc0b8d21ca2",
        "PendingUpdate": true,
        "StockItemPurchasePrice": 13.1,
        "StockItemId": "eec9be52-ffd3-4dd8-a399-6a525ebcf03b"
      }
    ],
    "ItemChannelDescriptions": [],
    "ItemExtendedProperties": [],
    "ItemChannelTitles": [],
    "ItemChannelPrices": [],
    "Images": [
      {
        "Source": "sample string 1",
        "FullSource": "sample string 2",
        "CheckSumValue": "sample string 3",
        "pkRowId": "afd1f106-e084-4eaa-a71a-803121e96444",
        "IsMain": true,
        "SortOrder": 6,
        "StockItemId": "7bdce63e-9f09-4007-aaf8-8e456c46eded"
      },
      {
        "Source": "sample string 1",
        "FullSource": "sample string 2",
        "CheckSumValue": "sample string 3",
        "pkRowId": "afd1f106-e084-4eaa-a71a-803121e96444",
        "IsMain": true,
        "SortOrder": 6,
        "StockItemId": "7bdce63e-9f09-4007-aaf8-8e456c46eded"
      }
    ],
    "ItemNumber": "sample string 1",
    "ItemTitle": "sample string 2",
    "BarcodeNumber": "sample string 3",
    "MetaData": "sample string 4",
    "isBatchedStockType": false,
    "PurchasePrice": 5.1,
    "RetailPrice": 1.1,
    "TaxRate": 6.1,
    "PostalServiceId": "237c4391-649e-4c10-82d5-c77bcfe2b4cb",
    "PostalServiceName": "sample string 8",
    "CategoryId": "c900296e-b08f-4c74-b211-f0500cb21546",
    "CategoryName": "sample string 10",
    "PackageGroupId": "65267ae7-90ba-4841-b6aa-055f141f1ed1",
    "PackageGroupName": "sample string 12",
    "Height": 13.1,
    "Width": 14.1,
    "Depth": 15.1,
    "Weight": 16.1,
    "CreationDate": "2018-10-03T11:12:34.5655561+01:00",
    "InventoryTrackingType": 17,
    "BatchNumberScanRequired": true,
    "SerialNumberScanRequired": true,
    "StockItemId": "50e3a539-359f-4b04-ab25-0dbd4629596e"
  },
  {
    "Suppliers": [
      {
        "IsDefault": true,
        "Supplier": "sample string 2",
        "SupplierID": "bff1672a-b898-4757-b9ca-0048812ae969",
        "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": "523dae09-45d8-40f2-a8ee-ce349fbd4fbf"
      },
      {
        "IsDefault": true,
        "Supplier": "sample string 2",
        "SupplierID": "bff1672a-b898-4757-b9ca-0048812ae969",
        "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": "523dae09-45d8-40f2-a8ee-ce349fbd4fbf"
      }
    ],
    "StockLevels": [
      {
        "Location": {
          "StockLocationId": "d0522db6-6c2e-45ca-addd-b9afbe39a902",
          "LocationName": "sample string 2",
          "IsFulfillmentCenter": true,
          "LocationTag": "sample string 4",
          "BinRack": "sample string 5",
          "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": "2018-10-03T11:12:34.5665561+01:00",
        "LastUpdateOperation": "sample string 10",
        "rowid": "7e15169e-8fb2-47ee-a14d-0fc0b8d21ca2",
        "PendingUpdate": true,
        "StockItemPurchasePrice": 13.1,
        "StockItemId": "eec9be52-ffd3-4dd8-a399-6a525ebcf03b"
      },
      {
        "Location": {
          "StockLocationId": "d0522db6-6c2e-45ca-addd-b9afbe39a902",
          "LocationName": "sample string 2",
          "IsFulfillmentCenter": true,
          "LocationTag": "sample string 4",
          "BinRack": "sample string 5",
          "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": "2018-10-03T11:12:34.5665561+01:00",
        "LastUpdateOperation": "sample string 10",
        "rowid": "7e15169e-8fb2-47ee-a14d-0fc0b8d21ca2",
        "PendingUpdate": true,
        "StockItemPurchasePrice": 13.1,
        "StockItemId": "eec9be52-ffd3-4dd8-a399-6a525ebcf03b"
      }
    ],
    "ItemChannelDescriptions": [],
    "ItemExtendedProperties": [],
    "ItemChannelTitles": [],
    "ItemChannelPrices": [],
    "Images": [
      {
        "Source": "sample string 1",
        "FullSource": "sample string 2",
        "CheckSumValue": "sample string 3",
        "pkRowId": "afd1f106-e084-4eaa-a71a-803121e96444",
        "IsMain": true,
        "SortOrder": 6,
        "StockItemId": "7bdce63e-9f09-4007-aaf8-8e456c46eded"
      },
      {
        "Source": "sample string 1",
        "FullSource": "sample string 2",
        "CheckSumValue": "sample string 3",
        "pkRowId": "afd1f106-e084-4eaa-a71a-803121e96444",
        "IsMain": true,
        "SortOrder": 6,
        "StockItemId": "7bdce63e-9f09-4007-aaf8-8e456c46eded"
      }
    ],
    "ItemNumber": "sample string 1",
    "ItemTitle": "sample string 2",
    "BarcodeNumber": "sample string 3",
    "MetaData": "sample string 4",
    "isBatchedStockType": false,
    "PurchasePrice": 5.1,
    "RetailPrice": 1.1,
    "TaxRate": 6.1,
    "PostalServiceId": "237c4391-649e-4c10-82d5-c77bcfe2b4cb",
    "PostalServiceName": "sample string 8",
    "CategoryId": "c900296e-b08f-4c74-b211-f0500cb21546",
    "CategoryName": "sample string 10",
    "PackageGroupId": "65267ae7-90ba-4841-b6aa-055f141f1ed1",
    "PackageGroupName": "sample string 12",
    "Height": 13.1,
    "Width": 14.1,
    "Depth": 15.1,
    "Weight": 16.1,
    "CreationDate": "2018-10-03T11:12:34.5655561+01:00",
    "InventoryTrackingType": 17,
    "BatchNumberScanRequired": true,
    "SerialNumberScanRequired": true,
    "StockItemId": "50e3a539-359f-4b04-ab25-0dbd4629596e"
  }
]