> This page is for Developer.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.bigcommerce.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.bigcommerce.com/_mcp/server.

# Product Options

## Options

Shared attributes that control value facets on a product.

> **Note**
>
> This is archived documentation. The V2 Catalog API is deprecated. For current API documentation, see the [Catalog API](/developer/docs/admin/catalog-and-inventory).

#### Options Object Properties

| Name          | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| ------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name          | string  | Required field. The option's name, as used internally. Must be unique.                                                                                                                                                                                                                                                                                                                                                                                        |
| display\_name | string  | Optional field. The option's name, as displayed on the storefront. Defaults to same value as `name`. However, a custom value can be defined here, and can be reused among multiple options.                                                                                                                                                                                                                                                                   |
| type          | string  | Optional field. The type of option, which determines how it will display on the storefront. Acceptable values:  `C`: Checkbox; `D`: Date field; `F`: File upload field; `MT`: Multi-line text field; `RB`: Radio buttons; `RT`: Rectangular boxes (for product sizes); `S`: Select/drop-down list; `C`: Numbers-only text field; `P`: Product Pick list; `CS`: Color/texture Swatch (option values of this type don't support `is_default`); `T`: Text field. |
| values        | object  | Optional field. Object containing option values: a `url` and a `resource`.                                                                                                                                                                                                                                                                                                                                                                                    |
| product\_id   | integer | Optional field; read-only. If `null`, this option can be reused with any product. If populated with a numeric ID, this option can be used exclusively with the corresponding product.                                                                                                                                                                                                                                                                         |

#### List Product Options

Gets the options associated with a product.

`GET /stores/{store_hash}/v2/products/{product_id}/options`

### Filters

There are no filter parameters specific to product options.

### Pagination

Parameters can be added to the URL query string to paginate the collection. The maximum limit is 250. If a limit isn't provided, up to 50 product\_options are returned by default.

| Parameter | Type | Example                                               |
| --------- | ---- | ----------------------------------------------------- |
| page      | int  | `/api/v2/products/{product_id}/options?page={number}` |
| limit     | int  | `/api/v2/products/{product_id}/options?limit={count}` |

### Response

Example JSON returned in the response:

```json showLineNumbers={false}
[
  {
    "id": 13,
    "option_id": 8,
    "display_name": "iPod Capacities",
    "sort_order": 0,
    "is_required": true
  },
  {
    "id": 14,
    "option_id": 9,
    "display_name": "Accessories",
    "sort_order": 1,
    "is_required": false
  }
]
```

#### Get a Product Option

Gets an option associated with a product.

`GET /stores/{store_hash}/v2/products/{product_id}/options/{id}`

### Response

Example JSON returned in the response:

```json showLineNumbers={false}
{
  "id": 14,
  "option_id": 9,
  "display_name": "Accessories",
  "sort_order": 1,
  "is_required": false
}
```