Skip to main content
POST
/
admin
/
products
/
{id}
/
options
JS SDK
import Medusa from "@medusajs/js-sdk"

export const sdk = new Medusa({
  baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
  debug: import.meta.env.DEV,
  auth: {
    type: "session",
  },
})

sdk.admin.product.createOption(
  "prod_123",
  {
    title: "Color",
    values: ["Green", "Blue"]
  }
)
.then(({ product }) => {
  console.log(product)
})
{ "product": { "variants": [ { "prices": [ { "id": "<string>", "title": "<string>", "currency_code": "usd", "amount": 123, "raw_amount": {}, "min_quantity": 123, "max_quantity": 123, "price_set_id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ], "id": "<string>", "title": "<string>", "sku": "<string>", "barcode": "<string>", "ean": "<string>", "upc": "<string>", "allow_backorder": true, "manage_inventory": true, "hs_code": "<string>", "origin_country": "<string>", "mid_code": "<string>", "material": "<string>", "weight": 123, "length": 123, "height": 123, "width": 123, "options": [ { "id": "<string>", "value": "<string>", "option": { "id": "<string>", "title": "<string>", "product": {}, "product_id": "<string>", "values": [ {} ], "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" }, "option_id": "<string>", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ], "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "images": [ { "id": "<string>", "url": "<string>", "rank": 123, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "metadata": {} } ], "thumbnail": "<string>", "inventory_quantity": 123, "variant_rank": 123, "product": {}, "product_id": "<string>", "calculated_price": { "id": "<string>", "calculated_amount": 123, "original_amount": 123, "currency_code": "usd", "original_amount_with_tax": 123, "original_amount_without_tax": 123, "is_calculated_price_price_list": true, "is_calculated_price_tax_inclusive": true, "calculated_amount_with_tax": 123, "calculated_amount_without_tax": 123, "is_original_price_price_list": true, "is_original_price_tax_inclusive": true, "calculated_price": {}, "original_price": {} }, "metadata": {}, "inventory_items": [ { "id": "<string>", "variant_id": "<string>", "inventory_item_id": "<string>", "variant": {}, "inventory": { "id": "<string>", "requires_shipping": true, "sku": "<string>", "origin_country": "<string>", "hs_code": "<string>", "mid_code": "<string>", "material": "<string>", "weight": 123, "length": 123, "height": 123, "width": 123, "title": "<string>", "description": "<string>", "thumbnail": "<string>", "metadata": {}, "location_levels": [ { "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "inventory_item_id": "<string>", "location_id": "<string>", "stocked_quantity": 123, "reserved_quantity": 123, "incoming_quantity": 123, "metadata": {}, "available_quantity": 123, "inventory_item": {} } ] }, "required_quantity": 123 } ], "translations": [ { "id": "<string>", "reference_id": "prod_123", "reference": "product", "locale_code": "fr-FR", "translations": { "title": "Chaussures", "description": "Des chaussures élégantes." }, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ] } ], "type": { "id": "<string>", "value": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "metadata": {}, "translations": [ { "id": "<string>", "reference_id": "prod_123", "reference": "product", "locale_code": "fr-FR", "translations": { "title": "Chaussures", "description": "Des chaussures élégantes." }, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ] }, "length": 123, "title": "<string>", "status": "draft", "options": [ { "id": "<string>", "title": "<string>", "product": {}, "product_id": "<string>", "values": [ {} ], "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ], "description": "<string>", "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "handle": "<string>", "subtitle": "<string>", "is_giftcard": true, "thumbnail": "<string>", "width": 123, "weight": 123, "height": 123, "origin_country": "<string>", "hs_code": "<string>", "mid_code": "<string>", "material": "<string>", "collection_id": "<string>", "type_id": "<string>", "images": [ { "id": "<string>", "url": "<string>", "rank": 123, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "metadata": {}, "product": {}, "variants": [ {} ] } ], "discountable": true, "external_id": "<string>", "deleted_at": "2023-11-07T05:31:56Z", "collection": { "id": "<string>", "title": "<string>", "handle": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "metadata": {}, "products": [ { "variants": [ {} ], "length": 123, "title": "<string>", "status": "draft", "options": [ { "id": "<string>", "title": "<string>", "product": {}, "product_id": "<string>", "values": [ { "id": "<string>", "value": "<string>", "option": {}, "option_id": "<string>", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ], "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ], "description": "<string>", "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "handle": "<string>", "subtitle": "<string>", "is_giftcard": true, "thumbnail": "<string>", "width": 123, "weight": 123, "height": 123, "origin_country": "<string>", "hs_code": "<string>", "mid_code": "<string>", "material": "<string>", "collection_id": "<string>", "type_id": "<string>", "images": [ { "id": "<string>", "url": "<string>", "rank": 123, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "metadata": {} } ], "discountable": true, "external_id": "<string>", "deleted_at": "2023-11-07T05:31:56Z", "collection": { "id": "<string>", "title": "<string>", "handle": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "metadata": {}, "products": [ {} ] }, "categories": [ { "category_children": [ { "category_children": [ {} ], "parent_category": {}, "name": "<string>", "description": "<string>", "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "handle": "<string>", "deleted_at": "2023-11-07T05:31:56Z", "is_active": true, "is_internal": true, "rank": 123, "parent_category_id": "<string>", "products": [ {} ], "metadata": {} } ], "parent_category": { "category_children": [ {} ], "parent_category": {}, "name": "<string>", "description": "<string>", "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "handle": "<string>", "deleted_at": "2023-11-07T05:31:56Z", "is_active": true, "is_internal": true, "rank": 123, "parent_category_id": "<string>", "products": [ {} ], "metadata": {} }, "name": "<string>", "description": "<string>", "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "handle": "<string>", "deleted_at": "2023-11-07T05:31:56Z", "is_active": true, "is_internal": true, "rank": 123, "parent_category_id": "<string>", "products": [ {} ], "metadata": {} } ], "type": { "id": "<string>", "value": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "metadata": {} }, "tags": [ { "id": "<string>", "value": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "metadata": {} } ], "metadata": {} } ], "translations": [ { "id": "<string>", "reference_id": "prod_123", "reference": "product", "locale_code": "fr-FR", "translations": { "title": "Chaussures", "description": "Des chaussures élégantes." }, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ] }, "categories": [ { "category_children": [ {} ], "parent_category": {}, "name": "<string>", "description": "<string>", "id": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "handle": "<string>", "deleted_at": "2023-11-07T05:31:56Z", "is_active": true, "is_internal": true, "rank": 123, "parent_category_id": "<string>", "products": [ {} ], "metadata": {} } ], "sales_channels": [ { "id": "<string>", "name": "<string>", "description": "<string>", "is_disabled": true, "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ], "tags": [ { "id": "<string>", "value": "<string>", "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z", "metadata": {}, "translations": [ { "id": "<string>", "reference_id": "prod_123", "reference": "product", "locale_code": "fr-FR", "translations": { "title": "Chaussures", "description": "Des chaussures élégantes." }, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ] } ], "metadata": {}, "shipping_profile": { "id": "<string>", "name": "<string>", "type": "<string>", "metadata": {}, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" }, "translations": [ { "id": "<string>", "reference_id": "prod_123", "reference": "product", "locale_code": "fr-FR", "translations": { "title": "Chaussures", "description": "Des chaussures élégantes." }, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z", "deleted_at": "2023-11-07T05:31:56Z" } ] } }

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The product's ID.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Body

application/json

The product option's details.

​
title
string
required

The product option's title.

​
values
string[]
required

The product option's values.

A value.

​
additional_data
object

Pass additional custom data to the API route. This data is passed to the underlying workflow under the additional_data parameter.

Response

OK

The product's details.

​
product
object
required

The product's details.