GET api/v2/products/GetFilter?styleCode={styleCode}&collectionCode={collectionCode}&productLineCode={productLineCode}&categoryCode={categoryCode}&subcategoryCode={subcategoryCode}&pieceCode={pieceCode}&groupNumber={groupNumber}&productNumber={productNumber}&isDiscontinued={isDiscontinued}

Get a filter code that is used to filter the returned product list.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
styleCode

an optional comma-separated list of style codes (see GetStyleList)

string

None.

collectionCode

an optional comma-separated list of codes (see GetCollectionList)

string

None.

productLineCode

an optional comma-separated list of product line codes (see GetProductLineList)

string

None.

categoryCode

an optional comma-separated list of category codes (see GetCategoryList)

string

None.

subcategoryCode

an optional comma-separated list of subcategory codes (see GetCategoryList)

string

None.

pieceCode

an optional comma-separated list of piece codes (see GetCategoryList)

string

None.

groupNumber

an optional comma-separated list of group numbers

string

None.

productNumber

an optional comma-separated list of product numbers

string

None.

isDiscontinued

an optional boolean value

string

None.

Body Parameters

None.

Response Information

Resource Description

string

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:
"sample string 1"

application/xml, text/xml

Sample:
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>