# Categories

Products can be assigned to one or more categories which classify products into groups which could represent:

* Type of Product for example a "Toaster" category containing one or many Toasters.
* Products belonging to a special offer for example a "Special Deals" category contain one or many products with special pricing.
* Products assigned to be presented in a specific location within a channel, for example "Home Page Banner" for all products that are assigned to appear on a Banner on the Home Page of a website.

### Portal View

#### Accessing Categories 

Assess the **Categories** screen in the console via the console navigation bar.

<div align="left"><img src="/files/-M3pBXcviqnuMdpuUvog" alt=""></div>

#### Add New Category

Specified a Name for the category.

Click **New Category** to create the new category.

<div align="left"><img src="/files/-M3pBpaeP3e_dMrv0Eej" alt=""></div>

#### Edit Categories

Additional **Category Details** can be specified including:

![](/files/-M3pDX5RcJKVuQGRjD1r)

Click **Save** to commit your modifications.

### Category Properties

{% tabs %}
{% tab title="Attributes" %}

| Element         | Description                                                                                            |
| --------------- | ------------------------------------------------------------------------------------------------------ |
| categoryId      | Internal Identifier for the category                                                                   |
| name            | Name of the category                                                                                   |
| slug            | A Url slug to access the category                                                                      |
| description     | A Description for the category                                                                         |
| attributes      | One or more key/value pairs                                                                            |
| parent Category | A parent category to support the creation of a hierarchical/tree based structure of related categories |
| images          | Image (assets) assigned to a category                                                                  |
| {% endtab %}    |                                                                                                        |

{% tab title="Sample Object" %}

```
{
  "categoryId": "string",
  "version": "string",
  "slug": "string",
  "name": "string",
  "description": "string",
  "names": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "descriptions": {
    "additionalProp1": "string",
    "additionalProp2": "string",
    "additionalProp3": "string"
  },
  "parentId": "string",
  "parentName": "string",
  "itemCount": 0,
  "attributes": {},
  "children": [
    {
      "categoryId": "string",
      "name": "string",
      "slug": "string",
      "names": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "totalChildren": 0,
  "sibling": [
    {
      "categoryId": "string",
      "name": "string",
      "slug": "string",
      "names": {
        "additionalProp1": "string",
        "additionalProp2": "string",
        "additionalProp3": "string"
      }
    }
  ],
  "totalSibling": 0,
  "isActive": true,
  "files": [
    {
      "fileId": "string",
      "contentType": "string",
      "accessPermission": "string",
      "accessUrl": "string",
      "attributes": {},
      "edgeUrl": "string"
    }
  ]
}
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.simplestore.io/concepts/categories.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.