Home > @vsf-enterprise/bigcommerce-api > ProductOption

# ProductOption interface

Definition of product options

Signature:

export interface ProductOption 

# Properties

Property Type Description
config ProductOptionConfig | ProductOptionConfig[] The values for option config can vary based on the Modifier created.
display_name string The name of the option shown on the storefront.
id number The unique numerical ID of the option, increments sequentially.
name string Product option name.
option_values ProductOptionValue[] Array of the possible values for the option
product_id number The unique numerical ID of the product to which the option belongs.
sort_order number Order in which the option is displayed on the storefront.
type ProductOptionType The type of option, which determines how it will display on the storefront. Acceptable values: * radio_buttons, * rectangles, * dropdown, * product_list, * product_list_with_images, * swatch.For reference, the former v2 API values are: * RB = radio_buttons, * RT = rectangles, * S = dropdown, * P = product_list, * PI = product_list_with_images, * CS = swatch.