Create Option

POST {{baseUrl}}/products/:product/options

You can create a new option for a specific product by providing the ID of the product you want to create the option for in the product path parameter.

Note: For product.type=product creating new product option will generate a new variant for this option.

Request Body

{"id"=>"<number>", "name"=>"<string>", "display_type"=>"<string>", "values"=>[{"name"=>"<string>", "price"=>"<number>", "quantity"=>"<integer>", "display_value"=>"<string>", "is_default"=>"<boolean>"}]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: Created

{&quot;status&quot;:&quot;\u003cnumber\u003e&quot;,&quot;success&quot;:&quot;\u003cboolean\u003e&quot;,&quot;data&quot;:{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;description&quot;:&quot;\u003cstring\u003e&quot;,&quot;type&quot;:&quot;checkbox&quot;,&quot;required&quot;:&quot;\u003cboolean\u003e&quot;,&quot;associated_with_order_time&quot;:&quot;\u003cinteger,boolean\u003e&quot;,&quot;sort&quot;:&quot;\u003cinteger\u003e&quot;,&quot;display_type&quot;:&quot;image&quot;,&quot;visibility&quot;:&quot;always&quot;,&quot;visibility_condition_type&quot;:&quot;!=&quot;,&quot;visibility_condition_option&quot;:&quot;\u003cinteger\u003e&quot;,&quot;visibility_condition_value&quot;:&quot;\u003cinteger\u003e&quot;,&quot;values&quot;:[{&quot;id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;price&quot;:{&quot;amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;},&quot;display_value&quot;:&quot;\u003cstring\u003e&quot;,&quot;option_id&quot;:&quot;\u003cnumber\u003e&quot;,&quot;image_url&quot;:&quot;\u003cstring\u003e&quot;,&quot;hashed_display_value&quot;:&quot;\u003cstring\u003e&quot;,&quot;skus&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;price&quot;:{&quot;amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;},&quot;regular_price&quot;:{&quot;amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;},&quot;sale_price&quot;:{&quot;amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;},&quot;stock_quantity&quot;:&quot;\u003cinteger\u003e&quot;,&quot;barcode&quot;:&quot;\u003cstring\u003e&quot;,&quot;sku&quot;:&quot;\u003cstring\u003e&quot;,&quot;related_option_values&quot;:[&quot;\u003cinteger\u003e&quot;,&quot;\u003cinteger\u003e&quot;],&quot;is_default&quot;:&quot;\u003cboolean\u003e&quot;,&quot;weight&quot;:&quot;\u003cnumber\u003e&quot;,&quot;weight_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;weight_label&quot;:&quot;\u003cstring\u003e&quot;},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;price&quot;:{&quot;amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;},&quot;regular_price&quot;:{&quot;amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;},&quot;sale_price&quot;:{&quot;amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;},&quot;stock_quantity&quot;:&quot;\u003cinteger\u003e&quot;,&quot;barcode&quot;:&quot;\u003cstring\u003e&quot;,&quot;sku&quot;:&quot;\u003cstring\u003e&quot;,&quot;related_option_values&quot;:[&quot;\u003cinteger\u003e&quot;,&quot;\u003cinteger\u003e&quot;],&quot;is_default&quot;:&quot;\u003cboolean\u003e&quot;,&quot;weight&quot;:&quot;\u003cnumber\u003e&quot;,&quot;weight_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;weight_label&quot;:&quot;\u003cstring\u003e&quot;}],&quot;is_default&quot;:&quot;\u003cboolean\u003e&quot;}],&quot;skus&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;price&quot;:{&quot;amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;},&quot;regular_price&quot;:{&quot;amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;},&quot;sale_price&quot;:{&quot;amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;},&quot;stock_quantity&quot;:&quot;\u003cinteger\u003e&quot;,&quot;barcode&quot;:&quot;\u003cstring\u003e&quot;,&quot;sku&quot;:&quot;\u003cstring\u003e&quot;,&quot;related_option_values&quot;:[&quot;\u003cinteger\u003e&quot;,&quot;\u003cinteger\u003e&quot;],&quot;is_default&quot;:&quot;\u003cboolean\u003e&quot;,&quot;weight&quot;:&quot;\u003cnumber\u003e&quot;,&quot;weight_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;weight_label&quot;:&quot;\u003cstring\u003e&quot;},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;price&quot;:{&quot;amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;},&quot;regular_price&quot;:{&quot;amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;},&quot;sale_price&quot;:{&quot;amount&quot;:&quot;\u003cnumber\u003e&quot;,&quot;currency&quot;:&quot;\u003cstring\u003e&quot;},&quot;stock_quantity&quot;:&quot;\u003cinteger\u003e&quot;,&quot;barcode&quot;:&quot;\u003cstring\u003e&quot;,&quot;sku&quot;:&quot;\u003cstring\u003e&quot;,&quot;related_option_values&quot;:[&quot;\u003cinteger\u003e&quot;,&quot;\u003cinteger\u003e&quot;],&quot;is_default&quot;:&quot;\u003cboolean\u003e&quot;,&quot;weight&quot;:&quot;\u003cnumber\u003e&quot;,&quot;weight_type&quot;:&quot;\u003cstring\u003e&quot;,&quot;weight_label&quot;:&quot;\u003cstring\u003e&quot;}]}}