GET api/inventory/InventoryGroup?productID={productID}

This API is used to determine child items in an Inventory Group. This will provide Product IDs of the child items, as well as the quantity in the group.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
productID

This is the ProductID of the parent of an InventoryGroup, if the group exists.

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of InventoryGroupViewModel
NameDescriptionTypeAdditional information
ProductID

ProductID of the child item in the Inventory Group.

string

None.

Description

The description of the Child Item.

string

None.

Quantity

The quantity of the returned child item that is included in the Inventory Group.

integer

None.

Response Formats

application/xml, text/xml

Sample:
<ListOfInventoryGroupViewModel>
  <InventoryGroupViewModel>
    <ProductID>sample string 1</ProductID>
    <Description>sample string 2</Description>
    <Quantity>3</Quantity>
  </InventoryGroupViewModel>
  <InventoryGroupViewModel>
    <ProductID>sample string 1</ProductID>
    <Description>sample string 2</Description>
    <Quantity>3</Quantity>
  </InventoryGroupViewModel>
</ListOfInventoryGroupViewModel>

application/json, text/json

Sample:
[
  {
    "ProductID": "sample string 1",
    "Description": "sample string 2",
    "Quantity": 3
  },
  {
    "ProductID": "sample string 1",
    "Description": "sample string 2",
    "Quantity": 3
  }
]