Create a category

post /rest/api/categories

Creates a Category resource.

Creates a category. Give it a name and a status, and optionally a parent to nest it under an existing category, plus the products to classify under it.

Headers

Name	Type	Required	Description
X-Flowkiwi-Organization-Id	string	required	The organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.
X-Flowkiwi-Locale	string	-	Specifies the locale for properties that support localization. If not provided, the default locale will be used.
X-Flowkiwi-Locale-Fallback	boolean	-	Enables the use of a fallback locale. If a property lacks a translation for the requested locale, the value from the default locale will be used.

Request body

Property	Type	Required	Description
status	string	required	The status of the category.
name	string | null	-	The name of the category.
parent	Category.CategoryCreateInput | null	-	The parent Category to which this category belongs, if any.
Show parent fields Property Type Required Description status string required The status of the category. name string | null - The name of the category. parent Category.CategoryCreateInput | null - The parent Category to which this category belongs, if any. Show parent fields Property Type Required Description status string required The status of the category. name string | null - The name of the category. parent Category.CategoryCreateInput | null - The parent Category to which this category belongs, if any. products Product.ProductCreateInput[] - List of products associated with the category. childrens Category.CategoryCreateInput[] - A list of direct child Category IRIs nested under this category. products Product.ProductCreateInput[] - List of products associated with the category. childrens Category.CategoryCreateInput[] - A list of direct child Category IRIs nested under this category. Show childrens fields Property Type Required Description status string required The status of the category. name string | null - The name of the category. parent Category.CategoryCreateInput | null - The parent Category to which this category belongs, if any. products Product.ProductCreateInput[] - List of products associated with the category. childrens Category.CategoryCreateInput[] - A list of direct child Category IRIs nested under this category.
products	Product.ProductCreateInput[]	-	List of products associated with the category.
childrens	Category.CategoryCreateInput[]	-	A list of direct child Category IRIs nested under this category.
Show childrens fields Property Type Required Description status string required The status of the category. name string | null - The name of the category. parent Category.CategoryCreateInput | null - The parent Category to which this category belongs, if any. Show parent fields Property Type Required Description status string required The status of the category. name string | null - The name of the category. parent Category.CategoryCreateInput | null - The parent Category to which this category belongs, if any. products Product.ProductCreateInput[] - List of products associated with the category. childrens Category.CategoryCreateInput[] - A list of direct child Category IRIs nested under this category. products Product.ProductCreateInput[] - List of products associated with the category. childrens Category.CategoryCreateInput[] - A list of direct child Category IRIs nested under this category. Show childrens fields Property Type Required Description status string required The status of the category. name string | null - The name of the category. parent Category.CategoryCreateInput | null - The parent Category to which this category belongs, if any. products Product.ProductCreateInput[] - List of products associated with the category. childrens Category.CategoryCreateInput[] - A list of direct child Category IRIs nested under this category.

Response

201 - Category resource created

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
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).

Errors

400 - Invalid input

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
title	string | null	-	A short, human-readable summary of the problem.
detail	string | null	-	A human-readable explanation specific to this occurrence of the problem.
status	number | null	-
instance	string | null	-	A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
type	string	-	A URI reference that identifies the problem type

403 - Access denied. The caller is missing one or more identity permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
type	string	-
title	string	-
status	integer	-
detail	string	-
missingPermissions	string[]	-	Identity permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied identity:* permission.

422 - An error occurred

Property	Type	Required	Description
@context	object	-
@id	string	required
@type	string	required
status	integer	-
violations	object[]	-
Show violations fields Property Type Required Description propertyPath string required The property path of the violation message string required The message associated with the violation code string - The code of the violation hint string - An extra hint to understand the violation payload object - The serialized payload of the violation
detail	string	-
type	string	-
title	string | null	-
instance	string | null	-