Skip to main content
GET
/
commerce
/
catalog
/
storefront
/
categories
/
tree
Error
A valid request URL is required to generate request examples
{
  "totalCount": 123,
  "items": [
    {
      "categoryId": 123,
      "parentCategory": {},
      "content": {
        "categoryImages": [
          {
            "imageLabel": "<string>",
            "altText": "<string>",
            "imageUrl": "<string>",
            "cmsId": "<string>",
            "videoUrl": "<string>",
            "mediaType": "<string>",
            "sequence": 123
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "pageTitle": "<string>",
        "metaTagTitle": "<string>",
        "metaTagDescription": "<string>",
        "metaTagKeywords": "<string>",
        "slug": "<string>"
      },
      "childrenCategories": [
        {}
      ],
      "sequence": 123,
      "isDisplayed": true,
      "categoryCode": "<string>",
      "count": 123,
      "updateDate": "2023-11-07T05:31:56Z",
      "shouldSlice": true,
      "attributes": [
        {
          "fullyQualifiedName": "<string>",
          "dataType": 123,
          "values": [
            "<unknown>"
          ]
        }
      ]
    }
  ]
}

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

Success

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

totalCount
integer<int32>
items
object[] | null