Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "activeDateEnd": "2023-11-07T05:31:56Z",
      "activeDateStart": "2023-11-07T05:31:56Z",
      "attributes": [
        {
          "attributeDefinitionId": 123,
          "fullyQualifiedName": "<string>",
          "values": [
            "<unknown>"
          ]
        }
      ],
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "catalogId": 123,
      "categoryCode": "<string>",
      "categoryType": "<string>",
      "childCount": 123,
      "content": {
        "categoryImages": [
          {
            "altText": "<string>",
            "cmsId": "<string>",
            "id": 123,
            "imageLabel": "<string>",
            "imageUrl": "<string>",
            "localeCode": "<string>",
            "mediaType": "<string>",
            "sequence": 123,
            "videoUrl": "<string>"
          }
        ],
        "description": "<string>",
        "localeCode": "<string>",
        "metaTagDescription": "<string>",
        "metaTagKeywords": "<string>",
        "metaTagTitle": "<string>",
        "name": "<string>",
        "pageTitle": "<string>",
        "slug": "<string>"
      },
      "dynamicExpression": {
        "text": "<string>",
        "tree": {
          "left": "<string>",
          "logicalOperator": "<string>",
          "nodes": "<array>",
          "operator": "<string>",
          "right": "<unknown>",
          "type": "<string>"
        }
      },
      "id": 123,
      "isActive": true,
      "isDisplayed": true,
      "localizedContent": [
        {
          "categoryImages": [
            {
              "altText": "<string>",
              "cmsId": "<string>",
              "id": 123,
              "imageLabel": "<string>",
              "imageUrl": "<string>",
              "localeCode": "<string>",
              "mediaType": "<string>",
              "sequence": 123,
              "videoUrl": "<string>"
            }
          ],
          "description": "<string>",
          "localeCode": "<string>",
          "metaTagDescription": "<string>",
          "metaTagKeywords": "<string>",
          "metaTagTitle": "<string>",
          "name": "<string>",
          "pageTitle": "<string>",
          "slug": "<string>"
        }
      ],
      "parentCategoryCode": "<string>",
      "parentCategoryId": 123,
      "parentCategoryName": "<string>",
      "parentIsActive": true,
      "productCount": 123,
      "sequence": 123,
      "shouldSlice": true
    }
  ],
  "totalCount": 123
}

Get Child Categories

Retrieves the immediate subcategories of a category. This current version of the Categories API includes localizedContent to support multi-locale catalogs, which was not present in the previous API model. If you were a client prior to May 2024 and have upgraded your implementation to support this feature, you can still access category data that has not yet been rewritten to the new model by providing an x-api-version header set to “1”.

GET

commerce

catalog

admin

categories

{categoryId}

children

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "activeDateEnd": "2023-11-07T05:31:56Z",
      "activeDateStart": "2023-11-07T05:31:56Z",
      "attributes": [
        {
          "attributeDefinitionId": 123,
          "fullyQualifiedName": "<string>",
          "values": [
            "<unknown>"
          ]
        }
      ],
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "catalogId": 123,
      "categoryCode": "<string>",
      "categoryType": "<string>",
      "childCount": 123,
      "content": {
        "categoryImages": [
          {
            "altText": "<string>",
            "cmsId": "<string>",
            "id": 123,
            "imageLabel": "<string>",
            "imageUrl": "<string>",
            "localeCode": "<string>",
            "mediaType": "<string>",
            "sequence": 123,
            "videoUrl": "<string>"
          }
        ],
        "description": "<string>",
        "localeCode": "<string>",
        "metaTagDescription": "<string>",
        "metaTagKeywords": "<string>",
        "metaTagTitle": "<string>",
        "name": "<string>",
        "pageTitle": "<string>",
        "slug": "<string>"
      },
      "dynamicExpression": {
        "text": "<string>",
        "tree": {
          "left": "<string>",
          "logicalOperator": "<string>",
          "nodes": "<array>",
          "operator": "<string>",
          "right": "<unknown>",
          "type": "<string>"
        }
      },
      "id": 123,
      "isActive": true,
      "isDisplayed": true,
      "localizedContent": [
        {
          "categoryImages": [
            {
              "altText": "<string>",
              "cmsId": "<string>",
              "id": 123,
              "imageLabel": "<string>",
              "imageUrl": "<string>",
              "localeCode": "<string>",
              "mediaType": "<string>",
              "sequence": 123,
              "videoUrl": "<string>"
            }
          ],
          "description": "<string>",
          "localeCode": "<string>",
          "metaTagDescription": "<string>",
          "metaTagKeywords": "<string>",
          "metaTagTitle": "<string>",
          "name": "<string>",
          "pageTitle": "<string>",
          "slug": "<string>"
        }
      ],
      "parentCategoryCode": "<string>",
      "parentCategoryId": 123,
      "parentCategoryName": "<string>",
      "parentIsActive": true,
      "productCount": 123,
      "sequence": 123,
      "shouldSlice": true
    }
  ],
  "totalCount": 123
}

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

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

items

object[] | null

Show child attributes

totalCount

integer<int32>

Add Category Attribute

Remove Products from Category