CategoryCreateRequest

Request body for creating or restoring a category.

customIdstringrequired

Client-defined identifier. Must be unique within the org.

Possible values: <= 128 characters

Example: footwear

namestringrequired

Display name of the category.

Possible values: <= 255 characters

Example: Footwear

descriptionstring

Free-text description. Defaults to empty string.

Possible values: <= 5000 characters

Default value:

Example: All footwear products

businessIdstringrequired

Business identifier. Must be unique among live siblings at this level. Immutable after creation — ignored on restore.

Possible values: <= 32 characters

Example: FW-001

parentCustomIdstringnullable

Custom ID of the parent category at the level immediately above. Omit for a root node. Ignored on restore (re-parenting is not allowed).

Example: apparel

CategoryCreateRequest

{
  "customId": "footwear",
  "name": "Footwear",
  "description": "All footwear products",
  "businessId": "FW-001",
  "parentCustomId": "apparel"
}