GET api/product/GetProducts?filters={filters}
Get Coaster product information
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
filters | string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
Collection of ProductInfoName | Description | Type | Additional information |
---|---|---|---|
ProductNumber | string |
None. |
|
ProductName | string |
None. |
|
Description | string |
None. |
|
LGE | string |
None. |
|
ItemContent | Collection of string |
None. |
|
Bullets | Collection of 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:
[ { "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" ] }, { "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" ] } ]
application/xml, text/xml
Sample:
<ArrayOfProductInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CoasterAPI.Products"> <ProductInfo> <Bullets xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Bullets> <Contents xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Contents> <Description>sample string 3</Description> <Features xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Features> <Highlights xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Highlights> <LGE>sample string 4</LGE> <ProductName>sample string 2</ProductName> <ProductNumber>sample string 1</ProductNumber> </ProductInfo> <ProductInfo> <Bullets xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Bullets> <Contents xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Contents> <Description>sample string 3</Description> <Features xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Features> <Highlights xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Highlights> <LGE>sample string 4</LGE> <ProductName>sample string 2</ProductName> <ProductNumber>sample string 1</ProductNumber> </ProductInfo> </ArrayOfProductInfo>