POST InventoryCheckList/GetInventoryCheckList

Returns a list of inventory check details.

Request Information

URI Parameters

Body Parameters

A JSON string that includes the list of DepartmentID, ProductID, or Location combinations.

Name	Description	Type	Additional Information
InventoryCheckListRequestItems		Collection of clsInventoryCheckListRequestItem

Request Formats

application/json, text/json

Sample:

{
  "InventoryCheckListRequestItems": [
    {
      "departmentId": "sample string 1",
      "productId": "sample string 2",
      "locationId": "sample string 3",
      "showRelatedProducts": true
    },
    {
      "departmentId": "sample string 1",
      "productId": "sample string 2",
      "locationId": "sample string 3",
      "showRelatedProducts": true
    }
  ]
}

application/xml, text/xml

Sample:

<InventoryCheckListRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.Inv">
  <InventoryCheckListRequestItems>
    <InventoryCheckListRequestItem>
      <departmentId>sample string 1</departmentId>
      <locationId>sample string 3</locationId>
      <productId>sample string 2</productId>
      <showRelatedProducts>true</showRelatedProducts>
    </InventoryCheckListRequestItem>
    <InventoryCheckListRequestItem>
      <departmentId>sample string 1</departmentId>
      <locationId>sample string 3</locationId>
      <productId>sample string 2</productId>
      <showRelatedProducts>true</showRelatedProducts>
    </InventoryCheckListRequestItem>
  </InventoryCheckListRequestItems>
</InventoryCheckListRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'clsInventoryCheckListRequest'.

Response Information

Resource Description

Returns a list of inventory check details.

