GET api/inventory/InventoryRelationshipGroup/{id}

Get a specific inventory relationship group by ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

InventoryRelationshipGroupViewModel
NameDescriptionTypeAdditional 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:
<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>

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
}