API reference
- Getting Started with Your API
- SDKs and Toolkits
- Catalog Administration Overview
- POSTAdd Products to Category
- GETGet Categories
- POSTAdd Category
- GETGet Category
- PUTUpdate Category
- DELDelete Category
- GETGet Category Attribute
- PUTUpdate Category Attribute
- DELDelete Category Attribute
- GETGet Category Attributes
- POSTAdd Category Attribute
- GETGet Child Categories
- POSTRemove Products from Category
- GETSearch Category Attributes
- POSTValidate Dynamic Category Expression
- POSTValidate Realtime Dynamic Category Expression
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
}Update Category
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
JWT Authorization header using the Bearer scheme.
Path Parameters
Unique identifier of the category that you want to modify. Required.
Query Parameters
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
Body
Properties of the category that you want to modify. Required properties ParentCategoryID and Content.Name.
Category
Active end Date
Active Start Date
List of attributes for the category.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The CatalogId that the category belongs to.
External unique identifier of the category.
The Type of Category Static, Dyanmic, DynamicPreComputed
Number of subcategories that belong to this category. These subcategories are at the same level (siblings).
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
Show child attributes
Category
Show child attributes
Show child attributes
Internal unique identifier of the category. System-supplied and read-only.
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.
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
Show child attributes
Unique identifier of the category to which this category belongs. If nil, this is a top-level category. System-supplied and read-only.
Number of products contained in this category. This count includes all products contained in any subcategories of this category.
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.
If True, search displays sliced view
Response
Success
Category
Active end Date
Active Start Date
List of attributes for the category.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The CatalogId that the category belongs to.
External unique identifier of the category.
The Type of Category Static, Dyanmic, DynamicPreComputed
Number of subcategories that belong to this category. These subcategories are at the same level (siblings).
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
Show child attributes
Category
Show child attributes
Show child attributes
Internal unique identifier of the category. System-supplied and read-only.
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.
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
Show child attributes
Unique identifier of the category to which this category belongs. If nil, this is a top-level category. System-supplied and read-only.
Number of products contained in this category. This count includes all products contained in any subcategories of this category.
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.
If True, search displays sliced view