# Create an option

> Add an option to a product.
{/* generated:versioned-pages - edit _pm-authored, not this file */}

`POST /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 /api/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                                                                                                      |
| ----------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------------- |
| `Flowkiwi-Locale` | `string` | -        | Specifies the locale for properties that support localization. If not provided, the default locale will be used. |

## Path parameters

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

## Request body

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

## Response

**201** - Product Option resource created

| Property    | Type               | Required | Description                                                                                                              |
| ----------- | ------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `@context`  | `string \| object` | -        |                                                                                                                          |
| `@id`       | `string`           | Yes      |                                                                                                                          |
| `@type`     | `string`           | Yes      |                                                                                                                          |
| `createdAt` | `string`           | -        | The date and time when the resource was created (ISO 8601 format).                                                       |
| `id`        | `string`           | -        | The resource's unique identifier (UUID).                                                                                 |
| `position`  | `integer`          | -        | The position of the product option. Use -1 to put the product option at the end.                                         |
| `product`   | `string \| null`   | Yes      | The `Product` to which this option belongs. Requires the `products:read` scope. Returned null when the scope is missing. |
| `title`     | `string \| null`   | -        | **This property supports translations.**<br><br>The name of the product option.                                          |
| `updatedAt` | `string`           | -        | The date and time when the resource was last modified (ISO 8601 format).                                                 |

## Errors

**400** - Invalid input

| Property      | Type               | Required | Description                                                                                                                          |
| ------------- | ------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `@context`    | `string \| object` | -        |                                                                                                                                      |
| `@id`         | `string`           | Yes      |                                                                                                                                      |
| `@type`       | `string`           | Yes      |                                                                                                                                      |
| `code`        | `string`           | -        | Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only.                |
| `description` | `string \| null`   | -        |                                                                                                                                      |
| `detail`      | `string \| null`   | -        | A human-readable explanation specific to this occurrence of the problem.                                                             |
| `instance`    | `string \| null`   | -        | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. |
| `message`     | `string`           | -        | End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only.      |
| `slug`        | `string`           | -        | Stable, readable key of the error in the error code catalogue. Present on catalogued errors only.                                    |
| `status`      | `integer \| null`  | -        |                                                                                                                                      |
| `title`       | `string \| null`   | -        | A short, human-readable summary of the problem. For a catalogued error it repeats the `slug`.                                        |
| `type`        | `string`           | -        | A URI reference that identifies the problem type. For a catalogued error it is the error code resource, `/api/error-codes/{code}`.   |

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

| Property             | Type               | Required | Description                                                                                                            |
| -------------------- | ------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| `@context`           | `string \| object` | -        |                                                                                                                        |
| `@id`                | `string`           | Yes      |                                                                                                                        |
| `@type`              | `string`           | Yes      |                                                                                                                        |
| `detail`             | `string`           | -        |                                                                                                                        |
| `missingPermissions` | `string[]`         | -        | Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission. |
| `status`             | `integer`          | -        |                                                                                                                        |
| `title`              | `string`           | -        |                                                                                                                        |
| `type`               | `string`           | -        |                                                                                                                        |

**422** - An error occurred

| Property      | Type               | Required | Description |
| ------------- | ------------------ | -------- | ----------- |
| `@context`    | `string \| object` | -        |             |
| `@id`         | `string`           | Yes      |             |
| `@type`       | `string`           | Yes      |             |
| `description` | `string`           | -        |             |
| `detail`      | `string`           | -        |             |
| `instance`    | `string \| null`   | -        |             |
| `status`      | `integer`          | -        |             |
| `title`       | `string \| null`   | -        |             |
| `type`        | `string`           | -        |             |
| `violations`  | `object[]`         | -        |             |

## Examples

### Example request

```bash
curl -X POST 'https://<tenant>.product-management.flowkiwi.net/api/products/<product_id>/product_options' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Flowkiwi-Api-Version: unstable' \
  -H 'Accept: application/ld+json' \
  -H 'Content-Type: application/ld+json' \
  -d '{
  "position": -1,
  "title": "Color"
}'
```

### Example response

```json
{
  "@context": "/api/contexts/Product%20Option",
  "@id": "/api/products/019af93e-420e-79f8-800b-6680f03dce20/product_options/f56f6668-8fca-5c23-ae2d-186853d17bdc",
  "@type": "Product Option",
  "createdAt": "2024-01-01T00:00:00+00:00",
  "id": "f56f6668-8fca-5c23-ae2d-186853d17bdc",
  "position": 2,
  "product": "/api/products/019af93e-420e-79f8-800b-6680f03dce20",
  "title": "Color",
  "updatedAt": "2024-01-01T00:00:00+00:00"
}
```