GET api/v2/Inventory/RetrieveQtyInfo?ItemId={ItemId}&LocationCode={LocationCode}
Retrieve quantity information for a specific part at a specific location.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| ItemId |
The part id to retrieve. |
string |
Required |
| LocationCode |
The location code to retrieve information for. |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
QuantityInformation| Name | Description | Type | Additional information |
|---|---|---|---|
| PartId | string |
None. |
|
| PartDesc | string |
None. |
|
| LocationCode | string |
None. |
|
| LocationNumber | string |
None. |
|
| TotalOnHand | decimal number |
None. |
|
| TotalAllocated | decimal number |
None. |
|
| TotalAvailable | decimal number |
None. |
|
| TotalOnOrder | decimal number |
None. |
|
| LocationOnHand | decimal number |
None. |
|
| LocationAllocated | decimal number |
None. |
|
| LocationAvailable | decimal number |
None. |
|
| LocationOnOrder | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{
"PartId": "sample string 1",
"PartDesc": "sample string 2",
"LocationCode": "sample string 3",
"LocationNumber": "sample string 4",
"TotalOnHand": 5.0,
"TotalAllocated": 6.0,
"TotalAvailable": 7.0,
"TotalOnOrder": 8.0,
"LocationOnHand": 9.0,
"LocationAllocated": 10.0,
"LocationAvailable": 11.0,
"LocationOnOrder": 12.0
}
application/xml, text/xml
Sample:
<QuantityInformation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models"> <LocationAllocated>10</LocationAllocated> <LocationAvailable>11</LocationAvailable> <LocationCode>sample string 3</LocationCode> <LocationNumber>sample string 4</LocationNumber> <LocationOnHand>9</LocationOnHand> <LocationOnOrder>12</LocationOnOrder> <PartDesc>sample string 2</PartDesc> <PartId>sample string 1</PartId> <TotalAllocated>6</TotalAllocated> <TotalAvailable>7</TotalAvailable> <TotalOnHand>5</TotalOnHand> <TotalOnOrder>8</TotalOnOrder> </QuantityInformation>