# Create a product

> Create a new product in your catalog.

`POST /rest/api/products`

Creates a Product resource.

Creates a single product in the current organization. The product is returned with all read-only fields (id, timestamps, derived state) populated. You can also create initial channel assignments, collections and variants in the same call.

> **Default status**
>
> New products are created in their default status (typically `draft`). Promote them to `active` with a `PATCH` once they're ready to surface to your channels.

## 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`                             | -        | Status IRI controlling visibility. Optional - defaults to a draft status when omitted.             |
| `vendor`      | `string \| null`                     | -        | Brand or manufacturer the product is attributed to.                                                |
| `title`       | `string \| null`                     | -        | Customer-facing product title. Translatable - set the active locale with `X-Flowkiwi-Locale`.      |
| `description` | `string \| null`                     | -        | Long-form description. Markdown is not parsed by the API.                                          |
| `tags`        | `string \| null`                     | -        | Comma-separated list of free-form tags. Used for storefront filtering.                             |
| `category`    | `string \| null`                     | -        | Category IRI this product is attached to. Categories drive the attribute set.                      |
| `channels`    | `Channel.ChannelCreateInput[]`       | -        | List of Channel write inputs. Each entry assigns the product to a channel at creation time.        |
| `collections` | `Collection.CollectionCreateInput[]` | -        | List of Collection write inputs. Each entry attaches the product to a collection at creation time. |
| `medias`      | `Media[]`                            | -        | List of Media write inputs (ordered). Only images are accepted. Position determines display order. |

## Response

**201** - Product resource created

| Property          | Type             | Required | Description                                                                                                                                                                                                                                                                                                   |
| ----------------- | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `@context`        | `object`         | -        |                                                                                                                                                                                                                                                                                                               |
| `@id`             | `string`         | Yes      |                                                                                                                                                                                                                                                                                                               |
| `@type`           | `string`         | Yes      |                                                                                                                                                                                                                                                                                                               |
| `id`              | `string`         | -        | Stable UUID of the product.                                                                                                                                                                                                                                                                                   |
| `status`          | `string`         | -        | The status of the product.                                                                                                                                                                                                                                                                                    |
| `vendor`          | `string \| null` | -        | The name of the product's vendor.                                                                                                                                                                                                                                                                             |
| `title`           | `string \| null` | -        | **This property supports translations.**<br><br>The name of the product.                                                                                                                                                                                                                                      |
| `description`     | `string \| null` | -        | **This property supports translations.**<br><br>A description of the product.                                                                                                                                                                                                                                 |
| `tags`            | `string \| null` | -        | A string of comma-separated tags.                                                                                                                                                                                                                                                                             |
| `variants`        | `string[]`       | -        | A list of `Variant`, each one representing a variant associated with the product. Serialized as IRI strings by default; pass `?expand=variants` to embed the full `Variant` objects (including `resolvedPrice`, `lowestPriceLast30Days`, `medias`, and `metafields` when composed with `?expand=metafields`). |
| `options`         | `string[]`       | -        | A list of `Product Option`, each one representing an option associated with the product. Serialized as IRI strings by default; pass `?expand=options` to embed the full `Product Option` objects.                                                                                                             |
| `category`        | `string \| null` | -        | The category to which this product belongs. Serialized as IRI string by default; pass `?expand=category` to embed the full `CategoryResource`.                                                                                                                                                                |
| `attributeValues` | `array`          | -        | A list of `Attribute Values`, each one representing an attribute value associated with the product.                                                                                                                                                                                                           |
| `channels`        | `string[]`       | -        | A list of `Channel`, each one representing a channel associated with the product. Serialized as IRI strings by default; pass `?expand=channels` to embed full `ChannelResource` objects.                                                                                                                      |
| `collections`     | `string[]`       | -        | A list of `Collection`, each one representing a collection associated with the product. Serialized as IRI strings by default; pass `?expand=collections` to embed full `CollectionResource` objects.                                                                                                          |
| `medias`          | `string[]`       | -        | A list of `Media`, ordered by position. Only media of type "image" can be associated with a product. Returned as IRI strings by default; pass `?expand=medias` to embed full `Media` objects.                                                                                                                 |
| `metafields`      | `string[]`       | -        | Metafields owned by this product. Serialized as IRI strings by default; pass `?expand=metafields` to embed full `MetafieldResource` objects.                                                                                                                                                                  |
| `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/products' \
  -H 'Authorization: Bearer {token}' \
  -H 'X-Flowkiwi-Organization-Id: <org_id>' \
  -H 'Accept: application/ld+json' \
  -H 'Content-Type: application/ld+json' \
  -d '{
  "title": "Premium Organic Cotton T-Shirt",
  "description": "Comfortable and sustainable t-shirt made from 100% organic cotton",
  "vendor": "EcoWear",
  "status": "/rest/api/statuses/ACTIVE",
  "tags": "organic,sustainable,cotton,premium",
  "category": "/rest/api/categories/37dd98c9-4b5d-5b42-a3df-76dbe2887489",
  "channels": [
    "/rest/api/channels/01ab5462-1ac2-542b-9718-b6dd5125462e"
  ],
  "collections": [
    "/rest/api/collections/b03a00f0-3dee-510f-9dc8-80053f152bde"
  ]
}'
```

### Example response

```json
{
  "@context": "/rest/api/contexts/Product",
  "@id": "/rest/api/Products/29a817eb-b097-5329-ae12-87884ae31e10",
  "@type": "Product",
  "id": "29a817eb-b097-5329-ae12-87884ae31e10",
  "status": "/rest/api/statuses/DRAFT",
  "vendor": "EcoWear",
  "title": "Premium Organic Cotton T-Shirt",
  "description": "Comfortable and sustainable t-shirt made from 100% organic cotton. Available in multiple colors.",
  "tags": "organic,sustainable,cotton,apparel",
  "variants": [],
  "options": [],
  "images": [],
  "category": null,
  "attributeValues": [],
  "channels": [],
  "collections": [],
  "createdAt": "2024-01-01T00:00:00+00:00",
  "updatedAt": "2024-01-01T00:00:00+00:00"
}
```