GET api/product/GetProductActiveList?startRow={startRow}&endRow={endRow}&itemNo={itemNo}
Restricted access for internal use only
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
startRow | string |
None. |
|
endRow | string |
None. |
|
itemNo |
an optional parameter used to search item by item number |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
Collection of ProductName | Description | Type | Additional information |
---|---|---|---|
ProductNumber | string |
None. |
|
ProductTitle | string |
None. |
|
ParentTitle | string |
None. |
|
LongDescription | string |
None. |
|
ProductInfo | ProductInfo |
None. |
|
ItemType | string |
None. |
|
StyleCode | string |
None. |
|
CollectionCode | string |
None. |
|
FabricContent | string |
None. |
|
GroupNumber | string |
None. |
|
TypeOfPackaging | string |
None. |
|
CatalogYear | string |
None. |
|
UPC | string |
None. |
|
CategoryCode | string |
None. |
|
SubCategoryCode | string |
None. |
|
PieceCode | string |
None. |
|
Prop65 | string |
None. |
|
CountryOfOrigin | string |
None. |
|
ListNextGenImages | string |
None. |
|
PictureFullURLs | string |
None. |
|
WebImageURLs | string |
None. |
|
NumImages | integer |
None. |
|
NumBoxes | integer |
None. |
|
PackQty | integer |
None. |
|
CatalogPage | string |
None. |
|
FabricCleaningCode | string |
None. |
|
MainColor | string |
None. |
|
ColorFamily | string |
None. |
|
WeightLimitsOverall | string |
None. |
|
ShelfWeightLimit | string |
None. |
|
DrawerWeightLimit | string |
None. |
|
BedSlats | integer |
None. |
|
SlatType | string |
None. |
|
MainFinish | string |
None. |
|
MainMaterial | string |
None. |
|
GrossWeight | decimal number |
None. |
|
GrossWeightTotal | decimal number |
None. |
|
Cubes | decimal number |
None. |
|
CartonDimensions | Dimension |
None. |
|
Features | Collection of Features |
None. |
|
MaterialList | Collection of Material |
None. |
|
ProductDimensions | Collection of Measurement |
None. |
|
AdditionalFieldList | Collection of AdditionalField |
None. |
|
Materials | string |
None. |
|
ShipMethod | string |
None. |
|
Components | Collection of Component |
None. |
|
RelatedProducts | Collection of string |
None. |
|
AssemblyRequired | boolean |
None. |
|
AssemblyType | string |
None. |
|
AssemblyURL | string |
None. |
|
IsDiscontinued | boolean |
None. |
Item Type Definitions
Items - These are standalone products packaged in a single box.
- Examples include a dining chair, a complete nightstand, or even a dining set where all components are packaged together in one box.
- The contents may represent a single product or multiple pieces bundled as a complete set.
Kit Items - Products requiring multiple boxes for complete assembly or functionality.
- Examples include a dining table where the tabletop and legs are boxed separately.
- While the complete product is sold as one SKU, its components are shipped in multiple packages.
Supplement Items - Products that depend on a primary item to function, often enhancing or complementing another product.
- Examples: A dresser mirror (requires a dresser for use) or a trundle (designed to pair with a daybed).
- While sellable individually, they lack standalone utility without the corresponding main product.
Components - Single-box parts of a larger Kit Item, typically not sold or listed independently.
- Examples include the tabletop or legs of a Kit Item dining table.
- Unlike Supplement Items, Components are integral parts of a single product, not optional add-ons.
Combo Sets - Bundles of individually sellable Items curated for convenience or a cohesive design.
- Examples: A dining set combining a Kit Item table with four matching dining chairs (each chair being an Item).
- These sets simplify purchasing and ensure compatibility among the pieces.
Sellable Components - Functionally part of a larger Kit Item but capable of being sold or used on their own.
- Examples: A headboard from a multi-box bed or a standalone glass tabletop for a dining table.
- Unlike Components, Sellable Components retain functional value independently and are offered individually.
Response Formats
application/json, text/json
Sample:
[ { "ProductNumber": "sample string 1", "Name": "sample string 2", "Description": "sample string 3", "StyleCode": "sample string 4", "CollectionCode": "sample string 5", "FabricColor": "sample string 6", "GroupNumber": "sample string 7", "TypeOfPackaging": "sample string 8", "CatalogYear": "sample string 9", "SubBrand": "sample string 10", "UPC": "sample string 11", "CategoryCode": "sample string 12", "SubCategoryCode": "sample string 13", "PieceCode": "sample string 14", "CountryOfOrigin": "sample string 15", "ListNextGenImages": "sample string 16", "PictureFullURLs": "sample string 17", "WebImageURLs": "sample string 18", "NumImages": 19, "NumBoxes": 20, "PackQty": 21, "CatalogPage": "sample string 22", "FabricCleaningCode": "sample string 23", "MainColor": "sample string 24", "MainFinish": "sample string 25", "MainMaterial": "sample string 26", "BoxWeight": 1.0, "Cubes": 1.0, "ProductInfo": { "ProductNumber": "sample string 1", "ProductName": "sample string 2", "Description": "sample string 3", "LGE": "sample string 4", "Contents": [ "sample string 1", "sample string 2" ], "Highlights": [ "sample string 1", "sample string 2" ], "Bullets": [ "sample string 1", "sample string 2" ], "Features": [ "sample string 1", "sample string 2" ] }, "BoxSize": { "Length": 1.0, "Width": 1.0, "Height": 1.0 }, "Materials": "sample string 27", "MaterialList": [ { "Field": "sample string 1", "Value": "sample string 2" }, { "Field": "sample string 1", "Value": "sample string 2" } ], "MeasurementList": [ { "PieceName": "sample string 1", "Length": 1.0, "Width": 1.0, "Depth": 1.0, "Height": 1.0, "Diameter": 1.0, "SeatHeight": 1.0, "SeatWidth": 1.0, "SeatDepth": 1.0, "Weight": 1.0, "DeskClearance": 1.0, "MaxWidth": 1.0, "MaxDepth": 1.0, "MaxHeight": 1.0 }, { "PieceName": "sample string 1", "Length": 1.0, "Width": 1.0, "Depth": 1.0, "Height": 1.0, "Diameter": 1.0, "SeatHeight": 1.0, "SeatWidth": 1.0, "SeatDepth": 1.0, "Weight": 1.0, "DeskClearance": 1.0, "MaxWidth": 1.0, "MaxDepth": 1.0, "MaxHeight": 1.0 } ], "AdditionalFieldList": [ { "Field": "sample string 1", "Value": "sample string 2" }, { "Field": "sample string 1", "Value": "sample string 2" } ], "Components": [ { "ProductNumber": "sample string 1", "Name": "sample string 2", "UPC": "sample string 3", "BoxSize": { "Length": 1.0, "Width": 1.0, "Height": 1.0 }, "BoxWeight": 1.0, "Cubes": 1.0, "Qty": 4.0 }, { "ProductNumber": "sample string 1", "Name": "sample string 2", "UPC": "sample string 3", "BoxSize": { "Length": 1.0, "Width": 1.0, "Height": 1.0 }, "BoxWeight": 1.0, "Cubes": 1.0, "Qty": 4.0 } ], "RelatedProductList": [ "sample string 1", "sample string 2" ], "ShippingFreight": "sample string 28", "LGE": "sample string 29", "AssemblyType": "sample string 30", "AssemblyURL": "sample string 31", "AssemblyRequired": true, "IsDiscontinued": true }, { "ProductNumber": "sample string 1", "Name": "sample string 2", "Description": "sample string 3", "StyleCode": "sample string 4", "CollectionCode": "sample string 5", "FabricColor": "sample string 6", "GroupNumber": "sample string 7", "TypeOfPackaging": "sample string 8", "CatalogYear": "sample string 9", "SubBrand": "sample string 10", "UPC": "sample string 11", "CategoryCode": "sample string 12", "SubCategoryCode": "sample string 13", "PieceCode": "sample string 14", "CountryOfOrigin": "sample string 15", "ListNextGenImages": "sample string 16", "PictureFullURLs": "sample string 17", "WebImageURLs": "sample string 18", "NumImages": 19, "NumBoxes": 20, "PackQty": 21, "CatalogPage": "sample string 22", "FabricCleaningCode": "sample string 23", "MainColor": "sample string 24", "MainFinish": "sample string 25", "MainMaterial": "sample string 26", "BoxWeight": 1.0, "Cubes": 1.0, "ProductInfo": { "ProductNumber": "sample string 1", "ProductName": "sample string 2", "Description": "sample string 3", "LGE": "sample string 4", "Contents": [ "sample string 1", "sample string 2" ], "Highlights": [ "sample string 1", "sample string 2" ], "Bullets": [ "sample string 1", "sample string 2" ], "Features": [ "sample string 1", "sample string 2" ] }, "BoxSize": { "Length": 1.0, "Width": 1.0, "Height": 1.0 }, "Materials": "sample string 27", "MaterialList": [ { "Field": "sample string 1", "Value": "sample string 2" }, { "Field": "sample string 1", "Value": "sample string 2" } ], "MeasurementList": [ { "PieceName": "sample string 1", "Length": 1.0, "Width": 1.0, "Depth": 1.0, "Height": 1.0, "Diameter": 1.0, "SeatHeight": 1.0, "SeatWidth": 1.0, "SeatDepth": 1.0, "Weight": 1.0, "DeskClearance": 1.0, "MaxWidth": 1.0, "MaxDepth": 1.0, "MaxHeight": 1.0 }, { "PieceName": "sample string 1", "Length": 1.0, "Width": 1.0, "Depth": 1.0, "Height": 1.0, "Diameter": 1.0, "SeatHeight": 1.0, "SeatWidth": 1.0, "SeatDepth": 1.0, "Weight": 1.0, "DeskClearance": 1.0, "MaxWidth": 1.0, "MaxDepth": 1.0, "MaxHeight": 1.0 } ], "AdditionalFieldList": [ { "Field": "sample string 1", "Value": "sample string 2" }, { "Field": "sample string 1", "Value": "sample string 2" } ], "Components": [ { "ProductNumber": "sample string 1", "Name": "sample string 2", "UPC": "sample string 3", "BoxSize": { "Length": 1.0, "Width": 1.0, "Height": 1.0 }, "BoxWeight": 1.0, "Cubes": 1.0, "Qty": 4.0 }, { "ProductNumber": "sample string 1", "Name": "sample string 2", "UPC": "sample string 3", "BoxSize": { "Length": 1.0, "Width": 1.0, "Height": 1.0 }, "BoxWeight": 1.0, "Cubes": 1.0, "Qty": 4.0 } ], "RelatedProductList": [ "sample string 1", "sample string 2" ], "ShippingFreight": "sample string 28", "LGE": "sample string 29", "AssemblyType": "sample string 30", "AssemblyURL": "sample string 31", "AssemblyRequired": true, "IsDiscontinued": true } ]
application/xml, text/xml
Sample:
<ArrayOfProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CoasterAPI.Products"> <Product> <AdditionalFieldList> <AdditionalField> <Field>sample string 1</Field> <Value>sample string 2</Value> </AdditionalField> <AdditionalField> <Field>sample string 1</Field> <Value>sample string 2</Value> </AdditionalField> </AdditionalFieldList> <AssemblyRequired>true</AssemblyRequired> <AssemblyType>sample string 30</AssemblyType> <AssemblyURL>sample string 31</AssemblyURL> <BoxSize> <Height>1</Height> <Length>1</Length> <Width>1</Width> </BoxSize> <BoxWeight>1</BoxWeight> <CatalogPage>sample string 22</CatalogPage> <CatalogYear>sample string 9</CatalogYear> <CategoryCode>sample string 12</CategoryCode> <CollectionCode>sample string 5</CollectionCode> <Components> <Component> <BoxSize> <Height>1</Height> <Length>1</Length> <Width>1</Width> </BoxSize> <BoxWeight>1</BoxWeight> <Cubes>1</Cubes> <Name>sample string 2</Name> <ProductNumber>sample string 1</ProductNumber> <Qty>4</Qty> <UPC>sample string 3</UPC> </Component> <Component> <BoxSize> <Height>1</Height> <Length>1</Length> <Width>1</Width> </BoxSize> <BoxWeight>1</BoxWeight> <Cubes>1</Cubes> <Name>sample string 2</Name> <ProductNumber>sample string 1</ProductNumber> <Qty>4</Qty> <UPC>sample string 3</UPC> </Component> </Components> <CountryOfOrigin>sample string 15</CountryOfOrigin> <Cubes>1</Cubes> <Description>sample string 3</Description> <FabricCleaningCode>sample string 23</FabricCleaningCode> <FabricColor>sample string 6</FabricColor> <GroupNumber>sample string 7</GroupNumber> <IsDiscontinued>true</IsDiscontinued> <LGE>sample string 29</LGE> <ListNextGenImages>sample string 16</ListNextGenImages> <MainColor>sample string 24</MainColor> <MainFinish>sample string 25</MainFinish> <MainMaterial>sample string 26</MainMaterial> <MaterialList> <Material> <Field>sample string 1</Field> <Value>sample string 2</Value> </Material> <Material> <Field>sample string 1</Field> <Value>sample string 2</Value> </Material> </MaterialList> <Materials>sample string 27</Materials> <MeasurementList> <Measurement> <Depth>1</Depth> <DeskClearance>1</DeskClearance> <Diameter>1</Diameter> <Height>1</Height> <Length>1</Length> <MaxDepth>1</MaxDepth> <MaxHeight>1</MaxHeight> <MaxWidth>1</MaxWidth> <PieceName>sample string 1</PieceName> <SeatDepth>1</SeatDepth> <SeatHeight>1</SeatHeight> <SeatWidth>1</SeatWidth> <Weight>1</Weight> <Width>1</Width> </Measurement> <Measurement> <Depth>1</Depth> <DeskClearance>1</DeskClearance> <Diameter>1</Diameter> <Height>1</Height> <Length>1</Length> <MaxDepth>1</MaxDepth> <MaxHeight>1</MaxHeight> <MaxWidth>1</MaxWidth> <PieceName>sample string 1</PieceName> <SeatDepth>1</SeatDepth> <SeatHeight>1</SeatHeight> <SeatWidth>1</SeatWidth> <Weight>1</Weight> <Width>1</Width> </Measurement> </MeasurementList> <Name>sample string 2</Name> <NumBoxes>20</NumBoxes> <NumImages>19</NumImages> <PackQty>21</PackQty> <PictureFullURLs>sample string 17</PictureFullURLs> <PieceCode>sample string 14</PieceCode> <ProductInfo> <Bullets xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Bullets> <Contents xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Contents> <Description>sample string 3</Description> <Features xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Features> <Highlights xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Highlights> <LGE>sample string 4</LGE> <ProductName>sample string 2</ProductName> <ProductNumber>sample string 1</ProductNumber> </ProductInfo> <ProductNumber>sample string 1</ProductNumber> <RelatedProductList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </RelatedProductList> <ShippingFreight>sample string 28</ShippingFreight> <StyleCode>sample string 4</StyleCode> <SubBrand>sample string 10</SubBrand> <SubCategoryCode>sample string 13</SubCategoryCode> <TypeOfPackaging>sample string 8</TypeOfPackaging> <UPC>sample string 11</UPC> <WebImageURLs>sample string 18</WebImageURLs> </Product> <Product> <AdditionalFieldList> <AdditionalField> <Field>sample string 1</Field> <Value>sample string 2</Value> </AdditionalField> <AdditionalField> <Field>sample string 1</Field> <Value>sample string 2</Value> </AdditionalField> </AdditionalFieldList> <AssemblyRequired>true</AssemblyRequired> <AssemblyType>sample string 30</AssemblyType> <AssemblyURL>sample string 31</AssemblyURL> <BoxSize> <Height>1</Height> <Length>1</Length> <Width>1</Width> </BoxSize> <BoxWeight>1</BoxWeight> <CatalogPage>sample string 22</CatalogPage> <CatalogYear>sample string 9</CatalogYear> <CategoryCode>sample string 12</CategoryCode> <CollectionCode>sample string 5</CollectionCode> <Components> <Component> <BoxSize> <Height>1</Height> <Length>1</Length> <Width>1</Width> </BoxSize> <BoxWeight>1</BoxWeight> <Cubes>1</Cubes> <Name>sample string 2</Name> <ProductNumber>sample string 1</ProductNumber> <Qty>4</Qty> <UPC>sample string 3</UPC> </Component> <Component> <BoxSize> <Height>1</Height> <Length>1</Length> <Width>1</Width> </BoxSize> <BoxWeight>1</BoxWeight> <Cubes>1</Cubes> <Name>sample string 2</Name> <ProductNumber>sample string 1</ProductNumber> <Qty>4</Qty> <UPC>sample string 3</UPC> </Component> </Components> <CountryOfOrigin>sample string 15</CountryOfOrigin> <Cubes>1</Cubes> <Description>sample string 3</Description> <FabricCleaningCode>sample string 23</FabricCleaningCode> <FabricColor>sample string 6</FabricColor> <GroupNumber>sample string 7</GroupNumber> <IsDiscontinued>true</IsDiscontinued> <LGE>sample string 29</LGE> <ListNextGenImages>sample string 16</ListNextGenImages> <MainColor>sample string 24</MainColor> <MainFinish>sample string 25</MainFinish> <MainMaterial>sample string 26</MainMaterial> <MaterialList> <Material> <Field>sample string 1</Field> <Value>sample string 2</Value> </Material> <Material> <Field>sample string 1</Field> <Value>sample string 2</Value> </Material> </MaterialList> <Materials>sample string 27</Materials> <MeasurementList> <Measurement> <Depth>1</Depth> <DeskClearance>1</DeskClearance> <Diameter>1</Diameter> <Height>1</Height> <Length>1</Length> <MaxDepth>1</MaxDepth> <MaxHeight>1</MaxHeight> <MaxWidth>1</MaxWidth> <PieceName>sample string 1</PieceName> <SeatDepth>1</SeatDepth> <SeatHeight>1</SeatHeight> <SeatWidth>1</SeatWidth> <Weight>1</Weight> <Width>1</Width> </Measurement> <Measurement> <Depth>1</Depth> <DeskClearance>1</DeskClearance> <Diameter>1</Diameter> <Height>1</Height> <Length>1</Length> <MaxDepth>1</MaxDepth> <MaxHeight>1</MaxHeight> <MaxWidth>1</MaxWidth> <PieceName>sample string 1</PieceName> <SeatDepth>1</SeatDepth> <SeatHeight>1</SeatHeight> <SeatWidth>1</SeatWidth> <Weight>1</Weight> <Width>1</Width> </Measurement> </MeasurementList> <Name>sample string 2</Name> <NumBoxes>20</NumBoxes> <NumImages>19</NumImages> <PackQty>21</PackQty> <PictureFullURLs>sample string 17</PictureFullURLs> <PieceCode>sample string 14</PieceCode> <ProductInfo> <Bullets xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Bullets> <Contents xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Contents> <Description>sample string 3</Description> <Features xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Features> <Highlights xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Highlights> <LGE>sample string 4</LGE> <ProductName>sample string 2</ProductName> <ProductNumber>sample string 1</ProductNumber> </ProductInfo> <ProductNumber>sample string 1</ProductNumber> <RelatedProductList xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </RelatedProductList> <ShippingFreight>sample string 28</ShippingFreight> <StyleCode>sample string 4</StyleCode> <SubBrand>sample string 10</SubBrand> <SubCategoryCode>sample string 13</SubCategoryCode> <TypeOfPackaging>sample string 8</TypeOfPackaging> <UPC>sample string 11</UPC> <WebImageURLs>sample string 18</WebImageURLs> </Product> </ArrayOfProduct>