Skip to main content
PUT
/
commerce
/
catalog
/
admin
/
categories
/
{categoryId}
Error
A valid request URL is required to generate request examples
{
  "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 that you want to modify. Required.

Query Parameters

cascadeVisibility
boolean
default:false

If true, when changing the display option for the category, change it for all subcategories also. Optional.

responseFields
string

limits which fields are returned in the response body

Body

application/json

Properties of the category that you want to modify. Required properties ParentCategoryID and Content.Name.

Category

id
integer<int32> | null

Internal unique identifier of the category. System-supplied and read-only.

categoryType
string | null

The Type of Category Static, Dyanmic, DynamicPreComputed

catalogId
integer<int32> | null

The CatalogId that the category belongs to.

parentCategoryId
integer<int32> | null

Unique identifier of the category to which this category belongs. If nil, this is a top-level category. System-supplied and read-only.

parentCategoryCode
string | null
parentCategoryName
string | null
parentIsActive
boolean | null
categoryCode
string | null

External unique identifier of the category.

isActive
boolean | null

If false, the category is considered unavailable in runtime (default is true if not specified on create)

isDisplayed
boolean | null

If true, the category appears to shoppers on the storefront.

sequence
integer<int32> | null

Order in which categories appear when they are at the same level (siblings). For example, you could change the sequence of categories so that a specific category always appears first.

content
object

Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a category in multiple languages yet manage it as a single category internally.

localizedContent
object[] | null

Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a category in multiple languages yet manage it as a single category internally.

dynamicExpression
object

Category

productCount
integer<int32> | null

Number of products contained in this category. This count includes all products contained in any subcategories of this category.

childCount
integer<int32> | null

Number of subcategories that belong to this category. These subcategories are at the same level (siblings).

auditInfo
object
shouldSlice
boolean | null

If True, search displays sliced view

activeDateStart
string<date-time> | null

Active Start Date

activeDateEnd
string<date-time> | null

Active end Date

attributes
object[] | null

List of attributes for the category.

Response

Success

Category

id
integer<int32> | null

Internal unique identifier of the category. System-supplied and read-only.

categoryType
string | null

The Type of Category Static, Dyanmic, DynamicPreComputed

catalogId
integer<int32> | null

The CatalogId that the category belongs to.

parentCategoryId
integer<int32> | null

Unique identifier of the category to which this category belongs. If nil, this is a top-level category. System-supplied and read-only.

parentCategoryCode
string | null
parentCategoryName
string | null
parentIsActive
boolean | null
categoryCode
string | null

External unique identifier of the category.

isActive
boolean | null

If false, the category is considered unavailable in runtime (default is true if not specified on create)

isDisplayed
boolean | null

If true, the category appears to shoppers on the storefront.

sequence
integer<int32> | null

Order in which categories appear when they are at the same level (siblings). For example, you could change the sequence of categories so that a specific category always appears first.

content
object

Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a category in multiple languages yet manage it as a single category internally.

localizedContent
object[] | null

Container for language-specific content to display on the storefront. You'll have a container for each supported language (LocaleCode). This enables you to display a category in multiple languages yet manage it as a single category internally.

dynamicExpression
object

Category

productCount
integer<int32> | null

Number of products contained in this category. This count includes all products contained in any subcategories of this category.

childCount
integer<int32> | null

Number of subcategories that belong to this category. These subcategories are at the same level (siblings).

auditInfo
object
shouldSlice
boolean | null

If True, search displays sliced view

activeDateStart
string<date-time> | null

Active Start Date

activeDateEnd
string<date-time> | null

Active end Date

attributes
object[] | null

List of attributes for the category.