Category Output

Output representation of the category definition.

JSON Example

1"categories": [
2    {
3      "catalogId": "0ZS1Q000000XbZAWA0",
4      "code": "B2B Category",
5      "description": "Products Category",
6      "hasSubCategories": true,
7      "id": "0ZG1Q000000XbVGWA0",
8      "name": "Unified Computing",
9      "numberOfProducts": 2,
10      "parentCategoryId": "0ZGT100000000qlOAA",
11      "sortOrder": 2,
12      "subCategories": [],
13      "isNavigational: false
14    }
15  ]

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`catalogId`	String	ID of the catalog that the category is associated with.	Small, 60.0	60.0
`code`	String	Unique code of the product category.	Small, 60.0	60.0
`description`	String	Description of the category. If data translation is set up and specified in the org, the translated description is available.	Small, 60.0	60.0
`hasSubCategories`	Boolean	Indicates whether the subcategories are available (true) or not (false).	Small, 60.0	60.0
`id`	String	ID of the category.	Small, 60.0	60.0
`isNavigational`	Boolean	Indicates whether the category node is navigational (`true`) or not (`false`).	Small, 62.0	62.0
`name`	String	Name of the category. If data translation is set up and specified in the org, the translated name is available.	Small, 60.0	60.0
`numberOfProducts`	Integer	Number of products associated with the category.	Small, 60.0	60.0
`parentCategoryId`	String	ID of the parent category.	Small, 60.0	60.0
`sortOrder`	Integer	Display order of the product category relative to the siblings with the same parent category.	Small, 60.0	60.0
`subCategories`	Category Output[]	List of subcategories, if available. This property is returned with the Categories List (GET) API response.	Small, 60.0	60.0