Documentation for GET api/Party/Inventory/Kits?orderId={orderId}&productId={productId}&localeId={localeId}

GET api/Party/Inventory/Kits?orderId={orderId}&productId={productId}&localeId={localeId}

Method to return Kit group for specific ProductID.

Request Information

URI Parameters

Name	Type	Additional information
orderId	integer	Required
productId	string	Required
localeId	integer	None.

Body Parameters

None.

Response Information

Resource Description

Collection of PartyInventoryViewModel

Name	Type	Additional information
OnHand	integer	None.
TimeDuration	string	None.
KitDisplayNameOverride	string	None.
InventoryOptionsGroup	Collection of PartyInventoryOptionsGroupViewModel	None.
InventoryID	integer	None.
ProductID	string	None.
MasterProductID	string	None.
DisplayName	string	None.
ShortDetail	string	None.
LongDetail	string	None.
SearchTerms	string	None.
Price	decimal number	None.
CurrencyTypeID	integer	None.
CurrencySymbol	string	None.
Volume	decimal number	None.
Volume2	decimal number	None.
Volume3	decimal number	None.
Volume4	decimal number	None.
Compare	decimal number	None.
CompareText	string	None.
SmallImageURL	string	None.
LargeImageURL	string	None.
IsFeaturedItem	boolean	None.
CategoryID	integer	None.
InventoryRelationshipGroupID	integer	None.
OutOfStockMessage	string	None.
LowStockMessage	string	None.
DoNotAllowAddToCartStock	boolean	None.
DoNotAllowAddToCartCountry	boolean	None.
AllowBackOrder	boolean	None.
GroupItemOverrideStock	boolean	None.
SearchField	string	None.
IsCartItem	boolean	None.
SortOrder	integer	None.
Level	integer	None.
MasterInventoryProductID	string	None.
MasterInventoryRelationshipGroupID	integer	None.
RenewalIncrement	integer	None.
QtyOptions	string	None.
MasterItemDisplayName	string	None.
AllowJSCartPurchase	boolean	None.
DoNotAllowAddToCartFlagged	boolean	None.
DefaultLowStockMessage	string	None.
DefaultOutOfStockMessage	string	None.
TagText	string	None.
TagImageURL	string	None.
AutoShipPrice	decimal number	None.
WholesalePrice	decimal number	None.
IsEnrollment	boolean	None.
IsAutoShipItem	boolean	None.
Media	Collection of IMedia	None.
HasAutoShipTemplate	boolean	None.
SignupOptionalItem	boolean	None.
SignupAutoshipOption	boolean	None.
SignupOptionalItemQtyOptions	string	None.
SignupAutoshipOptionQtyOptions	string	None.
PurchaseOption	integer	None.
PricePerUnitStandardOfMeasurement	string	None.
PricePerUnitQuantityPer	decimal number	None.
IsAutoshipDefaultOption	integer	None.
SmallIsResourceServerImage	boolean	None.
LargeIsResourceServerImage	boolean	None.
IsPartyItem	boolean	None.
SoftAllocationTimerOverride	integer	None.
IsMasterKitItem	boolean	None.
IsRelationshipPresent	boolean	None.

Response Formats

application/xml, text/xml

Sample:

<ListOfPartyInventoryViewModel>
  <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>
</ListOfPartyInventoryViewModel>

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].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].InventoryOptionsGroup[0].InventoryList'.