POST api/v1/partner/inventory/custId/{custId}/whcode/{whcode}

Retrieve the Warehouse Inventory info for the given Owner and Warehouse Code with optional filtering and paging

Request Information

URI Parameters

Name	Description	Type	Additional information
custId	CustID that owns the Stockcodes	string	Required
whcode	Warehouse Code	string	Required

Body Parameters

Optional ApiItemWHFilters object; To Enable Paging, set PageIndex parameter greater than 0 in the ApiItemWHFilters object

ApiItemWHFilters

Name	Description	Type	Additional information
PageIndex	PageIndex	integer	None.
PageSize	PageSize	integer	None.
StockCode	StockCode	string	None.
AltStockCode	AltStockCode	string	None.
StockDesc	StockDesc	string	None.
AltStoctDesc	AltStoctDesc	string	None.
BarCode	BarCode	string	None.
MiscInfo1	MiscInfo1	string	None.
MiscInfo2	MiscInfo2	string	None.
MiscInfo3	MiscInfo3	string	None.
MiscInfo4	MiscInfo4	string	None.
WithInventory	WithInventory	boolean	None.
Finish	Finish	boolean	None.
Raw	Raw	boolean	None.
Letter	Letter	boolean	None.
Kit	Kit	boolean	None.
Digital	Digital	boolean	None.
SortExpression	SortExpression	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PageIndex": 1,
  "PageSize": 10,
  "StockCode": null,
  "AltStockCode": null,
  "StockDesc": null,
  "AltStoctDesc": null,
  "BarCode": null,
  "MiscInfo1": null,
  "MiscInfo2": null,
  "MiscInfo3": null,
  "MiscInfo4": null,
  "WithInventory": true,
  "Finish": true,
  "Raw": true,
  "Letter": true,
  "Kit": true,
  "Digital": true,
  "SortExpression": null,
  "IsEmpty": false,
  "Deleted": false,
  "GetDateTimeMinimum": "1754-01-01T00:00:00"
}

application/xml, text/xml

Sample:

<ApiItemWHFilters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Duplium.DFS3.Data.ApiEntity">
  <AltStockCode i:nil="true" />
  <AltStoctDesc i:nil="true" />
  <BarCode i:nil="true" />
  <Digital>true</Digital>
  <Finish>true</Finish>
  <Kit>true</Kit>
  <Letter>true</Letter>
  <MiscInfo1 i:nil="true" />
  <MiscInfo2 i:nil="true" />
  <MiscInfo3 i:nil="true" />
  <MiscInfo4 i:nil="true" />
  <PageIndex>1</PageIndex>
  <PageSize>10</PageSize>
  <Raw>true</Raw>
  <SortExpression i:nil="true" />
  <StockCode i:nil="true" />
  <StockDesc i:nil="true" />
  <WithInventory>true</WithInventory>
</ApiItemWHFilters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of ApiItemWHDetail objects

