Create a collection

post /rest/api/collections

Creates a Collection resource.

Creates a collection in the current organization. Give it a name and a status, optionally nest it under a parent, and attach products in the same call.

Nesting

Set parent to another collection’s IRI to place this collection under it. Leave it unset for a top-level collection.

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 collection.
name	string | null	-	The display name of the collection.
parent	string	-	The parent Collection to which this collection belongs, if any.
products	string[]	-	A list of Product IRIs the collection groups together.
childrens	string[]	-	A list of direct child Collection IRIs nested under this collection.

Response

201 - Collection 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 collection.
name	string | null	-	This property supports translations. The display name of the collection.
parent	string | null	-	The parent Collection to which this collection belongs, if any. Serialized as IRI string by default; pass ?expand=parent to embed the direct parent (one level only).
products	string[]	-	A list of Product IRIs the collection groups together.
childrens	string[]	-	A list of direct child Collection IRIs nested under this collection. Serialized as IRI strings by default; pass ?expand=children to embed direct children (one level only).
createdAt	string	-	The date and time when the resource was created (ISO 8601 format).
updatedAt	string	-	The date and time when the resource was last modified (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	-