GET api/v3/products/GetCategoryList

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Category

Name	Type	Additional information
CategoryCode	string	None.
CategoryName	string	None.
SubCategoryList	Collection of SubCategory	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:

[
  {
    "CategoryCode": "sample string 1",
    "CategoryName": "sample string 2",
    "SubCategoryList": [
      {
        "SubCategoryCode": "sample string 1",
        "SubCategoryName": "sample string 2",
        "PieceList": [
          {
            "PieceCode": "sample string 1",
            "PieceName": "sample string 2"
          },
          {
            "PieceCode": "sample string 1",
            "PieceName": "sample string 2"
          }
        ]
      },
      {
        "SubCategoryCode": "sample string 1",
        "SubCategoryName": "sample string 2",
        "PieceList": [
          {
            "PieceCode": "sample string 1",
            "PieceName": "sample string 2"
          },
          {
            "PieceCode": "sample string 1",
            "PieceName": "sample string 2"
          }
        ]
      }
    ]
  },
  {
    "CategoryCode": "sample string 1",
    "CategoryName": "sample string 2",
    "SubCategoryList": [
      {
        "SubCategoryCode": "sample string 1",
        "SubCategoryName": "sample string 2",
        "PieceList": [
          {
            "PieceCode": "sample string 1",
            "PieceName": "sample string 2"
          },
          {
            "PieceCode": "sample string 1",
            "PieceName": "sample string 2"
          }
        ]
      },
      {
        "SubCategoryCode": "sample string 1",
        "SubCategoryName": "sample string 2",
        "PieceList": [
          {
            "PieceCode": "sample string 1",
            "PieceName": "sample string 2"
          },
          {
            "PieceCode": "sample string 1",
            "PieceName": "sample string 2"
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CoasterAPI.Products">
  <Category>
    <CategoryCode>sample string 1</CategoryCode>
    <CategoryName>sample string 2</CategoryName>
    <SubCategoryList>
      <SubCategory>
        <PieceList>
          <Piece>
            <PieceCode>sample string 1</PieceCode>
            <PieceName>sample string 2</PieceName>
          </Piece>
          <Piece>
            <PieceCode>sample string 1</PieceCode>
            <PieceName>sample string 2</PieceName>
          </Piece>
        </PieceList>
        <SubCategoryCode>sample string 1</SubCategoryCode>
        <SubCategoryName>sample string 2</SubCategoryName>
      </SubCategory>
      <SubCategory>
        <PieceList>
          <Piece>
            <PieceCode>sample string 1</PieceCode>
            <PieceName>sample string 2</PieceName>
          </Piece>
          <Piece>
            <PieceCode>sample string 1</PieceCode>
            <PieceName>sample string 2</PieceName>
          </Piece>
        </PieceList>
        <SubCategoryCode>sample string 1</SubCategoryCode>
        <SubCategoryName>sample string 2</SubCategoryName>
      </SubCategory>
    </SubCategoryList>
  </Category>
  <Category>
    <CategoryCode>sample string 1</CategoryCode>
    <CategoryName>sample string 2</CategoryName>
    <SubCategoryList>
      <SubCategory>
        <PieceList>
          <Piece>
            <PieceCode>sample string 1</PieceCode>
            <PieceName>sample string 2</PieceName>
          </Piece>
          <Piece>
            <PieceCode>sample string 1</PieceCode>
            <PieceName>sample string 2</PieceName>
          </Piece>
        </PieceList>
        <SubCategoryCode>sample string 1</SubCategoryCode>
        <SubCategoryName>sample string 2</SubCategoryName>
      </SubCategory>
      <SubCategory>
        <PieceList>
          <Piece>
            <PieceCode>sample string 1</PieceCode>
            <PieceName>sample string 2</PieceName>
          </Piece>
          <Piece>
            <PieceCode>sample string 1</PieceCode>
            <PieceName>sample string 2</PieceName>
          </Piece>
        </PieceList>
        <SubCategoryCode>sample string 1</SubCategoryCode>
        <SubCategoryName>sample string 2</SubCategoryName>
      </SubCategory>
    </SubCategoryList>
  </Category>
</ArrayOfCategory>