v1

latestSwagger 2.02026-07-17148179252.3 KB
Catalog

Creates an Option.

post/catalog/products/{product_id}/options

Request body

idinteger nullable

The unique numerical ID of the option, increments sequentially.

product_idinteger

The unique numerical ID of the product to which the option belongs.

display_namestring

The name of the option shown on the storefront.

type'radio_buttons' | 'rectangles' | 'dropdown' | 'product_list' | 'product_list_with_images' | 'swatch'

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.

sort_orderinteger

The order the modifiers display on the product detail page.

Response

An Option object.

metaMeta

Empty meta object; may be used later.