# Create an option

> Add an option to a product.

`POST /rest/api/products/{productId}/product_options`

Creates a Product Option resource.

Creates an option on the given product - a new dimension such as *Size* or *Color*. The option starts empty; add its values with [`POST /option_values`](/api/product-management/option-values/create/) once it exists.

> **Positioning**
>
> Use `position` to control where the option appears in the product's option list. Pass `-1` to place it last.

## 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. |

## Path parameters

| Name        | Type     | Required | Description                |
| ----------- | -------- | -------- | -------------------------- |
| `productId` | `string` | Yes      | ProductResource identifier |

## Request body

| Property   | Type              | Required | Description                                                                      |
| ---------- | ----------------- | -------- | -------------------------------------------------------------------------------- |
| `title`    | `string \| null`  | Yes      | The name of the product option.                                                  |
| `position` | `integer \| null` | -        | The position of the product option. Use -1 to put the product option at the end. |

## Response

**201** - Product Option resource created

| Property    | Type             | Required | Description                                                                      |
| ----------- | ---------------- | -------- | -------------------------------------------------------------------------------- |
| `@context`  | `object`         | -        |                                                                                  |
| `@id`       | `string`         | Yes      |                                                                                  |
| `@type`     | `string`         | Yes      |                                                                                  |
| `id`        | `string`         | -        | The resource's unique identifier (UUID).                                         |
| `title`     | `string \| null` | -        | **This property supports translations.**<br><br>The name of the product option.  |
| `position`  | `integer`        | -        | The position of the product option. Use -1 to put the product option at the end. |
| `product`   | `string`         | Yes      | The `Product` to which this option belongs.                                      |
| `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/<product_id>/product_options' \
  -H 'Authorization: Bearer {token}' \
  -H 'X-Flowkiwi-Organization-Id: <org_id>' \
  -H 'Accept: application/ld+json' \
  -H 'Content-Type: application/ld+json' \
  -d '{
  "title": "Color",
  "position": -1
}'
```

### Example response

```json
{
  "@context": "/rest/api/contexts/ProductOption",
  "@id": "/rest/api/ProductOptions/6972c186-df4f-5b54-be0f-bcbe3e956787",
  "@type": "ProductOption",
  "id": "6972c186-df4f-5b54-be0f-bcbe3e956787",
  "title": "Color",
  "position": 0,
  "product": "/rest/api/products/babd67a5-c315-5981-b5be-c40465e3d500",
  "createdAt": "2024-01-01T00:00:00+00:00",
  "updatedAt": "2024-01-01T00:00:00+00:00"
}
```