Skip to main content

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 (or send null) for a root node. On restore, this must match the soft-deleted category's original parent — omit it or send null to keep the original parent, or supply the same value; a different value returns 400 REPARENT_NOT_SUPPORTED; re-parenting is not supported. On restore an explicit null is treated the same as omission (keep the original parent), not as a request to make the category a root.

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