GET api/v1/partner/inventory/stockcode/{stockcode}

Retrieves the Warehouse Inventory level for a given StockCode

Request Information

URI Parameters

Name	Description	Type	Additional information
stockcode	StockCode	string	Required

Body Parameters

None.

Response Information

Resource Description

List of ApiItemWHSummary objects

Collection of ApiItemWHSummary

Name	Description	Type	Additional information
Pkid	Pkid	integer	None.
WhCode	WhCode	string	None.
StockCode	StockCode	string	None.
StockDesc	StockDesc	string	None.
BookedQty	BookedQty	decimal number	None.
OnHandQty	OnHandQty	decimal number	None.
AllocatedQty	AllocatedQty	decimal number	None.
InTransitQty	InTransitQty	decimal number	None.
InspectionQty	InspectionQty	decimal number	None.
RMAQty	RMAQty	decimal number	None.
ReservedQty	ReservedQty	decimal number	None.
AvailableQty	AvailableQty	decimal number	None.
BackOrderQty	BackOrderQty	decimal number	None.
Status	Status	string	None.
AltStockCode	AltStockCode	string	None.
AltStockDesc	AltStockDesc	string	None.
MiscInfo1	MiscInfo1	string	None.
MiscInfo2	MiscInfo2	string	None.
MiscInfo3	MiscInfo3	string	None.
MiscInfo4	MiscInfo4	string	None.
DateLastMove	DateLastMove	date	None.
DateLastOrder	DateLastOrder	date	None.
DateLastCount	DateLastCount	date	None.
DateLastShipped	DateLastShipped	date	None.
OnPOQty	OnPOQty	decimal number	None.
MinQty	MinQty	decimal number	None.
MaxQty	MaxQty	decimal number	None.
UOM	UOM	string	None.
Barcode	Barcode	string	None.
Owner	Owner	string	None.
OnHold	OnHold	boolean	None.
OnHoldReason	HoldReason	string	None.
InspectAllocQty	InspectAllocQty	decimal number	None.
InspectRsrvQty	InspectRsrvQty	decimal number	None.
InspectionAvailableQty	InspectionAvailableQty	decimal number	None.
StoreRule	StoreRule	string	None.
UnitCost	UnitCost	decimal number	None.
UnitPrice	UnitPrice	decimal number	None.
AltUnitPrice1	AltUnitPrice1	decimal number	None.
AltUnitPrice2	AltUnitPrice2	decimal number	None.
AlertOnMinSent	AlertOnMinSent	boolean	None.
IsSubWarehouse	IsSubWarehouse	boolean	None.
SubWarehouseQty	SubWarehouseQty	decimal number	None.
WhParent	WhParent	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Pkid": 43242,
    "WhCode": "TF",
    "StockCode": "PL-SUP20",
    "StockDesc": "Destinator 3 Pocket PC NA Upgrade",
    "BookedQty": 1.0,
    "OnHandQty": 10.0,
    "AllocatedQty": 1.0,
    "InTransitQty": 0.0,
    "InspectionQty": 1.0,
    "RMAQty": 0.0,
    "ReservedQty": 0.0,
    "AvailableQty": 8.0,
    "BackOrderQty": 0.0,
    "Status": "OK",
    "AltStockCode": "PL-SUP20",
    "AltStockDesc": "Destinator 3 Pocket PC NA Upgrade",
    "MiscInfo1": null,
    "MiscInfo2": null,
    "MiscInfo3": null,
    "MiscInfo4": null,
    "DateLastMove": "1754-01-01T00:00:00",
    "DateLastOrder": "2026-04-12T08:38:06.0828744-04:00",
    "DateLastCount": "1754-01-01T00:00:00",
    "DateLastShipped": "2026-04-14T08:38:06.0828744-04:00",
    "OnPOQty": 0.0,
    "MinQty": 5.0,
    "MaxQty": 20.0,
    "UOM": "EA",
    "Barcode": "154645633531",
    "Owner": "TESTCUST1",
    "OnHold": false,
    "OnHoldReason": null,
    "OldHoldReason": null,
    "InspectAllocQty": 0.0,
    "InspectRsrvQty": 0.0,
    "InspectionAvailableQty": 0.0,
    "StoreRule": null,
    "UnitCost": 0.0,
    "UnitPrice": 0.0,
    "AltUnitPrice1": 0.0,
    "AltUnitPrice2": 0.0,
    "AlertOnMinSent": false,
    "IsSubWarehouse": false,
    "SubWarehouseQty": 0.0,
    "WhParent": null,
    "IsEmpty": false,
    "Deleted": false,
    "GetDateTimeMinimum": "1754-01-01T00:00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfApiItemWHSummary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Duplium.DFS3.Data.ApiEntity">
  <ApiItemWHSummary>
    <AlertOnMinSent>false</AlertOnMinSent>
    <AllocatedQty>1</AllocatedQty>
    <AltStockCode>PL-SUP20</AltStockCode>
    <AltStockDesc>Destinator 3 Pocket PC NA Upgrade</AltStockDesc>
    <AltUnitPrice1>0</AltUnitPrice1>
    <AltUnitPrice2>0</AltUnitPrice2>
    <AvailableQty>8</AvailableQty>
    <BackOrderQty>0</BackOrderQty>
    <Barcode>154645633531</Barcode>
    <BookedQty>1</BookedQty>
    <DateLastCount>1754-01-01T00:00:00</DateLastCount>
    <DateLastMove>1754-01-01T00:00:00</DateLastMove>
    <DateLastOrder>2026-04-12T08:38:06.0828744-04:00</DateLastOrder>
    <DateLastShipped>2026-04-14T08:38:06.0828744-04:00</DateLastShipped>
    <InTransitQty>0</InTransitQty>
    <InspectAllocQty>0</InspectAllocQty>
    <InspectRsrvQty>0</InspectRsrvQty>
    <InspectionAvailableQty>0</InspectionAvailableQty>
    <InspectionQty>1</InspectionQty>
    <IsSubWarehouse>false</IsSubWarehouse>
    <MaxQty>20</MaxQty>
    <MinQty>5</MinQty>
    <MiscInfo1 i:nil="true" />
    <MiscInfo2 i:nil="true" />
    <MiscInfo3 i:nil="true" />
    <MiscInfo4 i:nil="true" />
    <OnHandQty>10</OnHandQty>
    <OnHold>false</OnHold>
    <OnHoldReason i:nil="true" />
    <OnPOQty>0</OnPOQty>
    <Owner>TESTCUST1</Owner>
    <Pkid>43242</Pkid>
    <RMAQty>0</RMAQty>
    <ReservedQty>0</ReservedQty>
    <Status>OK</Status>
    <StockCode>PL-SUP20</StockCode>
    <StockDesc>Destinator 3 Pocket PC NA Upgrade</StockDesc>
    <StoreRule i:nil="true" />
    <SubWarehouseQty>0</SubWarehouseQty>
    <UOM>EA</UOM>
    <UnitCost>0</UnitCost>
    <UnitPrice>0</UnitPrice>
    <WhCode>TF</WhCode>
    <WhParent i:nil="true" />
  </ApiItemWHSummary>
</ArrayOfApiItemWHSummary>