Error

A valid request URL is required to generate request examples

{
  "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
}

Get Category

Retrieves the details of a single 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}

Error

A valid request URL is required to generate request examples

{
  "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
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme.

Path Parameters

categoryId

integer<int32>

required

Unique identifier of the category.

Query Parameters

includeAttributes

boolean

default:false

responseFields

string

limits which fields are returned in the response body

Authorizations

Path Parameters

Query Parameters

Response