Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

Stock /GetStockItemsFull

Allows 250 calls per minute

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

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/Stock/GetStockItemsFull

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&loadCompositeParents=true&loadVariationParents=true&entriesPerPage=1&pageNumber=1&dataRequirements=[
  0
]&searchTypes=[
  0
]

Response

This is an example of the response JSON. Results will vary depending on your data.

[
  {
    "Suppliers": [
      {
        "IsDefault": true,
        "Supplier": "sample string 2",
        "SupplierID": "b6d59480-ce91-4558-8d7a-426e6af42248",
        "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": "0f30c5d5-3068-4996-8fb4-f4f468996d08",
        "StockItemIntId": 16
      }
    ],
    "StockLevels": [
      {
        "Location": {
          "StockLocationId": "6c349f45-6cd9-4b69-997d-e54aec1c1a6f",
          "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": "2021-07-29T09:24:42.7492154+01:00",
        "LastUpdateOperation": "sample string 10",
        "rowid": "6f14f00a-946e-492e-a7a7-535c626be9da",
        "PendingUpdate": true,
        "StockItemPurchasePrice": 13.1,
        "StockItemId": "ed0081a8-acf6-4e31-ab9b-c1f1ebf75e1a",
        "StockItemIntId": 15
      }
    ],
    "ItemChannelDescriptions": [],
    "ItemExtendedProperties": [],
    "ItemChannelTitles": [],
    "ItemChannelPrices": [],
    "Images": [
      {
        "Source": "sample string 1",
        "FullSource": "sample string 2",
        "CheckSumValue": "sample string 3",
        "pkRowId": "94f3dc84-602b-41f0-bb95-6d096dda2108",
        "IsMain": true,
        "SortOrder": 6,
        "ChecksumValue": "sample string 7",
        "RawChecksum": "sample string 8",
        "StockItemId": "e998a07e-5709-4c06-be74-a1728a3efbd1",
        "StockItemIntId": 10
      }
    ],
    "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": "370ed907-8c8a-492e-ad9c-461ac873a62c",
    "PostalServiceName": "sample string 8",
    "CategoryId": "b78f70a0-982d-4765-8752-712a037b05e8",
    "CategoryName": "sample string 10",
    "PackageGroupId": "09424cc9-91bb-4156-85df-ca5ec4c339c8",
    "PackageGroupName": "sample string 12",
    "Height": 13.1,
    "Width": 14.1,
    "Depth": 15.1,
    "Weight": 16.1,
    "CreationDate": "2021-07-29T09:24:42.7482152+01:00",
    "InventoryTrackingType": 17,
    "BatchNumberScanRequired": true,
    "SerialNumberScanRequired": true,
    "StockItemId": "78fe3bb0-2f00-476d-8080-60d395ea3bf4",
    "StockItemIntId": 21
  }
]