GET api/v3/products/GetProductList?filterCode={filterCode}&startRow={startRow}&endRow={endRow}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| filterCode | string |
None. |
|
| startRow | string |
None. |
|
| endRow | string |
None. |
Body Parameters
None.
Response Information
Resource Description
ProductList| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalProducts | integer |
None. |
|
| Products | Products |
None. |
|
| DateLastSync | string |
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:
{
"TotalProducts": 1,
"Products": {
"Product": [
{
"ProductNumber": "sample string 1",
"ProductName": "sample string 2",
"ProductTitle": "sample string 3",
"ParentTitle": "sample string 4",
"LongDescription": "sample string 5",
"LGE": "sample string 6",
"ProductInfo": {
"ProductNumber": "sample string 1",
"ProductName": "sample string 2",
"Description": "sample string 3",
"LGE": "sample string 4",
"ItemContent": [
"sample string 1",
"sample string 2"
],
"Bullets": [
"sample string 1",
"sample string 2"
]
},
"ItemType": "sample string 7",
"StyleCode": "sample string 8",
"CollectionCode": "sample string 9",
"FabricContent": "sample string 10",
"GroupNumber": "sample string 11",
"TypeOfPackaging": "sample string 12",
"CatalogYear": "sample string 13",
"UPC": "sample string 14",
"CategoryCode": "sample string 15",
"SubCategoryCode": "sample string 16",
"PieceCode": "sample string 17",
"Prop65": "sample string 18",
"CountryOfOrigin": "sample string 19",
"ListNextGenImages": "sample string 20",
"PictureFullURLs": "sample string 21",
"WebImageURLs": "sample string 22",
"NumImages": 23,
"NumBoxes": 24,
"PackQty": 25,
"CatalogPage": "sample string 26",
"FabricCleaningCode": "sample string 27",
"MainColor": "sample string 28",
"ColorFamily": "sample string 29",
"WeightLimitsOverall": "sample string 30",
"ShelfWeightLimit": "sample string 31",
"DrawerWeightLimit": "sample string 32",
"BedSlats": 33,
"SlatType": "sample string 34",
"MainFinish": "sample string 35",
"MainMaterial": "sample string 36",
"GrossWeight": 1.0,
"GrossWeightTotal": 1.0,
"Cubes": 1.0,
"CartonDimensions": {
"Length": 1.0,
"Width": 1.0,
"Height": 1.0
},
"Features": [
{
"Field": "sample string 1",
"Value": "sample string 2"
},
{
"Field": "sample string 1",
"Value": "sample string 2"
}
],
"MaterialList": [
{
"Field": "sample string 1",
"Value": "sample string 2"
},
{
"Field": "sample string 1",
"Value": "sample string 2"
}
],
"ProductDimensions": [
{
"PieceName": "sample string 1",
"Length": 1.0,
"Width": 1.0,
"MaxWidth": 1.0,
"Depth": 1.0,
"MaxDepth": 1.0,
"Height": 1.0,
"MaxHeight": 1.0,
"Diameter": 1.0,
"SeatHeight": 1.0,
"SeatWidth": 1.0,
"SeatDepth": 1.0,
"Weight": 1.0,
"DeskClearance": 1.0
},
{
"PieceName": "sample string 1",
"Length": 1.0,
"Width": 1.0,
"MaxWidth": 1.0,
"Depth": 1.0,
"MaxDepth": 1.0,
"Height": 1.0,
"MaxHeight": 1.0,
"Diameter": 1.0,
"SeatHeight": 1.0,
"SeatWidth": 1.0,
"SeatDepth": 1.0,
"Weight": 1.0,
"DeskClearance": 1.0
}
],
"AdditionalFieldList": [
{
"Field": "sample string 1",
"Value": "sample string 2"
},
{
"Field": "sample string 1",
"Value": "sample string 2"
}
],
"Materials": "sample string 37",
"ShipMethod": "sample string 38",
"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
}
],
"RelatedProducts": [
"sample string 1",
"sample string 2"
],
"AssemblyRequired": true,
"AssemblyType": "sample string 40",
"AssemblyURL": "sample string 41",
"IsDiscontinued": true,
"ItemContent": [
"sample string 1",
"sample string 2"
],
"Bullets": [
"sample string 1",
"sample string 2"
]
},
{
"ProductNumber": "sample string 1",
"ProductName": "sample string 2",
"ProductTitle": "sample string 3",
"ParentTitle": "sample string 4",
"LongDescription": "sample string 5",
"LGE": "sample string 6",
"ProductInfo": {
"ProductNumber": "sample string 1",
"ProductName": "sample string 2",
"Description": "sample string 3",
"LGE": "sample string 4",
"ItemContent": [
"sample string 1",
"sample string 2"
],
"Bullets": [
"sample string 1",
"sample string 2"
]
},
"ItemType": "sample string 7",
"StyleCode": "sample string 8",
"CollectionCode": "sample string 9",
"FabricContent": "sample string 10",
"GroupNumber": "sample string 11",
"TypeOfPackaging": "sample string 12",
"CatalogYear": "sample string 13",
"UPC": "sample string 14",
"CategoryCode": "sample string 15",
"SubCategoryCode": "sample string 16",
"PieceCode": "sample string 17",
"Prop65": "sample string 18",
"CountryOfOrigin": "sample string 19",
"ListNextGenImages": "sample string 20",
"PictureFullURLs": "sample string 21",
"WebImageURLs": "sample string 22",
"NumImages": 23,
"NumBoxes": 24,
"PackQty": 25,
"CatalogPage": "sample string 26",
"FabricCleaningCode": "sample string 27",
"MainColor": "sample string 28",
"ColorFamily": "sample string 29",
"WeightLimitsOverall": "sample string 30",
"ShelfWeightLimit": "sample string 31",
"DrawerWeightLimit": "sample string 32",
"BedSlats": 33,
"SlatType": "sample string 34",
"MainFinish": "sample string 35",
"MainMaterial": "sample string 36",
"GrossWeight": 1.0,
"GrossWeightTotal": 1.0,
"Cubes": 1.0,
"CartonDimensions": {
"Length": 1.0,
"Width": 1.0,
"Height": 1.0
},
"Features": [
{
"Field": "sample string 1",
"Value": "sample string 2"
},
{
"Field": "sample string 1",
"Value": "sample string 2"
}
],
"MaterialList": [
{
"Field": "sample string 1",
"Value": "sample string 2"
},
{
"Field": "sample string 1",
"Value": "sample string 2"
}
],
"ProductDimensions": [
{
"PieceName": "sample string 1",
"Length": 1.0,
"Width": 1.0,
"MaxWidth": 1.0,
"Depth": 1.0,
"MaxDepth": 1.0,
"Height": 1.0,
"MaxHeight": 1.0,
"Diameter": 1.0,
"SeatHeight": 1.0,
"SeatWidth": 1.0,
"SeatDepth": 1.0,
"Weight": 1.0,
"DeskClearance": 1.0
},
{
"PieceName": "sample string 1",
"Length": 1.0,
"Width": 1.0,
"MaxWidth": 1.0,
"Depth": 1.0,
"MaxDepth": 1.0,
"Height": 1.0,
"MaxHeight": 1.0,
"Diameter": 1.0,
"SeatHeight": 1.0,
"SeatWidth": 1.0,
"SeatDepth": 1.0,
"Weight": 1.0,
"DeskClearance": 1.0
}
],
"AdditionalFieldList": [
{
"Field": "sample string 1",
"Value": "sample string 2"
},
{
"Field": "sample string 1",
"Value": "sample string 2"
}
],
"Materials": "sample string 37",
"ShipMethod": "sample string 38",
"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
}
],
"RelatedProducts": [
"sample string 1",
"sample string 2"
],
"AssemblyRequired": true,
"AssemblyType": "sample string 40",
"AssemblyURL": "sample string 41",
"IsDiscontinued": true,
"ItemContent": [
"sample string 1",
"sample string 2"
],
"Bullets": [
"sample string 1",
"sample string 2"
]
}
]
},
"DateLastSync": "sample string 2"
}
application/xml, text/xml
Sample:
<ProductList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CoasterWebAPI.ProductsV3">
<DateLastSync>sample string 2</DateLastSync>
<Products>
<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 40</AssemblyType>
<AssemblyURL>sample string 41</AssemblyURL>
<BedSlats>33</BedSlats>
<Bullets xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</Bullets>
<CartonDimensions>
<Height>1</Height>
<Length>1</Length>
<Width>1</Width>
</CartonDimensions>
<CatalogPage>sample string 26</CatalogPage>
<CatalogYear>sample string 13</CatalogYear>
<CategoryCode>sample string 15</CategoryCode>
<CollectionCode>sample string 9</CollectionCode>
<ColorFamily>sample string 29</ColorFamily>
<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 19</CountryOfOrigin>
<Cubes>1</Cubes>
<DrawerWeightLimit>sample string 32</DrawerWeightLimit>
<FabricCleaningCode>sample string 27</FabricCleaningCode>
<FabricContent>sample string 10</FabricContent>
<Features>
<Features>
<Field>sample string 1</Field>
<Value>sample string 2</Value>
</Features>
<Features>
<Field>sample string 1</Field>
<Value>sample string 2</Value>
</Features>
</Features>
<GrossWeight>1</GrossWeight>
<GrossWeightTotal>1</GrossWeightTotal>
<GroupNumber>sample string 11</GroupNumber>
<IsDiscontinued>true</IsDiscontinued>
<ItemContent xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</ItemContent>
<ItemType>sample string 7</ItemType>
<LGE>sample string 6</LGE>
<ListNextGenImages>sample string 20</ListNextGenImages>
<LongDescription>sample string 5</LongDescription>
<MainColor>sample string 28</MainColor>
<MainFinish>sample string 35</MainFinish>
<MainMaterial>sample string 36</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 37</Materials>
<NumBoxes>24</NumBoxes>
<NumImages>23</NumImages>
<PackQty>25</PackQty>
<ParentTitle>sample string 4</ParentTitle>
<PictureFullURLs>sample string 21</PictureFullURLs>
<PieceCode>sample string 17</PieceCode>
<ProductDimensions>
<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>
</ProductDimensions>
<ProductInfo>
<Bullets xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</Bullets>
<Description>sample string 3</Description>
<ItemContent xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</ItemContent>
<LGE>sample string 4</LGE>
<ProductName>sample string 2</ProductName>
<ProductNumber>sample string 1</ProductNumber>
</ProductInfo>
<ProductName>sample string 2</ProductName>
<ProductNumber>sample string 1</ProductNumber>
<ProductTitle>sample string 3</ProductTitle>
<Prop65>sample string 18</Prop65>
<RelatedProducts xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</RelatedProducts>
<ShelfWeightLimit>sample string 31</ShelfWeightLimit>
<ShipMethod>sample string 38</ShipMethod>
<SlatType>sample string 34</SlatType>
<StyleCode>sample string 8</StyleCode>
<SubCategoryCode>sample string 16</SubCategoryCode>
<TypeOfPackaging>sample string 12</TypeOfPackaging>
<UPC>sample string 14</UPC>
<WebImageURLs>sample string 22</WebImageURLs>
<WeightLimitsOverall>sample string 30</WeightLimitsOverall>
</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 40</AssemblyType>
<AssemblyURL>sample string 41</AssemblyURL>
<BedSlats>33</BedSlats>
<Bullets xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</Bullets>
<CartonDimensions>
<Height>1</Height>
<Length>1</Length>
<Width>1</Width>
</CartonDimensions>
<CatalogPage>sample string 26</CatalogPage>
<CatalogYear>sample string 13</CatalogYear>
<CategoryCode>sample string 15</CategoryCode>
<CollectionCode>sample string 9</CollectionCode>
<ColorFamily>sample string 29</ColorFamily>
<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 19</CountryOfOrigin>
<Cubes>1</Cubes>
<DrawerWeightLimit>sample string 32</DrawerWeightLimit>
<FabricCleaningCode>sample string 27</FabricCleaningCode>
<FabricContent>sample string 10</FabricContent>
<Features>
<Features>
<Field>sample string 1</Field>
<Value>sample string 2</Value>
</Features>
<Features>
<Field>sample string 1</Field>
<Value>sample string 2</Value>
</Features>
</Features>
<GrossWeight>1</GrossWeight>
<GrossWeightTotal>1</GrossWeightTotal>
<GroupNumber>sample string 11</GroupNumber>
<IsDiscontinued>true</IsDiscontinued>
<ItemContent xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</ItemContent>
<ItemType>sample string 7</ItemType>
<LGE>sample string 6</LGE>
<ListNextGenImages>sample string 20</ListNextGenImages>
<LongDescription>sample string 5</LongDescription>
<MainColor>sample string 28</MainColor>
<MainFinish>sample string 35</MainFinish>
<MainMaterial>sample string 36</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 37</Materials>
<NumBoxes>24</NumBoxes>
<NumImages>23</NumImages>
<PackQty>25</PackQty>
<ParentTitle>sample string 4</ParentTitle>
<PictureFullURLs>sample string 21</PictureFullURLs>
<PieceCode>sample string 17</PieceCode>
<ProductDimensions>
<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>
</ProductDimensions>
<ProductInfo>
<Bullets xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</Bullets>
<Description>sample string 3</Description>
<ItemContent xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d6p1:string>sample string 1</d6p1:string>
<d6p1:string>sample string 2</d6p1:string>
</ItemContent>
<LGE>sample string 4</LGE>
<ProductName>sample string 2</ProductName>
<ProductNumber>sample string 1</ProductNumber>
</ProductInfo>
<ProductName>sample string 2</ProductName>
<ProductNumber>sample string 1</ProductNumber>
<ProductTitle>sample string 3</ProductTitle>
<Prop65>sample string 18</Prop65>
<RelatedProducts xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>sample string 1</d5p1:string>
<d5p1:string>sample string 2</d5p1:string>
</RelatedProducts>
<ShelfWeightLimit>sample string 31</ShelfWeightLimit>
<ShipMethod>sample string 38</ShipMethod>
<SlatType>sample string 34</SlatType>
<StyleCode>sample string 8</StyleCode>
<SubCategoryCode>sample string 16</SubCategoryCode>
<TypeOfPackaging>sample string 12</TypeOfPackaging>
<UPC>sample string 14</UPC>
<WebImageURLs>sample string 22</WebImageURLs>
<WeightLimitsOverall>sample string 30</WeightLimitsOverall>
</Product>
</Product>
</Products>
<TotalProducts>1</TotalProducts>
</ProductList>