Add a Product Option

Add a Product Option to a Product.

{ "product": { "id": "prod_01G1G5V2MBA328390B5AXJ610F", "title": "Medusa Coffee Mug", "subtitle": "string", "description": "Every programmer's best friend.", "handle": "coffee-mug", "is_giftcard": false, "thumbnail": "http://example.com", "profile_id": "sp_01G1G5V239ENSZ5MV4JAR737BM", "weight": null, "length": null, "height": null, "width": null, "hs_code": null, "origin_country": null, "mid_code": null, "material": null, "collection_id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG", "type_id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A", "discountable": true, "external_id": null, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "status": "draft", "metadata": { "car": "white" }, "images": [ { "id": "img_01G749BFYR6T8JTVW6SGW3K3E6", "url": "http://example.com", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "metadata": { "car": "white" } } ], "categories": [ { "id": "pcat_01G2SG30J8C85S4A5CHM2S1NS2", "name": "Regular Fit", "handle": "regular-fit", "mpath": "pcat_id1.pcat_id2.pcat_id3", "is_internal": false, "is_active": false, "rank": 0, "parent_category_id": null, "parent_category": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "category_children": [ {} ], "products": [ {} ] } ], "collection": { "id": "pcol_01F0YESBFAZ0DV6V831JXWH0BG", "title": "Summer Collection", "handle": "summer-collection", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "products": [ {} ], "metadata": { "car": "white" } }, "tags": [ { "id": "ptag_01G8K2MTMG9168F2B70S1TAVK3", "value": "Pants", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "metadata": { "car": "white" } } ], "profile": { "id": "sp_01G1G5V239ENSZ5MV4JAR737BM", "name": "Default Shipping Profile", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "type": "default", "products": [ {} ], "shipping_options": [ {} ], "metadata": { "car": "white" } }, "profiles": [ { "id": "sp_01G1G5V239ENSZ5MV4JAR737BM", "name": "Default Shipping Profile", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "type": "default", "products": [ {} ], "shipping_options": [ {} ], "metadata": { "car": "white" } } ], "type": { "id": "ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A", "value": "Clothing", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "metadata": { "car": "white" } }, "sales_channels": [ { "id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A", "name": "Market", "description": "Multi-vendor market", "is_disabled": false, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "metadata": { "car": "white" }, "locations": [ { "id": "scloc_01G8X9A7ESKAJXG2H0E6F1MW7A", "sales_channel_id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A", "location_id": "string", "sales_channel": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z" } ] } ], "options": [ { "id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3", "title": "Size", "product_id": "prod_01G1G5V2MBA328390B5AXJ610F", "product": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "metadata": { "car": "white" }, "values": [ { "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ", "value": "large", "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3", "option": {}, "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6", "variant": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "metadata": { "car": "white" } } ] } ], "variants": [ { "id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6", "title": "Small", "product_id": "prod_01G1G5V2MBA328390B5AXJ610F", "product": {}, "sku": "shirt-123", "barcode": null, "ean": null, "upc": null, "variant_rank": 0, "inventory_quantity": 100, "allow_backorder": false, "manage_inventory": true, "hs_code": null, "origin_country": null, "mid_code": null, "material": null, "weight": null, "length": null, "height": null, "width": null, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "purchasable": true, "metadata": { "car": "white" }, "options": [ { "id": "optval_01F0YESHR7S6ECD03RF6W12DSJ", "value": "large", "option_id": "opt_01F0YESHQBZVKCEXJ24BS6PCX3", "option": {}, "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6", "variant": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "metadata": { "car": "white" } } ], "inventory_items": [ { "id": "pvitem_01G8X9A7ESKAJXG2H0E6F1MW7A", "inventory_item_id": "string", "variant_id": "string", "variant": {}, "required_quantity": 1, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z" } ], "prices": [ { "id": "ma_01F0YESHRFQNH5S8Q0PK84YYZN", "amount": 100, "min_quantity": 1, "max_quantity": 1, "price_list_id": "pl_01G8X3CKJXCG5VXVZ87H9KC09W", "price_list": {}, "variant_id": "variant_01G1G5V2MRX2V3PVSR2WXYPFB6", "variant": {}, "region_id": "reg_01G1G5V26T9H8Y0M4JNE3YGA4G", "region": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "currency_code": "usd", "currency": { "symbol": "$", "symbol_native": "$", "name": "US Dollar", "includes_tax": false, "code": "usd" } } ], "original_price": 0, "calculated_price": 0, "original_price_incl_tax": 0, "calculated_price_incl_tax": 0, "original_tax": 0, "calculated_tax": 0, "tax_rates": [ { "rate": 0, "name": "string", "code": "string" } ] } ] } }

Responses

🟢200OK

application/json

Body

product

object (Priced Product)

required

A product is a saleable item that holds general information such as name or description. It must include at least one Product Variant, where each product variant defines different options to purchase the product with (for example, different sizes or colors). The prices and inventory of the product are defined on the variant level.

string

required

The product's ID

Example:

prod_01G1G5V2MBA328390B5AXJ610F

title

string

required

A title that can be displayed for easy identification of the Product.

Example:

Medusa Coffee Mug

subtitle

string | null

required

An optional subtitle that can be used to further specify the Product.

description

string | null

required

A short description of the Product.

Example:

Every programmer's best friend.

handle

string | null

required

A unique identifier for the Product (e.g. for slug structure).

Example:

coffee-mug

is_giftcard

boolean

required

Whether the Product represents a Gift Card. Products that represent Gift Cards will automatically generate a redeemable Gift Card code once they are purchased.

Default:

false

thumbnail

string <uri> | null

required

A URL to an image file that can be used to identify the Product.

profile_id

string

required

The ID of the shipping profile that the product belongs to. The shipping profile has a set of defined shipping options that can be used to fulfill the product.

Example:

sp_01G1G5V239ENSZ5MV4JAR737BM

weight

number | null

required

The weight of the Product Variant. May be used in shipping rate calculations.

Example:

null

length

number | null

required

The length of the Product Variant. May be used in shipping rate calculations.

Example:

null

height

number | null

required

The height of the Product Variant. May be used in shipping rate calculations.

Example:

null

width

number | null

required

The width of the Product Variant. May be used in shipping rate calculations.

Example:

null

hs_code

string | null

required

The Harmonized System code of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.

Example:

null

origin_country

string | null

required

The country in which the Product Variant was produced. May be used by Fulfillment Providers to pass customs information to shipping carriers.

Example:

null

mid_code

string | null

required

The Manufacturers Identification code that identifies the manufacturer of the Product Variant. May be used by Fulfillment Providers to pass customs information to shipping carriers.

Example:

null

material

string | null

required

The material and composition that the Product Variant is made of, May be used by Fulfillment Providers to pass customs information to shipping carriers.

Example:

null

collection_id

string | null

required

The ID of the product collection that the product belongs to.

Example:

pcol_01F0YESBFAZ0DV6V831JXWH0BG

type_id

string | null

required

The ID of the product type that the product belongs to.

Example:

ptyp_01G8X9A7ESKAJXG2H0E6F1MW7A

discountable

boolean

required

Whether the Product can be discounted. Discounts will not apply to Line Items of this Product when this flag is set to false.

Default:

true

external_id

string | null

required

The external ID of the product

Example:

null

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time> | null

required

The date with timezone at which the resource was deleted.

status

enum<string>

required

The status of the product

Allowed values:

draftproposedpublishedrejected

Default:

draft

metadata

object | null

required

An optional key-value map with additional details

Example:

{"car":"white"}

images

array[object (Image) {6}]

optional

The details of the product's images.

Add a Product Option

Request

Responses