# List options

> Retrieve the options of a product.

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

Retrieves the collection of Product Option resources.

Returns the options declared on a product, ordered by `position`. Set the `X-Flowkiwi-Locale` header to read translatable `title` values in a given locale.

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

## Query parameters

| Name               | Type     | Required | Description |
| ------------------ | -------- | -------- | ----------- |
| `order[createdAt]` | `string` | -        |             |
| `order[updatedAt]` | `string` | -        |             |

## Response

**200** - Product Option collection

| Property           | Type               | Required | Description |
| ------------------ | ------------------ | -------- | ----------- |
| `hydra:totalItems` | `integer`          | -        |             |
| `hydra:search`     | `object`           | -        |             |
| `hydra:member`     | `Product.Option[]` | Yes      |             |

## Errors

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

## Examples

### Example request

```bash
curl -X GET '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'
```

### Example response

```json
{
  "hydra:member": [
    {
      "@context": "/rest/api/contexts/ProductOption",
      "@id": "/rest/api/ProductOptions/0e2a90f5-2786-5be7-b547-236978df7b8e",
      "@type": "ProductOption",
      "id": "0e2a90f5-2786-5be7-b547-236978df7b8e",
      "title": "Color",
      "position": 0,
      "product": "/rest/api/products/7c04bd02-d56d-5c4c-816e-dc4eda4382c6",
      "createdAt": "2024-01-01T00:00:00+00:00",
      "updatedAt": "2024-01-01T00:00:00+00:00"
    }
  ],
  "hydra:totalItems": 1
}
```