Collection of ApiItemWHDetail

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	InspectQty	decimal number	None.
ReservedQty	ReservedQty	decimal number	None.
Available	Available	decimal number	None.
BackOrderQty	BackOrderQty	decimal number	None.
RMAQty	RMAQty	decimal number	None.
OnPOQty	OnPOQty	decimal number	None.
MinQty	MinQty	decimal number	None.
MaxQty	MaxQty	decimal number	None.
Status	Status	string	None.
AltStockCode	AltStockCode	string	None.
AltStockDesc	AltStockDesc	string	None.
Barcode	Barcode	string	None.
MiscInfo1	MiscInfo1	string	None.
MiscInfo2	MiscInfo2	string	None.
MiscInfo3	MiscInfo3	string	None.
MiscInfo4	MiscInfo4	string	None.
UOM	UOM	string	None.
Owner	Owner	string	None.
OnHold	OnHold	boolean	None.
OnHoldReason	OnHoldReason	string	None.
DateLastOrder	DateLastOrder	date	None.
DateLastCount	DateLastCount	date	None.
DateLastMove	DateLastMove	date	None.
DateLastShipped	DateLastShipped	date	None.
InspectAllocQty	InspectAllocQty	decimal number	None.
InspectRsrvQty	InspectRsrvQty	decimal number	None.
InspectionAvailableQty	InspectionAvailableQty	decimal number	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,
    "ReservedQty": 0.0,
    "Available": 8.0,
    "BackOrderQty": 0.0,
    "RMAQty": 0.0,
    "OnPOQty": 0.0,
    "MinQty": 5.0,
    "MaxQty": 20.0,
    "Status": "OK",
    "AltStockCode": "PL-SUP20",
    "AltStockDesc": "Destinator 3 Pocket PC NA Upgrade",
    "Barcode": "154645633531",
    "MiscInfo1": null,
    "MiscInfo2": null,
    "MiscInfo3": null,
    "MiscInfo4": null,
    "InvtType": null,
    "ProdClass": null,
    "InvtClass": null,
    "UOM": "EA",
    "Owner": "TESTCUST1",
    "UnitCost": 0.0,
    "UnitPrice": 0.0,
    "ReOrderQty": 0.0,
    "OnHold": false,
    "OnHoldReason": null,
    "DateLastOrder": "2026-04-12T08:38:06.0848836-04:00",
    "DateLastCount": "1754-01-01T00:00:00",
    "DateLastMove": "1754-01-01T00:00:00",
    "DateLastShipped": "2026-04-14T08:38:06.0848836-04:00",
    "CurrCode": null,
    "OldHoldReason": null,
    "InspectAllocQty": 0.0,
    "InspectRsrvQty": 0.0,
    "InspectionAvailableQty": 0.0,
    "IsSubWarehouse": false,
    "SubWarehouseQty": 0.0,
    "WhParent": null,
    "IsEmpty": false,
    "Deleted": false,
    "GetDateTimeMinimum": "1754-01-01T00:00:00"
  },
  {
    "Pkid": 43321,
    "WhCode": "TF",
    "StockCode": "AC-300",
    "StockDesc": "Vent Mount Holder",
    "BookedQty": 1.0,
    "OnHandQty": 8.0,
    "AllocatedQty": 0.0,
    "InTransitQty": 0.0,
    "InspectionQty": 2.0,
    "ReservedQty": 0.0,
    "Available": 6.0,
    "BackOrderQty": 0.0,
    "RMAQty": 0.0,
    "OnPOQty": 0.0,
    "MinQty": 5.0,
    "MaxQty": 20.0,
    "Status": "OK",
    "AltStockCode": "AC-300",
    "AltStockDesc": "Vent Mount Holder",
    "Barcode": "154645633481",
    "MiscInfo1": null,
    "MiscInfo2": null,
    "MiscInfo3": null,
    "MiscInfo4": null,
    "InvtType": null,
    "ProdClass": null,
    "InvtClass": null,
    "UOM": "EA",
    "Owner": "TESTCUST1",
    "UnitCost": 0.0,
    "UnitPrice": 0.0,
    "ReOrderQty": 0.0,
    "OnHold": false,
    "OnHoldReason": null,
    "DateLastOrder": "2026-04-11T08:38:06.0848836-04:00",
    "DateLastCount": "1754-01-01T00:00:00",
    "DateLastMove": "1754-01-01T00:00:00",
    "DateLastShipped": "2026-04-13T08:38:06.0848836-04:00",
    "CurrCode": null,
    "OldHoldReason": null,
    "InspectAllocQty": 0.0,
    "InspectRsrvQty": 0.0,
    "InspectionAvailableQty": 0.0,
    "IsSubWarehouse": false,
    "SubWarehouseQty": 0.0,
    "WhParent": null,
    "IsEmpty": false,
    "Deleted": false,
    "GetDateTimeMinimum": "1754-01-01T00:00:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfApiItemWHDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Duplium.DFS3.Data.ApiEntity">
  <ApiItemWHDetail>
    <AllocatedQty>1</AllocatedQty>
    <AltStockCode>PL-SUP20</AltStockCode>
    <AltStockDesc>Destinator 3 Pocket PC NA Upgrade</AltStockDesc>
    <Available>8</Available>
    <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.0848836-04:00</DateLastOrder>
    <DateLastShipped>2026-04-14T08:38:06.0848836-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>
    <SubWarehouseQty>0</SubWarehouseQty>
    <UOM>EA</UOM>
    <WhCode>TF</WhCode>
    <WhParent i:nil="true" />
  </ApiItemWHDetail>
  <ApiItemWHDetail>
    <AllocatedQty>0</AllocatedQty>
    <AltStockCode>AC-300</AltStockCode>
    <AltStockDesc>Vent Mount Holder</AltStockDesc>
    <Available>6</Available>
    <BackOrderQty>0</BackOrderQty>
    <Barcode>154645633481</Barcode>
    <BookedQty>1</BookedQty>
    <DateLastCount>1754-01-01T00:00:00</DateLastCount>
    <DateLastMove>1754-01-01T00:00:00</DateLastMove>
    <DateLastOrder>2026-04-11T08:38:06.0848836-04:00</DateLastOrder>
    <DateLastShipped>2026-04-13T08:38:06.0848836-04:00</DateLastShipped>
    <InTransitQty>0</InTransitQty>
    <InspectAllocQty>0</InspectAllocQty>
    <InspectRsrvQty>0</InspectRsrvQty>
    <InspectionAvailableQty>0</InspectionAvailableQty>
    <InspectionQty>2</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>8</OnHandQty>
    <OnHold>false</OnHold>
    <OnHoldReason i:nil="true" />
    <OnPOQty>0</OnPOQty>
    <Owner>TESTCUST1</Owner>
    <Pkid>43321</Pkid>
    <RMAQty>0</RMAQty>
    <ReservedQty>0</ReservedQty>
    <Status>OK</Status>
    <StockCode>AC-300</StockCode>
    <StockDesc>Vent Mount Holder</StockDesc>
    <SubWarehouseQty>0</SubWarehouseQty>
    <UOM>EA</UOM>
    <WhCode>TF</WhCode>
    <WhParent i:nil="true" />
  </ApiItemWHDetail>
</ArrayOfApiItemWHDetail>