Skip to main content

Category

A taxonomy category. Always addressed by customId.

customIdstringrequired

Client-defined custom identifier of the category.

Example: footwear
namestringrequired

Display name of the category.

Example: Footwear
descriptionstringnullable

Free-text description. May be an empty string.

Example: All footwear products
businessIdstringnullable

Business identifier of the category (stored as the taxonomy level's business-id attribute). Empty string when the level has no business-id attribute or none was set. Immutable after creation.

Example: FW-001
parentCustomIdstringnullable

Custom ID of the parent category (one level up). Null for a root node.

Example: apparel
taxonomyLevelCustomIdstringrequired

Custom ID of the taxonomy level this category belongs to.

Example: product_line
taxonomyCustomIdstring

Custom ID of the taxonomy the level belongs to.

Example: product
lastUpdatedSourcestringnullable

Origin of the last write (e.g. api, manual).

Example: api
createdAtdate-time

Creation timestamp (ISO 8601).

Example: 2026-06-15T10:30:00Z
updatedAtdate-time

Last-update timestamp (ISO 8601).

Example: 2026-06-20T14:45:00Z
Category
{
  "customId": "footwear",
  "name": "Footwear",
  "description": "All footwear products",
  "businessId": "FW-001",
  "parentCustomId": "apparel",
  "taxonomyLevelCustomId": "product_line",
  "taxonomyCustomId": "product",
  "lastUpdatedSource": "api",
  "createdAt": "2026-06-15T10:30:00Z",
  "updatedAt": "2026-06-20T14:45:00Z"
}