Get Category Tree

Retrieves the list of product categories that appear on the storefront organized in a hierarchical format. Hidden categories do not appear in the list.

GET /commerce/catalog/storefront/categories/tree

Error

A valid request URL is required to generate request examples

200

{
  "items": [
    {
      "attributes": [
        {
          "dataType": 123,
          "fullyQualifiedName": "<string>",
          "values": [
            "<unknown>"
          ]
        }
      ],
      "categoryCode": "<string>",
      "categoryId": 123,
      "childrenCategories": [
        {}
      ],
      "content": {
        "categoryImages": [
          {
            "altText": "<string>",
            "cmsId": "<string>",
            "imageLabel": "<string>",
            "imageUrl": "<string>",
            "mediaType": "<string>",
            "sequence": 123,
            "videoUrl": "<string>"
          }
        ],
        "description": "<string>",
        "metaTagDescription": "<string>",
        "metaTagKeywords": "<string>",
        "metaTagTitle": "<string>",
        "name": "<string>",
        "pageTitle": "<string>",
        "slug": "<string>"
      },
      "count": 123,
      "isDisplayed": true,
      "parentCategory": {},
      "sequence": 123,
      "shouldSlice": true,
      "updateDate": "2023-11-07T05:31:56Z"
    }
  ],
  "totalCount": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Query Parameters

includeAttributes · boolean · default: false

Optional. If True, Return Category Attributes collection with Category

responseFields · string

limits which fields are returned in the response body

Response

200

application/json

OK

Collection of categories returned as a whole. A collection is not paged.

items · object[] | null

Show child attributes

totalCount · integer<int32>