Categories
A Category classifies your products in a hierarchy. Each category has a translatable name, an optional parent, and its direct childrens - so categories form a tree (Apparel → Shoes → Running shoes). Products are assigned to categories through the category’s products list.
Categories also carry attributes - the properties that products in that category can describe themselves with (a material, a season, a heel height). Attributes come in two kinds, each documented separately:
- Attribute strings - free-text attributes, with string values.
- Attribute lists - attributes with a predefined set of options, as list values.
A category’s attributes field is the read-only union of both, also exposed on its own as Attributes.
The Category object
Section titled “The Category object”| Property | Type | Required | Description |
|---|---|---|---|
id | string | - | The resource's unique identifier (UUID). |
status | string | - | The status of the category. |
name | string | null | - | This property supports translations. The name of the category. |
parent | string | null | - | The parent Category to which this category belongs, if any. Serialized as IRI string by default; pass ?expand=parent to embed the direct parent (one level only). |
products | string[] | - | List of products associated with the category. |
childrens | string[] | - | A list of direct child Category, each one representing a category under this one. Serialized as IRI strings by default; pass ?expand=children to embed direct children (one level only). |
attributes | string[] | - | List of attributes associated with the category. |
createdAt | string | - | Creation date of the resource (ISO 8601 format). |
updatedAt | string | - | Last modification date of the resource (ISO 8601 format). |
Common workflows
Section titled “Common workflows”- Build the tree. Create top-level categories, then create child categories with a
parentpointing at them. - Classify products. Add products to a category’s
productslist. - Describe with attributes. Attach attribute strings or attribute lists to a category, then set their values on the category’s products.
Conventions
Section titled “Conventions”Authentication and headers
Section titled “Authentication and headers”All requests require an OAuth 2.0 bearer token:
Authorization: Bearer <token>For the translatable name, set the active locale:
Flowkiwi-Locale: fr-FRPartial updates
Section titled “Partial updates”PATCH uses JSON Merge Patch with Content-Type: application/merge-patch+json.