Documentation for GET api/inventory/InventoryRelationshipGroup/ByItem?inventoryId={inventoryId}

GET api/inventory/InventoryRelationshipGroup/ByItem?inventoryId={inventoryId}

Get inventory relationship group by InventoryId

Request Information

URI Parameters

Name	Description	Type	Additional information
inventoryId		integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

Collection of InventoryRelationshipGroupViewModel

Name	Description	Type	Additional information
ID	The unique identifier for the relationship group	integer	None.
Description	Description of the relationship group	string	Required Max length: 100
Abbreviation	Abbreviation for the relationship group	string	Required Max length: 10
MasterInventoryID	ID of the master inventory item	integer	Required
RelationshipTypeID	The type of relationship	integer	Required
DefaultInventoryID	ID of the default inventory item	integer	None.
SelectionTypeID	The type of selection UI control	integer	Required
CartDescription	Description shown in the shopping cart	string	Max length: 500
DefaultItemText	Text shown for the default item	string	Max length: 100
IsShowChildPricing	Whether to show pricing for child items	boolean	None.

Response Formats

application/xml, text/xml

Sample:

<ListOfInventoryRelationshipGroupViewModel>
  <InventoryRelationshipGroupViewModel>
    <ID>1</ID>
    <Description>sample string 2</Description>
    <Abbreviation>sample string 3</Abbreviation>
    <MasterInventoryID>4</MasterInventoryID>
    <RelationshipTypeID>5</RelationshipTypeID>
    <DefaultInventoryID>6</DefaultInventoryID>
    <SelectionTypeID>7</SelectionTypeID>
    <CartDescription>sample string 8</CartDescription>
    <DefaultItemText>sample string 9</DefaultItemText>
    <IsShowChildPricing>True</IsShowChildPricing>
  </InventoryRelationshipGroupViewModel>
  <InventoryRelationshipGroupViewModel>
    <ID>1</ID>
    <Description>sample string 2</Description>
    <Abbreviation>sample string 3</Abbreviation>
    <MasterInventoryID>4</MasterInventoryID>
    <RelationshipTypeID>5</RelationshipTypeID>
    <DefaultInventoryID>6</DefaultInventoryID>
    <SelectionTypeID>7</SelectionTypeID>
    <CartDescription>sample string 8</CartDescription>
    <DefaultItemText>sample string 9</DefaultItemText>
    <IsShowChildPricing>True</IsShowChildPricing>
  </InventoryRelationshipGroupViewModel>
</ListOfInventoryRelationshipGroupViewModel>

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "Description": "sample string 2",
    "Abbreviation": "sample string 3",
    "MasterInventoryID": 4,
    "RelationshipTypeID": 5,
    "DefaultInventoryID": 6,
    "SelectionTypeID": 7,
    "CartDescription": "sample string 8",
    "DefaultItemText": "sample string 9",
    "IsShowChildPricing": true
  },
  {
    "ID": 1,
    "Description": "sample string 2",
    "Abbreviation": "sample string 3",
    "MasterInventoryID": 4,
    "RelationshipTypeID": 5,
    "DefaultInventoryID": 6,
    "SelectionTypeID": 7,
    "CartDescription": "sample string 8",
    "DefaultItemText": "sample string 9",
    "IsShowChildPricing": true
  }
]