v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB

Inventory

GetInventoryItem

Gets stock item details by either the SKU or StockItemId The stock item id is supplied, it is used as the primary identifier If both stock item id and SKU are supplied, an exception will be thrown if they dont relate to the same Linnworks item Rate limit: 150 / minute

get/api/Inventory/GetInventoryItem

Query parameters

stockItemIdstring uuid

The Linnworks stock item id. Used in preference over SKU when supplied If not supplied, the SKU will be used

sKUstring

The SKU for the item. Only used when StockItemId is not supplied

Response

VariationGroupNamestring

Variation parent group name

ItemDescriptionstring

Item Description(Metadata)

Quantityinteger

Quantity in stock

InOrderinteger

Quantity in order book

Dueinteger

Quantity due in purchase orders

MinimumLevelinteger

Minimum level of stock item. -1 is not tracked. Null value when adding will use user default minimum level

Availableinteger

Available level. Quantity - InOrder

IsCompositeParentboolean

Item is a composite parent

ShippedSeparatelyboolean

ItemNumberstring

SKU

ItemTitlestring

Item title

BarcodeNumberstring

Barcode number

MetaDatastring

Item description

IsVariationParentboolean

Is Variation Parent

isBatchedStockTypeboolean

Returns true is the stock item is tracked by batch

PurchasePricenumber double

Default item purchase price

RetailPricenumber double

Default item retail price

TaxRatenumber double

Default item tax rate. Set -1 to use country tax rate

PostalServiceIdstring uuid

Default postal service id

PostalServiceNamestring

Default postal service name

CategoryIdstring uuid

Default category id

CategoryNamestring

Default category name

PackageGroupIdstring uuid

Default package group id

PackageGroupNamestring

Default package group name

Heightnumber double

Item height

Widthnumber double

Item width

Depthnumber double

Item depth

Weightnumber double

Item weight

CreationDatestring date-time

Stock item creation date

InventoryTrackingTypeinteger

Stock item tracking type. 0 = none. 1 = Ordered by Sell by Date. 2 = Ordered by Priority Sequence

BatchNumberScanRequiredboolean

User must scan batch number when procesing orders

SerialNumberScanRequiredboolean

User must scan item serial number when processing ordesr

StockItemIdstring uuid

Stock Item Id

StockItemIntIdinteger

Stock Item interger Id

Example response

{
  "PostalServiceId": "00000000-0000-0000-0000-000000000000",
  "CategoryId": "00000000-0000-0000-0000-000000000000",
  "PackageGroupId": "00000000-0000-0000-0000-000000000000",
  "StockItemId": "00000000-0000-0000-0000-000000000000"
}