Categories

Categories are the primary tree-shaped taxonomy for every tenant. Each category can hold products directly or roll up its descendants' products (depending on the aggregate flag).

Endpoints

GET/api/b2b/pim/categoriesauth: session
GET/api/b2b/pim/categories/:slugauth: session
POST/api/b2b/pim/categoriesauth: session
PATCH/api/b2b/pim/categories/:slugauth: session
DELETE/api/b2b/pim/categories/:slugauth: session
POST/api/b2b/pim/categories/:slug/moveauth: session

Data shape

  • slug — tenant-unique stable identifier (URL-safe).
  • parent_slug — null for root categories.
  • nameMultiLangString.
  • seo{ title, description, og_image } per locale.
  • aggregate — whether this category rolls up descendant products for storefront listings.

Notes

  • Moving a category via the /move endpoint updates the path of every descendant in a single transaction.
  • Deleting a non-empty category returns 409 Conflict; either move its products/children first, or pass ?force=true (soft-archive).