Shop It Docs
Developer ResourcescatalogCategory

Category Module - Feature List

Functional behavior of category admin and customer/mobile flows.

What This Module Does

  • creates and updates hierarchical categories
  • maintains slug continuity through slug history
  • supports soft delete + restore
  • supports parent-wise sibling reorder
  • exposes customer/mobile category browse and detail
  • tags categories by product kind for storefront filtering

Admin Features

FeatureBehavior
Create categoryGenerates unique slug, validates parent depth
Update categorySupports parent move and slug-history capture
Delete categorySoft delete only; blocked when active children exist
Restore categoryRestores deleted category with parent/depth validation
Reorder categoriesReorders only siblings under provided parentId
Include deleted viewAdmin list/detail supports includeDeleted=true
Product kind taggingAdmin can set productKind to physical, digital, or both

Customer/Mobile Features

FeatureBehavior
List categoriesVisible and active categories only
Category detail by slugCurrent slug first, then slug-history fallback
PaginationOptional; off by default
Filter by product kindproductKind=physical or productKind=digital; includes both categories automatically

Validation Rules

  • max depth = 3
  • no self-parent
  • no descendant-cycle parent move
  • reorder payload cannot contain duplicate ids
  • reorder ids must belong to provided parentId
  • productKind must be physical, digital, or both when provided (admin); physical or digital only (customer filter)

Product Kind Semantics

ValueMeaning
physicalCategory applies to physical products only
digitalCategory applies to digital products only
bothCategory applies to both physical and digital
nullUnconstrained — legacy or cross-kind category

When a customer filters by productKind=physical, the API returns categories tagged physical and categories tagged both. Same logic applies for digital.

IT Mart Content Direction

Category examples and seed taxonomy are IT Mart aligned:

  • electronics -> laptops, gaming-laptops
  • accessories -> laptop-accessories
  • software -> software-licenses
  • warranty-care -> extended-warranty