Create Product Option

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

This endpoint allows you to 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.

Scope: products.read_write- Products Read & Write

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

Request Body

{"name"=>"<string>", "type"=>"radio", "display_type"=>"text", "visibility"=>"always", "visibility_condition_type"=>">", "visibility_condition_option"=>"<string>", "visibility_condition_value"=>"<string>", "sort"=>"<integer>", "advance"=>"<string>", "associated_with_order_time"=>"<boolean>", "not_same_day_order"=>"<boolean>", "values"=>[{"name"=>"<string>", "price"=>"<number>", "display_value"=>"image"}, {"name"=>"<string>", "price"=>"<number>", "display_value"=>"color"}]}

HEADERS

RESPONSES

status: Created

{"status":"\u003cnumber\u003e","success":"\u003cboolean\u003e","data":{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","description":"\u003cstring\u003e","type":"checkbox","required":"\u003cboolean\u003e","associated_with_order_time":"\u003cinteger\u003e","sort":"\u003cinteger\u003e","display_type":"text","visibility":"always","visibility_condition_type":"\u003c","visibility_condition_option":"\u003cinteger\u003e","visibility_condition_value":"\u003cinteger\u003e","values":[{"id":"\u003cnumber\u003e","name":"\u003cstring\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"formatted_price":"\u003cstring\u003e","display_value":"\u003cstring\u003e","advance":"\u003cboolean\u003e","option_id":"\u003cnumber\u003e","image_url":"\u003cstring\u003e","hashed_display_value":"\u003cstring\u003e","translations":{"ar":{"option_details_name":"\u003cstring\u003e"}},"is_default":"\u003cboolean\u003e","is_out_of_stock":"\u003cboolean\u003e"}],"skus":[{"id":"\u003cnumber\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"regular_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"cost_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"sale_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"has_special_price":"\u003cboolean\u003e","stock_quantity":"\u003cinteger\u003e","unlimited_quantity":"\u003cboolean\u003e","notify_low":"\u003cinteger\u003e","barcode":"\u003cstring\u003e","sku":"\u003cstring\u003e","mpn":"\u003cstring\u003e","gtin":"\u003cstring\u003e","related_options":["\u003cinteger\u003e","\u003cinteger\u003e"],"related_option_values":["\u003cinteger\u003e","\u003cinteger\u003e"],"weight":"\u003cnumber\u003e","weight_type":"\u003cstring\u003e","weight_label":"\u003cstring\u003e","is_user_subscribed_to_sku":"\u003cboolean\u003e","is_default":"\u003cboolean\u003e"},{"id":"\u003cnumber\u003e","price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"regular_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"cost_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"sale_price":{"amount":"\u003cnumber\u003e","currency":"\u003cstring\u003e"},"has_special_price":"\u003cboolean\u003e","stock_quantity":"\u003cinteger\u003e","unlimited_quantity":"\u003cboolean\u003e","notify_low":"\u003cinteger\u003e","barcode":"\u003cstring\u003e","sku":"\u003cstring\u003e","mpn":"\u003cstring\u003e","gtin":"\u003cstring\u003e","related_options":["\u003cinteger\u003e","\u003cinteger\u003e"],"related_option_values":["\u003cinteger\u003e","\u003cinteger\u003e"],"weight":"\u003cnumber\u003e","weight_type":"\u003cstring\u003e","weight_label":"\u003cstring\u003e","is_user_subscribed_to_sku":"\u003cboolean\u003e","is_default":"\u003cboolean\u003e"}]}}