Documentation for GET api/Admin/RetailSuccessStore/GetInventory?productID={productID}&pageSize={pageSize}&pageNumber={pageNumber}

GET api/Admin/RetailSuccessStore/GetInventory?productID={productID}&pageSize={pageSize}&pageNumber={pageNumber}

Request Information

URI Parameters

Name	Type	Additional information
productID	string	Default value is
pageSize	integer	None.
pageNumber	integer	None.

Body Parameters

None.

Response Information

Resource Description

RetailSuccessInventorySummary

Name	Description	Type	Additional information
InventoryItems	All Inventory Items	Collection of RetailSuccessInventory	None.
Categories	Categories with Inventory Items	Collection of RetailSuccessCategory	None.
Filters	Filters with Inventory Items	Collection of RetailSuccessFilter	None.

Response Formats

application/xml, text/xml

Sample:

<RetailSuccessInventorySummary>
  <InventoryItems>
    <RetailSuccessInventory>
      <TenantIdentifier>sample string 1</TenantIdentifier>
      <InventoryID>2</InventoryID>
      <ProductID>sample string 3</ProductID>
      <Description>sample string 4</Description>
      <Explanation>sample string 5</Explanation>
      <LongExplanation>sample string 6</LongExplanation>
      <CategoryID>7</CategoryID>
      <SmallImageURL>sample string 8</SmallImageURL>
      <LargeImageURL>sample string 9</LargeImageURL>
      <IsFreeShipping>True</IsFreeShipping>
      <ShippingSurcharge>1</ShippingSurcharge>
      <BaseShippingSurcharge>1</BaseShippingSurcharge>
      <Weight>1</Weight>
      <GroupItemOverrideWeight>1</GroupItemOverrideWeight>
      <HandlingFee>1</HandlingFee>
      <IsGroupOwner>True</IsGroupOwner>
      <IsResellable>True</IsResellable>
      <MinResellablePrice>13</MinResellablePrice>
      <DateCreated>01/09/2025 01:47:55</DateCreated>
      <LastModified>01/09/2025 01:47:55</LastModified>
      <WholesalePrice>16</WholesalePrice>
      <RetailPrice>17</RetailPrice>
      <Media />
      <Component>
        <RetailSuccessItemComponent>
          <ProductID>sample string 1</ProductID>
          <Quantity>2</Quantity>
        </RetailSuccessItemComponent>
        <RetailSuccessItemComponent>
          <ProductID>sample string 1</ProductID>
          <Quantity>2</Quantity>
        </RetailSuccessItemComponent>
      </Component>
    </RetailSuccessInventory>
    <RetailSuccessInventory>
      <TenantIdentifier>sample string 1</TenantIdentifier>
      <InventoryID>2</InventoryID>
      <ProductID>sample string 3</ProductID>
      <Description>sample string 4</Description>
      <Explanation>sample string 5</Explanation>
      <LongExplanation>sample string 6</LongExplanation>
      <CategoryID>7</CategoryID>
      <SmallImageURL>sample string 8</SmallImageURL>
      <LargeImageURL>sample string 9</LargeImageURL>
      <IsFreeShipping>True</IsFreeShipping>
      <ShippingSurcharge>1</ShippingSurcharge>
      <BaseShippingSurcharge>1</BaseShippingSurcharge>
      <Weight>1</Weight>
      <GroupItemOverrideWeight>1</GroupItemOverrideWeight>
      <HandlingFee>1</HandlingFee>
      <IsGroupOwner>True</IsGroupOwner>
      <IsResellable>True</IsResellable>
      <MinResellablePrice>13</MinResellablePrice>
      <DateCreated>01/09/2025 01:47:55</DateCreated>
      <LastModified>01/09/2025 01:47:55</LastModified>
      <WholesalePrice>16</WholesalePrice>
      <RetailPrice>17</RetailPrice>
      <Media />
      <Component>
        <RetailSuccessItemComponent>
          <ProductID>sample string 1</ProductID>
          <Quantity>2</Quantity>
        </RetailSuccessItemComponent>
        <RetailSuccessItemComponent>
          <ProductID>sample string 1</ProductID>
          <Quantity>2</Quantity>
        </RetailSuccessItemComponent>
      </Component>
    </RetailSuccessInventory>
  </InventoryItems>
  <Categories>
    <RetailSuccessCategory>
      <CategoryID>1</CategoryID>
      <Category>sample string 2</Category>
      <SubCategoryID>1</SubCategoryID>
      <SubCategory>sample string 3</SubCategory>
      <InventoryIDs>
        <Int32>1</Int32>
        <Int32>2</Int32>
      </InventoryIDs>
    </RetailSuccessCategory>
    <RetailSuccessCategory>
      <CategoryID>1</CategoryID>
      <Category>sample string 2</Category>
      <SubCategoryID>1</SubCategoryID>
      <SubCategory>sample string 3</SubCategory>
      <InventoryIDs>
        <Int32>1</Int32>
        <Int32>2</Int32>
      </InventoryIDs>
    </RetailSuccessCategory>
  </Categories>
  <Filters>
    <RetailSuccessFilter>
      <ID>1</ID>
      <Description>sample string 2</Description>
      <FilterOptions>
        <RetailSuccessFilterOption>
          <ID>1</ID>
          <Description>sample string 2</Description>
          <InventoryIDs>
            <Int32>1</Int32>
            <Int32>2</Int32>
          </InventoryIDs>
        </RetailSuccessFilterOption>
        <RetailSuccessFilterOption>
          <ID>1</ID>
          <Description>sample string 2</Description>
          <InventoryIDs>
            <Int32>1</Int32>
            <Int32>2</Int32>
          </InventoryIDs>
        </RetailSuccessFilterOption>
      </FilterOptions>
    </RetailSuccessFilter>
    <RetailSuccessFilter>
      <ID>1</ID>
      <Description>sample string 2</Description>
      <FilterOptions>
        <RetailSuccessFilterOption>
          <ID>1</ID>
          <Description>sample string 2</Description>
          <InventoryIDs>
            <Int32>1</Int32>
            <Int32>2</Int32>
          </InventoryIDs>
        </RetailSuccessFilterOption>
        <RetailSuccessFilterOption>
          <ID>1</ID>
          <Description>sample string 2</Description>
          <InventoryIDs>
            <Int32>1</Int32>
            <Int32>2</Int32>
          </InventoryIDs>
        </RetailSuccessFilterOption>
      </FilterOptions>
    </RetailSuccessFilter>
  </Filters>
