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>"
]
}
]
}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>"
]
}
]
}JWT Authorization header using the Bearer scheme.
Unique identifier of the category that you want to modify. Required.
If true, when changing the display option for the category, change it for all subcategories also. Optional.
limits which fields are returned in the response body
Properties of the category that you want to modify. Required properties ParentCategoryID and Content.Name.
Category
Internal unique identifier of the category. System-supplied and read-only.
The Type of Category Static, Dyanmic, DynamicPreComputed
The CatalogId that the category belongs to.
Unique identifier of the category to which this category belongs. If nil, this is a top-level category. System-supplied and read-only.
External unique identifier of the category.
If false, the category is considered unavailable in runtime (default is true if not specified on create)
If true, the category appears to shoppers on the storefront.
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.
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.
Show child attributes
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.
Show child attributes
Category
Show child attributes
Number of products contained in this category. This count includes all products contained in any subcategories of this category.
Number of subcategories that belong to this category. These subcategories are at the same level (siblings).
Show child attributes
If True, search displays sliced view
Active Start Date
Active end Date
List of attributes for the category.
Show child attributes
Success
Category
Internal unique identifier of the category. System-supplied and read-only.
The Type of Category Static, Dyanmic, DynamicPreComputed
The CatalogId that the category belongs to.
Unique identifier of the category to which this category belongs. If nil, this is a top-level category. System-supplied and read-only.
External unique identifier of the category.
If false, the category is considered unavailable in runtime (default is true if not specified on create)
If true, the category appears to shoppers on the storefront.
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.
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.
Show child attributes
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.
Show child attributes
Category
Show child attributes
Number of products contained in this category. This count includes all products contained in any subcategories of this category.
Number of subcategories that belong to this category. These subcategories are at the same level (siblings).
Show child attributes
If True, search displays sliced view
Active Start Date
Active end Date
List of attributes for the category.
Show child attributes