Add Category

Adds a new category to the catalog’s category hierarchy. Specify a ParentCategoryID to determine where to locate the category in the hierarchy; if not specified it becomes a top-level 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”.

POST

commerce

catalog

admin

categories

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.

Query Parameters

incrementSequence

boolean

default:false

Sets the sequence number of the category to the current max sequence value plus 1 (e.g. 5 + 1 = 6)

useProvidedId

boolean

default:false

If true, the provided Id value will be used as the CategoryId. If omitted or false, the system will generate a CategoryId

responseFields

string

limits which fields are returned in the response body

Body

application/json

Properties of the new category. Required properties ParentCategoryID and Content.Name.

Category

activeDateEnd

string<date-time> | null

Active end Date

activeDateStart

string<date-time> | null

Active Start Date

attributes

object[] | null

List of attributes for the category.

Show child attributes

auditInfo

object

Show child attributes

catalogId

integer<int32> | null

The CatalogId that the category belongs to.

categoryCode

string | null

External unique identifier of the category.

categoryType

string | null

The Type of Category Static, Dyanmic, DynamicPreComputed

childCount

integer<int32> | null

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

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.

Show child attributes

dynamicExpression

object

Category

Show child attributes

integer<int32> | null

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

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.

localizedContent

object[] | null

Show child attributes

parentCategoryCode

string | null

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.

parentCategoryName

string | null

parentIsActive

boolean | null

productCount

integer<int32> | null

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

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.

shouldSlice

boolean | null

If True, search displays sliced view

Response

Category

activeDateEnd

string<date-time> | null

Active end Date

activeDateStart

string<date-time> | null

Active Start Date

attributes

object[] | null

List of attributes for the category.

Show child attributes

auditInfo

object

Show child attributes

catalogId

integer<int32> | null

The CatalogId that the category belongs to.

categoryCode

string | null

External unique identifier of the category.

categoryType

string | null

The Type of Category Static, Dyanmic, DynamicPreComputed

childCount

integer<int32> | null

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

content

object

Show child attributes

dynamicExpression

object

Category

Show child attributes

integer<int32> | null

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

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.

localizedContent

object[] | null

Show child attributes

parentCategoryCode

string | null

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.

parentCategoryName

string | null

parentIsActive

boolean | null

productCount

integer<int32> | null

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

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.

shouldSlice

boolean | null

If True, search displays sliced view

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
}

Developers

API reference

AI Tools

Add Category

Authorizations

Query Parameters

Body

Response