</RetailSuccessInventorySummary>

application/json, text/json

Sample:

{
  "InventoryItems": [
    {
      "TenantIdentifier": "sample string 1",
      "InventoryID": 2,
      "ProductID": "sample string 3",
      "Description": "sample string 4",
      "Explanation": "sample string 5",
      "LongExplanation": "sample string 6",
      "CategoryID": 7,
      "SmallImageURL": "sample string 8",
      "LargeImageURL": "sample string 9",
      "IsFreeShipping": true,
      "ShippingSurcharge": 1.0,
      "BaseShippingSurcharge": 1.0,
      "Weight": 1.0,
      "GroupItemOverrideWeight": 1.0,
      "HandlingFee": 1.0,
      "IsGroupOwner": true,
      "IsResellable": true,
      "MinResellablePrice": 13.0,
      "DateCreated": "2025-01-09T01:47:55.9374748-05:00",
      "LastModified": "2025-01-09T01:47:55.9374748-05:00",
      "WholesalePrice": 16.0,
      "RetailPrice": 17.0,
      "Component": [
        {
          "ProductID": "sample string 1",
          "Quantity": 2
        },
        {
          "ProductID": "sample string 1",
          "Quantity": 2
        }
      ]
    },
    {
      "TenantIdentifier": "sample string 1",
      "InventoryID": 2,
      "ProductID": "sample string 3",
      "Description": "sample string 4",
      "Explanation": "sample string 5",
      "LongExplanation": "sample string 6",
      "CategoryID": 7,
      "SmallImageURL": "sample string 8",
      "LargeImageURL": "sample string 9",
      "IsFreeShipping": true,
      "ShippingSurcharge": 1.0,
      "BaseShippingSurcharge": 1.0,
      "Weight": 1.0,
      "GroupItemOverrideWeight": 1.0,
      "HandlingFee": 1.0,
      "IsGroupOwner": true,
      "IsResellable": true,
      "MinResellablePrice": 13.0,
      "DateCreated": "2025-01-09T01:47:55.9374748-05:00",
      "LastModified": "2025-01-09T01:47:55.9374748-05:00",
      "WholesalePrice": 16.0,
      "RetailPrice": 17.0,
      "Component": [
        {
          "ProductID": "sample string 1",
          "Quantity": 2
        },
        {
          "ProductID": "sample string 1",
          "Quantity": 2
        }
      ]
    }
  ],
  "Categories": [
    {
      "CategoryID": 1,
      "Category": "sample string 2",
      "SubCategoryID": 1,
      "SubCategory": "sample string 3",
      "InventoryIDs": [
        1,
        2
      ]
    },
    {
      "CategoryID": 1,
      "Category": "sample string 2",
      "SubCategoryID": 1,
      "SubCategory": "sample string 3",
      "InventoryIDs": [
        1,
        2
      ]
    }
  ],
  "Filters": [
    {
      "ID": 1,
      "Description": "sample string 2",
      "FilterOptions": [
        {
          "ID": 1,
          "Description": "sample string 2",
          "InventoryIDs": [
            1,
            2
          ]
        },
        {
          "ID": 1,
          "Description": "sample string 2",
          "InventoryIDs": [
            1,
            2
          ]
        }
      ]
    },
    {
      "ID": 1,
      "Description": "sample string 2",
      "FilterOptions": [
        {
          "ID": 1,
          "Description": "sample string 2",
          "InventoryIDs": [
            1,
            2
          ]
        },
        {
          "ID": 1,
          "Description": "sample string 2",
          "InventoryIDs": [
            1,
            2
          ]
        }
      ]
    }
  ]
}