AgvInventoryCheckList

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
Count	Count of how many InventoryCheckRecords JSON dictionaries.	string
InventoryCheckRecords	JSON dictionary of InventoryCheckRecords.	Collection of clsInventoryCheck

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "InventoryCheckRecords": [
    {
      "departmentId": "sample string 1",
      "productId": "sample string 2",
      "productName": "sample string 3",
      "manufacturer": "sample string 4",
      "inventoryUnits": "sample string 5",
      "billingUnits": "sample string 6",
      "packageUnits": "sample string 7",
      "packageSize": "sample string 8",
      "listPrice": 9.1,
      "lastCost": 10.1,
      "averageCost": 11.1,
      "replacementCost": 12.1,
      "estimatedAverageCost": 13.1,
      "totalOnHand": 14.1,
      "totalAvailable": 15.1,
      "locationDetails": [
        {
          "departmentId": "sample string 1",
          "productId": "sample string 2",
          "locationId": "sample string 3",
          "onHand": 5.1,
          "available": 6.1,
          "onOrder": 7.1,
          "unusedBooked": 8.1,
          "deliveredBooked": 9.1,
          "undelivered": 10.1
        },
        {
          "departmentId": "sample string 1",
          "productId": "sample string 2",
          "locationId": "sample string 3",
          "onHand": 5.1,
          "available": 6.1,
          "onOrder": 7.1,
          "unusedBooked": 8.1,
          "deliveredBooked": 9.1,
          "undelivered": 10.1
        }
      ]
    },
    {
      "departmentId": "sample string 1",
      "productId": "sample string 2",
      "productName": "sample string 3",
      "manufacturer": "sample string 4",
      "inventoryUnits": "sample string 5",
      "billingUnits": "sample string 6",
      "packageUnits": "sample string 7",
      "packageSize": "sample string 8",
      "listPrice": 9.1,
      "lastCost": 10.1,
      "averageCost": 11.1,
      "replacementCost": 12.1,
      "estimatedAverageCost": 13.1,
      "totalOnHand": 14.1,
      "totalAvailable": 15.1,
      "locationDetails": [
        {
          "departmentId": "sample string 1",
          "productId": "sample string 2",
          "locationId": "sample string 3",
          "onHand": 5.1,
          "available": 6.1,
          "onOrder": 7.1,
          "unusedBooked": 8.1,
          "deliveredBooked": 9.1,
          "undelivered": 10.1
        },
        {
          "departmentId": "sample string 1",
          "productId": "sample string 2",
          "locationId": "sample string 3",
          "onHand": 5.1,
          "available": 6.1,
          "onOrder": 7.1,
          "unusedBooked": 8.1,
          "deliveredBooked": 9.1,
          "undelivered": 10.1
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<AgvInventoryCheckList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Product">
  <InventoryCheckRecords xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.Inv">
    <d2p1:clsInventoryCheck>
      <d2p1:averageCost>11.1</d2p1:averageCost>
      <d2p1:billingUnits>sample string 6</d2p1:billingUnits>
      <d2p1:departmentId>sample string 1</d2p1:departmentId>
      <d2p1:estimatedAverageCost>13.1</d2p1:estimatedAverageCost>
      <d2p1:inventoryUnits>sample string 5</d2p1:inventoryUnits>
      <d2p1:lastCost>10.1</d2p1:lastCost>
      <d2p1:listPrice>9.1</d2p1:listPrice>
      <d2p1:locationDetails>
        <d2p1:InventoryCheckDetail>
          <d2p1:available>6.1</d2p1:available>
          <d2p1:deliveredBooked>9.1</d2p1:deliveredBooked>
          <d2p1:departmentId>sample string 1</d2p1:departmentId>
          <d2p1:locationId>sample string 3</d2p1:locationId>
          <d2p1:onHand>5.1</d2p1:onHand>
          <d2p1:onOrder>7.1</d2p1:onOrder>
          <d2p1:productId>sample string 2</d2p1:productId>
          <d2p1:undelivered>10.1</d2p1:undelivered>
          <d2p1:unusedBooked>8.1</d2p1:unusedBooked>
        </d2p1:InventoryCheckDetail>
        <d2p1:InventoryCheckDetail>
          <d2p1:available>6.1</d2p1:available>
          <d2p1:deliveredBooked>9.1</d2p1:deliveredBooked>
          <d2p1:departmentId>sample string 1</d2p1:departmentId>
          <d2p1:locationId>sample string 3</d2p1:locationId>
          <d2p1:onHand>5.1</d2p1:onHand>
          <d2p1:onOrder>7.1</d2p1:onOrder>
          <d2p1:productId>sample string 2</d2p1:productId>
          <d2p1:undelivered>10.1</d2p1:undelivered>
          <d2p1:unusedBooked>8.1</d2p1:unusedBooked>
        </d2p1:InventoryCheckDetail>
      </d2p1:locationDetails>
      <d2p1:manufacturer>sample string 4</d2p1:manufacturer>
      <d2p1:packageSize>sample string 8</d2p1:packageSize>
      <d2p1:packageUnits>sample string 7</d2p1:packageUnits>
      <d2p1:productId>sample string 2</d2p1:productId>
      <d2p1:productName>sample string 3</d2p1:productName>
      <d2p1:replacementCost>12.1</d2p1:replacementCost>
      <d2p1:totalAvailable>15.1</d2p1:totalAvailable>
      <d2p1:totalOnHand>14.1</d2p1:totalOnHand>
    </d2p1:clsInventoryCheck>
    <d2p1:clsInventoryCheck>
      <d2p1:averageCost>11.1</d2p1:averageCost>
      <d2p1:billingUnits>sample string 6</d2p1:billingUnits>
      <d2p1:departmentId>sample string 1</d2p1:departmentId>
      <d2p1:estimatedAverageCost>13.1</d2p1:estimatedAverageCost>
      <d2p1:inventoryUnits>sample string 5</d2p1:inventoryUnits>
      <d2p1:lastCost>10.1</d2p1:lastCost>
      <d2p1:listPrice>9.1</d2p1:listPrice>
      <d2p1:locationDetails>
        <d2p1:InventoryCheckDetail>
          <d2p1:available>6.1</d2p1:available>
          <d2p1:deliveredBooked>9.1</d2p1:deliveredBooked>
          <d2p1:departmentId>sample string 1</d2p1:departmentId>
          <d2p1:locationId>sample string 3</d2p1:locationId>
          <d2p1:onHand>5.1</d2p1:onHand>
          <d2p1:onOrder>7.1</d2p1:onOrder>
          <d2p1:productId>sample string 2</d2p1:productId>
          <d2p1:undelivered>10.1</d2p1:undelivered>
          <d2p1:unusedBooked>8.1</d2p1:unusedBooked>
        </d2p1:InventoryCheckDetail>
        <d2p1:InventoryCheckDetail>
          <d2p1:available>6.1</d2p1:available>
          <d2p1:deliveredBooked>9.1</d2p1:deliveredBooked>
          <d2p1:departmentId>sample string 1</d2p1:departmentId>
          <d2p1:locationId>sample string 3</d2p1:locationId>
          <d2p1:onHand>5.1</d2p1:onHand>
          <d2p1:onOrder>7.1</d2p1:onOrder>
          <d2p1:productId>sample string 2</d2p1:productId>
          <d2p1:undelivered>10.1</d2p1:undelivered>
          <d2p1:unusedBooked>8.1</d2p1:unusedBooked>
        </d2p1:InventoryCheckDetail>
      </d2p1:locationDetails>
      <d2p1:manufacturer>sample string 4</d2p1:manufacturer>
      <d2p1:packageSize>sample string 8</d2p1:packageSize>
      <d2p1:packageUnits>sample string 7</d2p1:packageUnits>
      <d2p1:productId>sample string 2</d2p1:productId>
      <d2p1:productName>sample string 3</d2p1:productName>
      <d2p1:replacementCost>12.1</d2p1:replacementCost>
      <d2p1:totalAvailable>15.1</d2p1:totalAvailable>
      <d2p1:totalOnHand>14.1</d2p1:totalOnHand>
    </d2p1:clsInventoryCheck>
  </InventoryCheckRecords>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvInventoryCheckList>