# Create an option value

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

`POST /api/option_values`

Creates a Option Value resource.

Creates a value on a [Product Option](/api/product-management/options/) - for example *Medium* on a *Size* option. Point it at the option with the `productOption` IRI.

> **Linking to an option**
>
> `productOption` is the IRI of the option this value belongs to, e.g. `/api/product_options/{productOptionId}`. The value's `position` controls its order within that option.

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

## Request body

| Property        | Type              | Required | Description                                                                                                                                                          |
| --------------- | ----------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `position`      | `integer \| null` | -        | The position of the option value. Use -1 to put the option value at the end.                                                                                         |
| `productOption` | `string \| null`  | Yes      | The `Product Option` to which this option value belongs. Requires the `products:read` scope. Returned null when the scope is missing.                                |
| `value`         | `string \| null`  | Yes      | The value of the option.                                                                                                                                             |
| `variants`      | `string[]`        | -        | A list of `Variant`, each one representing a variant associated with the option value. Requires the `products:read` scope. Returned empty when the scope is missing. |

## Response

**201** - Option Value 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`           | -        |                                                                                                                                                                      |
| `position`      | `integer \| null`  | -        | The position of the option value. Use -1 to put the option value at the end.                                                                                         |
| `productOption` | `string \| null`   | Yes      | The `Product Option` to which this option value belongs. Requires the `products:read` scope. Returned null when the scope is missing.                                |
| `updatedAt`     | `string`           | -        | The date and time when the resource was last modified (ISO 8601 format).                                                                                             |
| `value`         | `string \| null`   | Yes      | **This property supports translations.**<br><br>The value of the option.                                                                                             |
| `variants`      | `string[]`         | -        | A list of `Variant`, each one representing a variant associated with the option value. Requires the `products:read` scope. Returned empty when the scope is missing. |

## 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/option_values' \
  -H 'Authorization: Bearer {access_token}' \
  -H 'Flowkiwi-Api-Version: unstable' \
  -H 'Accept: application/ld+json' \
  -H 'Content-Type: application/ld+json' \
  -d '{
  "productOption": "/api/products/019af93e-420e-79f8-800b-6680f03dce20/product_options/019af941-6b7c-7d8e-9f0a-2b3c4d5e6f70",
  "value": "Large",
  "variants": [
    "/api/products/019af93e-420e-79f8-800b-6680f03dce20/variants/b41c0169-dd12-5fe5-bbbe-b8d55192d7eb",
    "/api/products/019af93e-420e-79f8-800b-6680f03dce20/variants/cbd04bfe-8d8a-5118-83ea-b834a40fb82a"
  ]
}'
```

### Example response

```json
{
  "@context": "/api/contexts/Option%20Value",
  "@id": "/api/product_options/019af941-6b7c-7d8e-9f0a-2b3c4d5e6f70/option_values/1aa93653-0d77-5dbb-ae5e-03d19221b819",
  "@type": "Option Value",
  "createdAt": "2024-01-01T00:00:00+00:00",
  "id": "1aa93653-0d77-5dbb-ae5e-03d19221b819",
  "position": 0,
  "productOption": "/api/products/019af93e-420e-79f8-800b-6680f03dce20/product_options/019af941-6b7c-7d8e-9f0a-2b3c4d5e6f70",
  "updatedAt": "2024-01-01T00:00:00+00:00",
  "value": "Large",
  "variants": [
    "/api/products/019af93e-420e-79f8-800b-6680f03dce20/variants/54f1c7e4-396b-544c-b538-6c5e7a6d5267",
    "/api/products/019af93e-420e-79f8-800b-6680f03dce20/variants/ef81bc02-91a8-5df8-a58b-8af7acecdea8"
  ]
}
```
