Skip to main content
GET
/
commerce
/
catalog
/
admin
/
categories
/
{categoryId}
/
children
Error
A valid request URL is required to generate request examples
{
  "totalCount": 123,
  "items": [
    {
      "id": 123,
      "categoryType": "<string>",
      "catalogId": 123,
      "parentCategoryId": 123,
      "parentCategoryCode": "<string>",
      "parentCategoryName": "<string>",
      "parentIsActive": true,
      "categoryCode": "<string>",
      "isActive": true,
      "isDisplayed": true,
      "sequence": 123,
      "content": {
        "categoryImages": [
          {
            "id": 123,
            "localeCode": "<string>",
            "imageLabel": "<string>",
            "altText": "<string>",
            "imageUrl": "<string>",
            "cmsId": "<string>",
            "videoUrl": "<string>",
            "mediaType": "<string>",
            "sequence": 123
          }
        ],
        "name": "<string>",
        "description": "<string>",
        "pageTitle": "<string>",
        "localeCode": "<string>",
        "metaTagTitle": "<string>",
        "metaTagDescription": "<string>",
        "metaTagKeywords": "<string>",
        "slug": "<string>"
      },
      "localizedContent": [
        {
          "categoryImages": [
            {
              "id": 123,
              "localeCode": "<string>",
              "imageLabel": "<string>",
              "altText": "<string>",
              "imageUrl": "<string>",
              "cmsId": "<string>",
              "videoUrl": "<string>",
              "mediaType": "<string>",
              "sequence": 123
            }
          ],
          "name": "<string>",
          "description": "<string>",
          "pageTitle": "<string>",
          "localeCode": "<string>",
          "metaTagTitle": "<string>",
          "metaTagDescription": "<string>",
          "metaTagKeywords": "<string>",
          "slug": "<string>"
        }
      ],
      "dynamicExpression": {
        "text": "<string>",
        "tree": {
          "type": "<string>",
          "logicalOperator": "<string>",
          "nodes": "<array>",
          "left": "<string>",
          "operator": "<string>",
          "right": "<unknown>"
        }
      },
      "productCount": 123,
      "childCount": 123,
      "auditInfo": {
        "updateDate": "2023-11-07T05:31:56Z",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "createBy": "<string>"
      },
      "shouldSlice": true,
      "activeDateStart": "2023-11-07T05:31:56Z",
      "activeDateEnd": "2023-11-07T05:31:56Z",
      "attributes": [
        {
          "fullyQualifiedName": "<string>",
          "attributeDefinitionId": 123,
          "values": [
            "<unknown>"
          ]
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

categoryId
integer<int32>
required

Unique identifier of the category whose subcategories you want to get.

Query Parameters

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