Documentation for GET api/Party/Inventory/GroupByCategory?orderId={orderId}&localeId={localeId}&includeAllOptionItems={includeAllOptionItems}

GET api/Party/Inventory/GroupByCategory?orderId={orderId}&localeId={localeId}&includeAllOptionItems={includeAllOptionItems}

Method to return a list of Items Group by Category.
Request Information

URI Parameters

Name	Description	Type	Additional information
orderId	The ID of the order.	integer	Required
localeId	The locale identifier. If not defined will use the representative's default locale.	integer	None.
includeAllOptionItems	Optional. Defaults to False. When set to True, the API will recursively search for inventory relationships for each item, which may increase response time. When set to False, the search will be limited to a maximum depth of 1 level.	boolean	Default value is False
Body Parameters

None.
Response Information

Resource Description

Collection of InventoryCategoryViewModel
Name	Type	Additional information
Category	string	None.
CategoryID	integer	None.
DisplayCategory	string	None.
HasSubCats	boolean	None.
ParentCategoryID	integer	None.
SortOrder	integer	None.
Products	Collection of PartyInventoryViewModel	None.
Response Formats

application/xml, text/xml

Sample:
<ListOfInventoryCategoryViewModel>
  <InventoryCategoryViewModel>
    <Category>sample string 1</Category>
    <CategoryID>2</CategoryID>
    <DisplayCategory>sample string 3</DisplayCategory>
    <HasSubCats>True</HasSubCats>
    <ParentCategoryID>5</ParentCategoryID>
    <SortOrder>6</SortOrder>
    <Products>
      <PartyInventoryViewModel>
        <OnHand>1</OnHand>
        <TimeDuration>sample string 2</TimeDuration>
        <KitDisplayNameOverride>sample string 3</KitDisplayNameOverride>
        <InventoryOptionsGroup>
          <PartyInventoryOptionsGroupViewModel>
            <GroupDescription>sample string 1</GroupDescription>
            <GroupId>2</GroupId>
            <RelationshipTypeProgrammingKey>sample string 3</RelationshipTypeProgrammingKey>
            <InventoryList>
              <PartyInventoryViewModel />
              <PartyInventoryViewModel />
            </InventoryList>
          </PartyInventoryOptionsGroupViewModel>
          <PartyInventoryOptionsGroupViewModel>
            <GroupDescription>sample string 1</GroupDescription>
            <GroupId>2</GroupId>
            <RelationshipTypeProgrammingKey>sample string 3</RelationshipTypeProgrammingKey>
            <InventoryList>
              <PartyInventoryViewModel />
              <PartyInventoryViewModel />
            </InventoryList>
          </PartyInventoryOptionsGroupViewModel>
        </InventoryOptionsGroup>
        <InventoryID>4</InventoryID>
        <ProductID>sample string 5</ProductID>
        <MasterProductID>sample string 6</MasterProductID>
        <DisplayName>sample string 7</DisplayName>
        <ShortDetail>sample string 8</ShortDetail>
        <LongDetail>sample string 9</LongDetail>
        <SearchTerms>sample string 10</SearchTerms>
        <Price>11</Price>
        <CurrencyTypeID>12</CurrencyTypeID>
        <CurrencySymbol>sample string 13</CurrencySymbol>
        <Volume>1</Volume>
        <Volume2>1</Volume2>
        <Volume3>1</Volume3>
        <Volume4>1</Volume4>
        <Compare>14</Compare>
        <CompareText>sample string 15</CompareText>
        <SmallImageURL>sample string 16</SmallImageURL>
        <LargeImageURL>sample string 17</LargeImageURL>
        <IsFeaturedItem>True</IsFeaturedItem>
        <CategoryID>19</CategoryID>
        <InventoryRelationshipGroupID>1</InventoryRelationshipGroupID>
        <OutOfStockMessage>sample string 20</OutOfStockMessage>
        <LowStockMessage>sample string 21</LowStockMessage>
        <DoNotAllowAddToCartStock>True</DoNotAllowAddToCartStock>
        <DoNotAllowAddToCartCountry>True</DoNotAllowAddToCartCountry>
        <AllowBackOrder>True</AllowBackOrder>
        <GroupItemOverrideStock>True</GroupItemOverrideStock>
        <SearchField>SAMPLESTRING7</SearchField>
        <IsCartItem>True</IsCartItem>
        <SortOrder>27</SortOrder>
        <Level>28</Level>
        <MasterInventoryProductID>sample string 29</MasterInventoryProductID>
        <MasterInventoryRelationshipGroupID>1</MasterInventoryRelationshipGroupID>
        <RenewalIncrement>1</RenewalIncrement>
        <QtyOptions>sample string 30</QtyOptions>
        <MasterItemDisplayName>sample string 31</MasterItemDisplayName>
        <AllowJSCartPurchase>True</AllowJSCartPurchase>
        <DoNotAllowAddToCartFlagged>True</DoNotAllowAddToCartFlagged>
        <DefaultLowStockMessage>sample string 34</DefaultLowStockMessage>
        <DefaultOutOfStockMessage>sample string 35</DefaultOutOfStockMessage>
        <TagText>sample string 36</TagText>
        <TagImageURL>sample string 37</TagImageURL>
        <AutoShipPrice>1</AutoShipPrice>
        <WholesalePrice>38</WholesalePrice>
        <IsEnrollment>True</IsEnrollment>
        <IsAutoShipItem>True</IsAutoShipItem>
        <Media />
        <HasAutoShipTemplate>True</HasAutoShipTemplate>
        <SignupOptionalItem>True</SignupOptionalItem>
        <SignupAutoshipOption>True</SignupAutoshipOption>
        <SignupOptionalItemQtyOptions>sample string 44</SignupOptionalItemQtyOptions>
        <SignupAutoshipOptionQtyOptions>sample string 45</SignupAutoshipOptionQtyOptions>
        <PurchaseOption>46</PurchaseOption>
        <PricePerUnitStandardOfMeasurement>sample string 47</PricePerUnitStandardOfMeasurement>
        <PricePerUnitQuantityPer>1</PricePerUnitQuantityPer>
        <IsAutoshipDefaultOption>48</IsAutoshipDefaultOption>
        <SmallIsResourceServerImage>True</SmallIsResourceServerImage>
        <LargeIsResourceServerImage>True</LargeIsResourceServerImage>
        <IsPartyItem>True</IsPartyItem>
        <SoftAllocationTimerOverride>52</SoftAllocationTimerOverride>
        <IsMasterKitItem>True</IsMasterKitItem>
        <IsRelationshipPresent>True</IsRelationshipPresent>
      </PartyInventoryViewModel>
      <PartyInventoryViewModel>
        <OnHand>1</OnHand>
        <TimeDuration>sample string 2</TimeDuration>
        <KitDisplayNameOverride>sample string 3</KitDisplayNameOverride>
        <InventoryOptionsGroup>
          <PartyInventoryOptionsGroupViewModel>
            <GroupDescription>sample string 1</GroupDescription>
            <GroupId>2</GroupId>
            <RelationshipTypeProgrammingKey>sample string 3</RelationshipTypeProgrammingKey>
            <InventoryList>
              <PartyInventoryViewModel />
              <PartyInventoryViewModel />
            </InventoryList>
          </PartyInventoryOptionsGroupViewModel>
          <PartyInventoryOptionsGroupViewModel>
            <GroupDescription>sample string 1</GroupDescription>
            <GroupId>2</GroupId>
            <RelationshipTypeProgrammingKey>sample string 3</RelationshipTypeProgrammingKey>
            <InventoryList>
              <PartyInventoryViewModel />
              <PartyInventoryViewModel />
            </InventoryList>
          </PartyInventoryOptionsGroupViewModel>
        </InventoryOptionsGroup>
        <InventoryID>4</InventoryID>
        <ProductID>sample string 5</ProductID>
        <MasterProductID>sample string 6</MasterProductID>
        <DisplayName>sample string 7</DisplayName>
        <ShortDetail>sample string 8</ShortDetail>
        <LongDetail>sample string 9</LongDetail>
        <SearchTerms>sample string 10</SearchTerms>
        <Price>11</Price>
        <CurrencyTypeID>12</CurrencyTypeID>
        <CurrencySymbol>sample string 13</CurrencySymbol>
        <Volume>1</Volume>
        <Volume2>1</Volume2>
        <Volume3>1</Volume3>
        <Volume4>1</Volume4>
        <Compare>14</Compare>
        <CompareText>sample string 15</CompareText>
        <SmallImageURL>sample string 16</SmallImageURL>
        <LargeImageURL>sample string 17</LargeImageURL>
        <IsFeaturedItem>True</IsFeaturedItem>
        <CategoryID>19</CategoryID>
        <InventoryRelationshipGroupID>1</InventoryRelationshipGroupID>
        <OutOfStockMessage>sample string 20</OutOfStockMessage>
        <LowStockMessage>sample string 21</LowStockMessage>
        <DoNotAllowAddToCartStock>True</DoNotAllowAddToCartStock>
        <DoNotAllowAddToCartCountry>True</DoNotAllowAddToCartCountry>
        <AllowBackOrder>True</AllowBackOrder>
        <GroupItemOverrideStock>True</GroupItemOverrideStock>
        <SearchField>SAMPLESTRING7</SearchField>
        <IsCartItem>True</IsCartItem>
        <SortOrder>27</SortOrder>
        <Level>28</Level>
        <MasterInventoryProductID>sample string 29</MasterInventoryProductID>
        <MasterInventoryRelationshipGroupID>1</MasterInventoryRelationshipGroupID>
        <RenewalIncrement>1</RenewalIncrement>
        <QtyOptions>sample string 30</QtyOptions>
        <MasterItemDisplayName>sample string 31</MasterItemDisplayName>
        <AllowJSCartPurchase>True</AllowJSCartPurchase>
        <DoNotAllowAddToCartFlagged>True</DoNotAllowAddToCartFlagged>
        <DefaultLowStockMessage>sample string 34</DefaultLowStockMessage>
        <DefaultOutOfStockMessage>sample string 35</DefaultOutOfStockMessage>
        <TagText>sample string 36</TagText>
        <TagImageURL>sample string 37</TagImageURL>
        <AutoShipPrice>1</AutoShipPrice>
        <WholesalePrice>38</WholesalePrice>
        <IsEnrollment>True</IsEnrollment>
        <IsAutoShipItem>True</IsAutoShipItem>
        <Media />
        <HasAutoShipTemplate>True</HasAutoShipTemplate>
        <SignupOptionalItem>True</SignupOptionalItem>
        <SignupAutoshipOption>True</SignupAutoshipOption>
        <SignupOptionalItemQtyOptions>sample string 44</SignupOptionalItemQtyOptions>
        <SignupAutoshipOptionQtyOptions>sample string 45</SignupAutoshipOptionQtyOptions>
        <PurchaseOption>46</PurchaseOption>
        <PricePerUnitStandardOfMeasurement>sample string 47</PricePerUnitStandardOfMeasurement>
        <PricePerUnitQuantityPer>1</PricePerUnitQuantityPer>
        <IsAutoshipDefaultOption>48</IsAutoshipDefaultOption>
        <SmallIsResourceServerImage>True</SmallIsResourceServerImage>
        <LargeIsResourceServerImage>True</LargeIsResourceServerImage>
        <IsPartyItem>True</IsPartyItem>
        <SoftAllocationTimerOverride>52</SoftAllocationTimerOverride>
        <IsMasterKitItem>True</IsMasterKitItem>
        <IsRelationshipPresent>True</IsRelationshipPresent>
      </PartyInventoryViewModel>
    </Products>
  </InventoryCategoryViewModel>
  <InventoryCategoryViewModel>
    <Category>sample string 1</Category>
    <CategoryID>2</CategoryID>
    <DisplayCategory>sample string 3</DisplayCategory>
    <HasSubCats>True</HasSubCats>
    <ParentCategoryID>5</ParentCategoryID>
    <SortOrder>6</SortOrder>
    <Products>
      <PartyInventoryViewModel>
        <OnHand>1</OnHand>
        <TimeDuration>sample string 2</TimeDuration>
        <KitDisplayNameOverride>sample string 3</KitDisplayNameOverride>
        <InventoryOptionsGroup>
          <PartyInventoryOptionsGroupViewModel>
            <GroupDescription>sample string 1</GroupDescription>
            <GroupId>2</GroupId>
            <RelationshipTypeProgrammingKey>sample string 3</RelationshipTypeProgrammingKey>
            <InventoryList>
              <PartyInventoryViewModel />
              <PartyInventoryViewModel />
            </InventoryList>
          </PartyInventoryOptionsGroupViewModel>
          <PartyInventoryOptionsGroupViewModel>
            <GroupDescription>sample string 1</GroupDescription>
            <GroupId>2</GroupId>
            <RelationshipTypeProgrammingKey>sample string 3</RelationshipTypeProgrammingKey>
            <InventoryList>
              <PartyInventoryViewModel />
              <PartyInventoryViewModel />
            </InventoryList>
          </PartyInventoryOptionsGroupViewModel>
        </InventoryOptionsGroup>
        <InventoryID>4</InventoryID>
        <ProductID>sample string 5</ProductID>
        <MasterProductID>sample string 6</MasterProductID>
        <DisplayName>sample string 7</DisplayName>
        <ShortDetail>sample string 8</ShortDetail>
        <LongDetail>sample string 9</LongDetail>
        <SearchTerms>sample string 10</SearchTerms>
        <Price>11</Price>
        <CurrencyTypeID>12</CurrencyTypeID>
        <CurrencySymbol>sample string 13</CurrencySymbol>
        <Volume>1</Volume>
        <Volume2>1</Volume2>
        <Volume3>1</Volume3>
        <Volume4>1</Volume4>
        <Compare>14</Compare>
        <CompareText>sample string 15</CompareText>
        <SmallImageURL>sample string 16</SmallImageURL>
        <LargeImageURL>sample string 17</LargeImageURL>
        <IsFeaturedItem>True</IsFeaturedItem>
        <CategoryID>19</CategoryID>
        <InventoryRelationshipGroupID>1</InventoryRelationshipGroupID>
        <OutOfStockMessage>sample string 20</OutOfStockMessage>
        <LowStockMessage>sample string 21</LowStockMessage>
        <DoNotAllowAddToCartStock>True</DoNotAllowAddToCartStock>
        <DoNotAllowAddToCartCountry>True</DoNotAllowAddToCartCountry>
        <AllowBackOrder>True</AllowBackOrder>
        <GroupItemOverrideStock>True</GroupItemOverrideStock>
        <SearchField>SAMPLESTRING7</SearchField>
        <IsCartItem>True</IsCartItem>
        <SortOrder>27</SortOrder>
        <Level>28</Level>
        <MasterInventoryProductID>sample string 29</MasterInventoryProductID>
        <MasterInventoryRelationshipGroupID>1</MasterInventoryRelationshipGroupID>
        <RenewalIncrement>1</RenewalIncrement>
        <QtyOptions>sample string 30</QtyOptions>
        <MasterItemDisplayName>sample string 31</MasterItemDisplayName>
        <AllowJSCartPurchase>True</AllowJSCartPurchase>
        <DoNotAllowAddToCartFlagged>True</DoNotAllowAddToCartFlagged>
        <DefaultLowStockMessage>sample string 34</DefaultLowStockMessage>
        <DefaultOutOfStockMessage>sample string 35</DefaultOutOfStockMessage>
        <TagText>sample string 36</TagText>
        <TagImageURL>sample string 37</TagImageURL>
        <AutoShipPrice>1</AutoShipPrice>
        <WholesalePrice>38</WholesalePrice>
        <IsEnrollment>True</IsEnrollment>
        <IsAutoShipItem>True</IsAutoShipItem>
        <Media />
        <HasAutoShipTemplate>True</HasAutoShipTemplate>
        <SignupOptionalItem>True</SignupOptionalItem>
        <SignupAutoshipOption>True</SignupAutoshipOption>
        <SignupOptionalItemQtyOptions>sample string 44</SignupOptionalItemQtyOptions>
        <SignupAutoshipOptionQtyOptions>sample string 45</SignupAutoshipOptionQtyOptions>
        <PurchaseOption>46</PurchaseOption>
        <PricePerUnitStandardOfMeasurement>sample string 47</PricePerUnitStandardOfMeasurement>
        <PricePerUnitQuantityPer>1</PricePerUnitQuantityPer>
        <IsAutoshipDefaultOption>48</IsAutoshipDefaultOption>
        <SmallIsResourceServerImage>True</SmallIsResourceServerImage>
        <LargeIsResourceServerImage>True</LargeIsResourceServerImage>
        <IsPartyItem>True</IsPartyItem>
        <SoftAllocationTimerOverride>52</SoftAllocationTimerOverride>
        <IsMasterKitItem>True</IsMasterKitItem>
        <IsRelationshipPresent>True</IsRelationshipPresent>
      </PartyInventoryViewModel>
      <PartyInventoryViewModel>
        <OnHand>1</OnHand>
        <TimeDuration>sample string 2</TimeDuration>
        <KitDisplayNameOverride>sample string 3</KitDisplayNameOverride>
        <InventoryOptionsGroup>
          <PartyInventoryOptionsGroupViewModel>
            <GroupDescription>sample string 1</GroupDescription>
            <GroupId>2</GroupId>
            <RelationshipTypeProgrammingKey>sample string 3</RelationshipTypeProgrammingKey>
            <InventoryList>
              <PartyInventoryViewModel />
              <PartyInventoryViewModel />
            </InventoryList>
          </PartyInventoryOptionsGroupViewModel>
          <PartyInventoryOptionsGroupViewModel>
            <GroupDescription>sample string 1</GroupDescription>
            <GroupId>2</GroupId>
            <RelationshipTypeProgrammingKey>sample string 3</RelationshipTypeProgrammingKey>
            <InventoryList>
              <PartyInventoryViewModel />
              <PartyInventoryViewModel />
            </InventoryList>
          </PartyInventoryOptionsGroupViewModel>
        </InventoryOptionsGroup>
        <InventoryID>4</InventoryID>
        <ProductID>sample string 5</ProductID>
        <MasterProductID>sample string 6</MasterProductID>
        <DisplayName>sample string 7</DisplayName>
        <ShortDetail>sample string 8</ShortDetail>
        <LongDetail>sample string 9</LongDetail>
        <SearchTerms>sample string 10</SearchTerms>
        <Price>11</Price>
        <CurrencyTypeID>12</CurrencyTypeID>
        <CurrencySymbol>sample string 13</CurrencySymbol>
        <Volume>1</Volume>
        <Volume2>1</Volume2>
        <Volume3>1</Volume3>
        <Volume4>1</Volume4>
        <Compare>14</Compare>
        <CompareText>sample string 15</CompareText>
        <SmallImageURL>sample string 16</SmallImageURL>
        <LargeImageURL>sample string 17</LargeImageURL>
        <IsFeaturedItem>True</IsFeaturedItem>
        <CategoryID>19</CategoryID>
        <InventoryRelationshipGroupID>1</InventoryRelationshipGroupID>
        <OutOfStockMessage>sample string 20</OutOfStockMessage>
        <LowStockMessage>sample string 21</LowStockMessage>
        <DoNotAllowAddToCartStock>True</DoNotAllowAddToCartStock>
        <DoNotAllowAddToCartCountry>True</DoNotAllowAddToCartCountry>
        <AllowBackOrder>True</AllowBackOrder>
        <GroupItemOverrideStock>True</GroupItemOverrideStock>
        <SearchField>SAMPLESTRING7</SearchField>
        <IsCartItem>True</IsCartItem>
        <SortOrder>27</SortOrder>
        <Level>28</Level>
        <MasterInventoryProductID>sample string 29</MasterInventoryProductID>
        <MasterInventoryRelationshipGroupID>1</MasterInventoryRelationshipGroupID>
        <RenewalIncrement>1</RenewalIncrement>
        <QtyOptions>sample string 30</QtyOptions>
        <MasterItemDisplayName>sample string 31</MasterItemDisplayName>
        <AllowJSCartPurchase>True</AllowJSCartPurchase>
        <DoNotAllowAddToCartFlagged>True</DoNotAllowAddToCartFlagged>
        <DefaultLowStockMessage>sample string 34</DefaultLowStockMessage>
        <DefaultOutOfStockMessage>sample string 35</DefaultOutOfStockMessage>
        <TagText>sample string 36</TagText>
        <TagImageURL>sample string 37</TagImageURL>
        <AutoShipPrice>1</AutoShipPrice>
        <WholesalePrice>38</WholesalePrice>
        <IsEnrollment>True</IsEnrollment>
        <IsAutoShipItem>True</IsAutoShipItem>
        <Media />
        <HasAutoShipTemplate>True</HasAutoShipTemplate>
        <SignupOptionalItem>True</SignupOptionalItem>
        <SignupAutoshipOption>True</SignupAutoshipOption>
        <SignupOptionalItemQtyOptions>sample string 44</SignupOptionalItemQtyOptions>
        <SignupAutoshipOptionQtyOptions>sample string 45</SignupAutoshipOptionQtyOptions>
        <PurchaseOption>46</PurchaseOption>
        <PricePerUnitStandardOfMeasurement>sample string 47</PricePerUnitStandardOfMeasurement>
        <PricePerUnitQuantityPer>1</PricePerUnitQuantityPer>
        <IsAutoshipDefaultOption>48</IsAutoshipDefaultOption>
        <SmallIsResourceServerImage>True</SmallIsResourceServerImage>
        <LargeIsResourceServerImage>True</LargeIsResourceServerImage>
        <IsPartyItem>True</IsPartyItem>
        <SoftAllocationTimerOverride>52</SoftAllocationTimerOverride>
        <IsMasterKitItem>True</IsMasterKitItem>
        <IsRelationshipPresent>True</IsRelationshipPresent>
      </PartyInventoryViewModel>
    </Products>
  </InventoryCategoryViewModel>
</ListOfInventoryCategoryViewModel>
application/json

Sample:
An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'ByDesign.SOA.Common.Models.Inventory.PartyInventoryViewModel'. Path '[0].Products[0].InventoryOptionsGroup[0].InventoryList'.
text/json

Sample:
An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'ByDesign.SOA.Common.Models.Inventory.PartyInventoryViewModel'. Path '[0].Products[0].InventoryOptionsGroup[0].InventoryList'.