GET InventoryCheck/GetInventoryCheck?DeptID={DeptID}&ProdID={ProdID}&LocationID={LocationID}

Returns inventory details for a product.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
DeptID

Department id of the product to check the inventory for.

string

Required

ProdID

Product id of the product to check the inventory for.

string

Required

LocationID

Location id to only return the data for the location id. (Optional. Default is all locations)

string

Default value is string.Empty

Body Parameters

Response Information

Resource Description

Returns inventory details for a product.

AgvInventoryCheck
NameDescriptionTypeAdditional Information
Status

Status of the API call.

string
Message

Message of the API call.

string
DeptID

Product department id.

string
ProdID

Product product id.

string
ProductName

Product name.

string
Manufacturer

Product manufacturer.

string
InventoryUnits

Product inventory units.

string
TotalOnHand

Product total on hand.

decimal number
TotalAvailable

Product total available.

decimal number
BillingUnits

Product billing units.

string
PackageSize

Product package size.

string
PackageUnits

Product package units.

string
ListPrice

Product list price.

decimal number
LastCost

Product last cost.

decimal number
AverageCost

Product average cost.

decimal number
ReplacementCost

Product replacement cost.

decimal number
EstimatedAverageCost

Product estimated average cost.

decimal number
ProdIdAlternate

Alternate ID for the Product

string
LocationDetails

JSON dictionary of ProductLocationDetail.

Collection of ProductLocationDetail

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "DeptID": "sample string 3",
  "ProdID": "sample string 4",
  "ProductName": "sample string 5",
  "Manufacturer": "sample string 6",
  "InventoryUnits": "sample string 7",
  "TotalOnHand": 8.1,
  "TotalAvailable": 9.1,
  "BillingUnits": "sample string 10",
  "PackageSize": "sample string 11",
  "PackageUnits": "sample string 12",
  "ListPrice": 13.1,
  "LastCost": 14.1,
  "AverageCost": 15.1,
  "ReplacementCost": 16.1,
  "EstimatedAverageCost": 17.1,
  "ProdIdAlternate": "sample string 18",
  "LocationDetails": [
    {
      "LocationID": "sample string 1",
      "LocationName": "sample string 2",
      "OnHand": 3.1,
      "Available": 4.1,
      "OnOrder": 5.1,
      "UnusedBooked": 6.1,
      "DeliveredBooked": 7.1,
      "Undelivered": 8.1
    },
    {
      "LocationID": "sample string 1",
      "LocationName": "sample string 2",
      "OnHand": 3.1,
      "Available": 4.1,
      "OnOrder": 5.1,
      "UnusedBooked": 6.1,
      "DeliveredBooked": 7.1,
      "Undelivered": 8.1
    }
  ]
}

application/xml, text/xml

Sample:
<AgvInventoryCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Product">
  <AverageCost>15.1</AverageCost>
  <BillingUnits>sample string 10</BillingUnits>
  <DeptID>sample string 3</DeptID>
  <EstimatedAverageCost>17.1</EstimatedAverageCost>
  <InventoryUnits>sample string 7</InventoryUnits>
  <LastCost>14.1</LastCost>
  <ListPrice>13.1</ListPrice>
  <LocationDetails>
    <ProductLocationDetail>
      <Available>4.1</Available>
      <DeliveredBooked>7.1</DeliveredBooked>
      <LocationID>sample string 1</LocationID>
      <LocationName>sample string 2</LocationName>
      <OnHand>3.1</OnHand>
      <OnOrder>5.1</OnOrder>
      <Undelivered>8.1</Undelivered>
      <UnusedBooked>6.1</UnusedBooked>
    </ProductLocationDetail>
    <ProductLocationDetail>
      <Available>4.1</Available>
      <DeliveredBooked>7.1</DeliveredBooked>
      <LocationID>sample string 1</LocationID>
      <LocationName>sample string 2</LocationName>
      <OnHand>3.1</OnHand>
      <OnOrder>5.1</OnOrder>
      <Undelivered>8.1</Undelivered>
      <UnusedBooked>6.1</UnusedBooked>
    </ProductLocationDetail>
  </LocationDetails>
  <Manufacturer>sample string 6</Manufacturer>
  <Message>sample string 2</Message>
  <PackageSize>sample string 11</PackageSize>
  <PackageUnits>sample string 12</PackageUnits>
  <ProdID>sample string 4</ProdID>
  <ProdIdAlternate>sample string 18</ProdIdAlternate>
  <ProductName>sample string 5</ProductName>
  <ReplacementCost>16.1</ReplacementCost>
  <Status>sample string 1</Status>
  <TotalAvailable>9.1</TotalAvailable>
  <TotalOnHand>8.1</TotalOnHand>
</AgvInventoryCheck>