GET api/product/GetProductDimensions?filterCode={filterCode}&itemNos={itemNos}&startRow={startRow}&endRow={endRow}
Get the product dimensions
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| filterCode | string |
None. |
|
| itemNos | string |
None. |
|
| startRow | string |
None. |
|
| endRow | string |
None. |
Body Parameters
None.
Response Information
Resource Description
Collection of ItemDimension| Name | Description | Type | Additional information |
|---|---|---|---|
| ItemNo | string |
None. |
|
| ItemName | string |
None. |
|
| Description | string |
None. |
|
| DescriptionShort | string |
None. |
|
| DescriptionLong | string |
None. |
|
| BoxWeight | decimal number |
None. |
|
| Cubes | decimal number |
None. |
|
| BoxSize | Dimension |
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:
[
{
"ItemNo": "sample string 1",
"ItemName": "sample string 2",
"Description": "sample string 3",
"DescriptionShort": "sample string 4",
"DescriptionLong": "sample string 5",
"BoxWeight": 6.1,
"Cubes": 7.1,
"BoxSize": {
"Length": 1.0,
"Width": 1.0,
"Height": 1.0
}
},
{
"ItemNo": "sample string 1",
"ItemName": "sample string 2",
"Description": "sample string 3",
"DescriptionShort": "sample string 4",
"DescriptionLong": "sample string 5",
"BoxWeight": 6.1,
"Cubes": 7.1,
"BoxSize": {
"Length": 1.0,
"Width": 1.0,
"Height": 1.0
}
}
]
application/xml, text/xml
Sample:
<ArrayOfItemDimension xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CoasterAPI.Products">
<ItemDimension>
<BoxSize>
<Height>1</Height>
<Length>1</Length>
<Width>1</Width>
</BoxSize>
<BoxWeight>6.1</BoxWeight>
<Cubes>7.1</Cubes>
<Description>sample string 3</Description>
<DescriptionLong>sample string 5</DescriptionLong>
<DescriptionShort>sample string 4</DescriptionShort>
<ItemName>sample string 2</ItemName>
<ItemNo>sample string 1</ItemNo>
</ItemDimension>
<ItemDimension>
<BoxSize>
<Height>1</Height>
<Length>1</Length>
<Width>1</Width>
</BoxSize>
<BoxWeight>6.1</BoxWeight>
<Cubes>7.1</Cubes>
<Description>sample string 3</Description>
<DescriptionLong>sample string 5</DescriptionLong>
<DescriptionShort>sample string 4</DescriptionShort>
<ItemName>sample string 2</ItemName>
<ItemNo>sample string 1</ItemNo>
</ItemDimension>
</ArrayOfItemDimension>