# Create a collection

> Create a new 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`  | Yes      | 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`         | Yes      | 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`         | Yes      |                                                                                                                                                                                 |
| `@type`     | `string`         | Yes      |                                                                                                                                                                                 |
| `id`        | `string`         | -        | The resource's unique identifier (UUID).                                                                                                                                        |
| `status`    | `string`         | -        | The status of the collection.                                                                                                                                                   |
| `name`      | `string \| null` | -        | **This property supports translations.**<br><br>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`         | Yes      |                                                                                                                                      |
| `@type`    | `string`         | Yes      |                                                                                                                                      |
| `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.

| Property             | Type       | Required | Description                                                                                                                                |
| -------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
| `@context`           | `object`   | -        |                                                                                                                                            |
| `@id`                | `string`   | Yes      |                                                                                                                                            |
| `@type`              | `string`   | Yes      |                                                                                                                                            |
| `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`         | Yes      |             |
| `@type`      | `string`         | Yes      |             |
| `status`     | `integer`        | -        |             |
| `violations` | `object[]`       | -        |             |
| `detail`     | `string`         | -        |             |
| `type`       | `string`         | -        |             |
| `title`      | `string \| null` | -        |             |
| `instance`   | `string \| null` | -        |             |

## Examples

### Example request

```bash
curl -X POST 'https://<tenant>.product-management.flowkiwi.net/rest/api/collections' \
  -H 'Authorization: Bearer {token}' \
  -H 'X-Flowkiwi-Organization-Id: <org_id>' \
  -H 'Accept: application/ld+json' \
  -H 'Content-Type: application/ld+json' \
  -d '{
  "status": "/rest/api/statuses/ACTIVE",
  "name": "Summer 2026",
  "parent": "/rest/api/collections/019af8b0-1a2b-7c3d-8e4f-0a1b2c3d4e5f",
  "products": [
    "/rest/api/products/019af93e-420e-79f8-800b-6680f03dce20",
    "/rest/api/products/019af9a1-7c2d-7e64-9b0a-1f2e3d4c5b6a"
  ],
  "childrens": [
    "/rest/api/collections/019af9b2-1d3e-7a45-8c2b-6d7e8f90a1b2",
    "/rest/api/collections/019af9b2-9e4f-7b56-9d3c-7e8f90a1b2c3"
  ]
}'
```

### Example response

```json
{
  "@context": "string",
  "@id": "string",
  "@type": "Collection",
  "id": "019af93e-420e-79f8-800b-6680f03dce20",
  "status": "/rest/api/statuses/DRAFT",
  "name": "Summer 2026",
  "parent": "/rest/api/collections/00000000-0000-0000-0000-000000000000",
  "products": [
    "/rest/api/products/019af93e-420e-79f8-800b-6680f03dce20",
    "/rest/api/products/019af9a1-7c2d-7e64-9b0a-1f2e3d4c5b6a"
  ],
  "childrens": [
    "/rest/api/collections/019af9b2-1d3e-7a45-8c2b-6d7e8f90a1b2",
    "/rest/api/collections/019af9b2-9e4f-7b56-9d3c-7e8f90a1b2c3"
  ],
  "createdAt": "2026-01-15T10:00:00+00:00",
  "updatedAt": "2026-01-15T10:00:00+00:00"
}
```