Update a Product's Option

JS SDK

import Switchyard from "@switchyard/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.updateOption(
  "prod_123",
  "prodopt_123",
  {
    title: "Color"
  }
)
.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
          }
        ]
      }
    ],
    "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": {}
    },
    "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": {}
        }
      ]
    },
    "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": {}
      }
    ],
    "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"
    }
  }
}

POST

admin

products

{id}

options

{option_id}

JS SDK

import Switchyard from "@switchyard/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.updateOption(
  "prod_123",
  "prodopt_123",
  {
    title: "Color"
  }
)
.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
          }
        ]
      }
    ],
    "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": {}
    },
    "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": {}
        }
      ]
    },
    "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": {}
      }
    ],
    "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"
    }
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

The product's ID.

option_id

string

required

The option'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 properties to update in the product option.

title

string

The option's title.

values

string[]

The option's values.

An option 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

The product's details.

product

object

required

The product's details.

Show child attributes

product.variants

object[]

required

The product's variants.

Show child attributes

product.variants.prices

object[]

required

The variant's prices.

Show child attributes

product.variants.prices.id

string

required

The price's ID.

product.variants.prices.title

string

required

The price's title.

product.variants.prices.currency_code

string

required

The price's currency code.

Example:

"usd"

product.variants.prices.amount

number

required

The price's amount.

product.variants.prices.raw_amount

object

required

The price's raw amount.

product.variants.prices.min_quantity

number

required

The minimum quantity that must be available in the cart for the price to be applied.

product.variants.prices.max_quantity

number

required

The maximum quantity allowed to be available in the cart for the price to be applied.

product.variants.prices.price_set_id

string

required

The ID of the associated price set.

product.variants.prices.created_at

string<date-time>

required

The date the price was created.

product.variants.prices.updated_at

string<date-time>

required

The date the price was updated.

product.variants.prices.deleted_at

string<date-time>

required

The date the price was deleted.

product.variants.id

string

required

The variant's ID.

product.variants.title

string

required

The variant's title.

product.variants.sku

string

required

The variant's SKU.

product.variants.barcode

string

required

The variant's barcode.

product.variants.ean

string

required

The variant's EAN code.

product.variants.upc

string

required

The variant's UPC.

product.variants.allow_backorder

boolean

required

Whether the variant can be ordered even if it's out of stock.

product.variants.manage_inventory

boolean

required

Whether the Medusa application manages the variant's inventory quantity and availablility. If disabled, the variant is always considered in stock.

product.variants.hs_code

string

required

The variant's HS code.

product.variants.origin_country

string

required

The variant's origin country.

product.variants.mid_code

string

required

The variant's MID code.

product.variants.material

string

required

The variant's material.

product.variants.weight

number

required

The variant's weight.

product.variants.length

number

required

The variant's length.

product.variants.height

number

required

The variant's height.

product.variants.width

number

required

The variant's width.

product.variants.options

object[]

required

The variant's option values.

Show child attributes

product.variants.options.id

string

required

The value's ID.

product.variants.options.value

string

required

The value.

product.variants.options.option

object

The product option's details.

Show child attributes

product.variants.options.option.id

string

required

The product option's ID.

product.variants.options.option.title

string

required

The product option's title.

product.variants.options.option.product

object

product.variants.options.option.product_id

string

The ID of the product this option belongs to.

product.variants.options.option.values

object[]

The product option's values.

product.variants.options.option.metadata

object

The product option's metadata, can hold custom key-value pairs.

product.variants.options.option.created_at

string<date-time>

The date the product option was created.

product.variants.options.option.updated_at

string<date-time>

The date the product option was updated.

product.variants.options.option.deleted_at

string<date-time>

The date the product option was deleted.

product.variants.options.option_id

string

The ID of the option this value belongs to.

product.variants.options.metadata

object

The value's metadata, can hold custom key-value pairs.

product.variants.options.created_at

string<date-time>

The date the value was created.

product.variants.options.updated_at

string<date-time>

The date the value was updated.

product.variants.options.deleted_at

string<date-time>

The date the value was deleted.

product.variants.created_at

string<date-time>

required

The date the variant was created.

product.variants.updated_at

string<date-time>

required

The date the variant was updated.

product.variants.deleted_at

string<date-time>

required

The date the variant was deleted.

product.variants.images

object[]

required

The variant's images.

Show child attributes

product.variants.images.id

string

required

The image's ID.

product.variants.images.url

string

required

The image's URL.

product.variants.images.rank

number

required

The image's rank among its sibling images.

product.variants.images.created_at

string<date-time>

The date the image was created.

product.variants.images.updated_at

string<date-time>

The date the image was updated.

product.variants.images.deleted_at

string<date-time>

The date the image was deleted.

product.variants.images.metadata

object

The image's metadata, can hold custom key-value pairs.

product.variants.thumbnail

string

required

The variant's thumbnail.

product.variants.inventory_quantity

number

The variant's inventory quantity. This is only included if you pass in the fields query parameter a +variants.inventory_quantity parameter.

product.variants.variant_rank

number

The variant's rank among its sibling variants.

product.variants.product

object

product.variants.product_id

string

The ID of the product that the variant belongs to.

product.variants.calculated_price

object

The calculated price's details.

Show child attributes

product.variants.calculated_price.id

string

required

The calculated price's ID.

product.variants.calculated_price.calculated_amount

number

required

The amount of the calculated price, or null if there isn't a calculated price. This is the amount shown to the customer.

product.variants.calculated_price.original_amount

number

required

The amount of the original price, or null if there isn't an original price. This amount is useful to compare with the calculated_amount, such as to check for discounted value.

product.variants.calculated_price.currency_code

string

required

The calculated price's currency code.

Example:

"usd"

product.variants.calculated_price.original_amount_with_tax

number

required

The amount of the original price with taxes applied.

product.variants.calculated_price.original_amount_without_tax

number

required

The amount of the original price without taxes.

product.variants.calculated_price.is_calculated_price_price_list

boolean

Whether the calculated price belongs to a price list.

product.variants.calculated_price.is_calculated_price_tax_inclusive

boolean

Whether the calculated price is tax inclusive.

product.variants.calculated_price.calculated_amount_with_tax

number

The calculated price's amount with taxes applied.

product.variants.calculated_price.calculated_amount_without_tax

number

The calculated price's amount without taxes applied.

product.variants.calculated_price.is_original_price_price_list

boolean

Whether the original price belongs to a price list.

product.variants.calculated_price.is_original_price_tax_inclusive

boolean

Whether the original price is tax inclusive.

product.variants.calculated_price.calculated_price

object

The calculated price's details.

product.variants.calculated_price.original_price

object

The original price's details.

product.variants.metadata

object

The variant's metadata, can hold custom key-value pairs.

product.variants.inventory_items

object[]

The variant's inventory items.

Show child attributes

product.variants.inventory_items.id

string

required

The ID of the association.

product.variants.inventory_items.variant_id

string

required

The associated product variant's ID.

product.variants.inventory_items.inventory_item_id

string

required

The associated inventory item's ID.

product.variants.inventory_items.variant

object

product.variants.inventory_items.inventory

object

The inventory item's details.

Show child attributes

product.variants.inventory_items.inventory.id

string

required

The inventory item's ID.

product.variants.inventory_items.inventory.requires_shipping

boolean

required

Whether the inventory item requires shipping.

product.variants.inventory_items.inventory.sku

string

The inventory item's sku.

product.variants.inventory_items.inventory.origin_country

string

The inventory item's origin country.

product.variants.inventory_items.inventory.hs_code

string

The inventory item's HS code.

product.variants.inventory_items.inventory.mid_code

string

The inventory item's MID code.

product.variants.inventory_items.inventory.material

string

The inventory item's material.

product.variants.inventory_items.inventory.weight

number

The inventory item's weight.

product.variants.inventory_items.inventory.length

number

The inventory item's length.

product.variants.inventory_items.inventory.height

number

The inventory item's height.

product.variants.inventory_items.inventory.width

number

The inventory item's width.

product.variants.inventory_items.inventory.title

string

The inventory item's title.

product.variants.inventory_items.inventory.description

string

The inventory item's description.

product.variants.inventory_items.inventory.thumbnail

string

The thumbnail URL of the inventory item.

product.variants.inventory_items.inventory.metadata

object

Custom key-value pairs, used to store additional information about the inventory item.

product.variants.inventory_items.inventory.location_levels

object[]

The inventory item's location levels.

Show child attributes

product.variants.inventory_items.inventory.location_levels.id

string

required

The location level's ID.

product.variants.inventory_items.inventory.location_levels.created_at

string<date-time>

required

The location level's created at.

product.variants.inventory_items.inventory.location_levels.updated_at

string<date-time>

required

The location level's updated at.

product.variants.inventory_items.inventory.location_levels.deleted_at

string<date-time>

required

The location level's deleted at.

product.variants.inventory_items.inventory.location_levels.inventory_item_id

string

required

The location level's inventory item id.

product.variants.inventory_items.inventory.location_levels.location_id

string

required

The location level's location id.

product.variants.inventory_items.inventory.location_levels.stocked_quantity

number

required

The location level's stocked quantity.

product.variants.inventory_items.inventory.location_levels.reserved_quantity

number

required

The location level's reserved quantity.

product.variants.inventory_items.inventory.location_levels.incoming_quantity

number

required

The location level's incoming quantity.

product.variants.inventory_items.inventory.location_levels.metadata

object

required

The location level's metadata.

product.variants.inventory_items.inventory.location_levels.available_quantity

number

required

The location level's available quantity.

product.variants.inventory_items.inventory.location_levels.inventory_item

object

product.variants.inventory_items.required_quantity

number

The inventory item's required quantity.

product.type

object

required

The product type's details.

Show child attributes

product.type.id

string

required

The type's ID.

product.type.value

string

required

The type's value.

product.type.created_at

string<date-time>

required

The date the type was created.

product.type.updated_at

string<date-time>

required

The date the type was updated.

product.type.deleted_at

string<date-time>

The date the type was deleted.

product.type.metadata

object

The type's metadata, can hold custom key-value pairs.

product.length

number

required

The product's length.

product.title

string

required

The product's title.

product.status

enum<string>

required

The product's status.

Available options:

draft,

proposed,

published,

rejected

product.options

object[]

required

The product's options.

Show child attributes

product.options.id

string

required

The product option's ID.

product.options.title

string

required

The product option's title.

product.options.product

object

product.options.product_id

string

The ID of the product this option belongs to.

product.options.values

object[]

The product option's values.

product.options.metadata

object

The product option's metadata, can hold custom key-value pairs.

product.options.created_at

string<date-time>

The date the product option was created.

product.options.updated_at

string<date-time>

The date the product option was updated.

product.options.deleted_at

string<date-time>

The date the product option was deleted.

product.description

string

required

The product's description.

product.id

string

required

The product's ID.

product.created_at

string<date-time>

required

The date the product was created.

product.updated_at

string<date-time>

required

The date the product was updated.

product.handle

string

required

The product's unique handle.

product.subtitle

string

required

The product's subtitle.

product.is_giftcard

boolean

required

Whether the product is a gift card.

product.thumbnail

string

required

The product's thumbnail.

product.width

number

required

The product's width.

product.weight

number

required

The product's weight.

product.height

number

required

The product's height.

product.origin_country

string

required

The product's origin country.

product.hs_code

string

required

The product's HS code.

product.mid_code

string

required

The product's MID code.

product.material

string

required

The product's material.

product.collection_id

string

required

The ID of the collection that the product belongs to.

product.type_id

string

required

The ID of the product's type.

product.images

object[]

required

The product's images.

Show child attributes

product.images.id

string

required

The image's ID.

product.images.url

string

required

The image's URL.

product.images.rank

number

required

The image's rank among sibling images.

product.images.created_at

string<date-time>

The date the image was created.

product.images.updated_at

string<date-time>

The date the image was updated.

product.images.deleted_at

string<date-time>

The date the image was deleted.

product.images.metadata

object

The image's metadata, can hold custom key-value pairs.

product.images.product

object

product.images.variants

object[]

The variants associated with the image.

product.discountable

boolean

required

Whether discounts can be applied on the product.

product.external_id

string

required

The ID of a product in an external system, such as an ERP or CMS.

product.deleted_at

string<date-time>

required

The date the product was deleted.

product.collection

object

The product collection's details.

Show child attributes

product.collection.id

string

required

The collection's ID.

product.collection.title

string

required

The collection's title.

product.collection.handle

string

required

The collection's handle.

product.collection.created_at

string<date-time>

required

The collection's creation date.

product.collection.updated_at

string<date-time>

required

The collection's update date.

product.collection.deleted_at

string<date-time>

required

The collection's deletion date.

product.collection.metadata

object

required

The collection's metadata, used to store custom key-value pairs.

product.collection.products

object[]

The collection's products.

Show child attributes

product.collection.products.variants

object[]

required

The product's variants.

product.collection.products.length

number

required

The product's length.

product.collection.products.title

string

required

The product's title.

product.collection.products.status

enum<string>

required

The product's status.

Available options:

draft,

proposed,

published,

rejected

product.collection.products.options

object[]

required

The product's options.

Show child attributes

product.collection.products.options.id

string

required

The product option's ID.

product.collection.products.options.title

string

required

The product option's title.

product.collection.products.options.product

object

product.collection.products.options.product_id

string

The ID of the product this option belongs to.

product.collection.products.options.values

object[]

The product option's values.

Show child attributes

product.collection.products.options.values.id

string

required

The value's ID.

product.collection.products.options.values.value

string

required

The value.

product.collection.products.options.values.option

object

product.collection.products.options.values.option_id

string

The ID of the option this value belongs to.

product.collection.products.options.values.metadata

object

The value's metadata, can hold custom key-value pairs.

product.collection.products.options.values.created_at

string<date-time>

The date the value was created.

product.collection.products.options.values.updated_at

string<date-time>

The date the value was updated.

product.collection.products.options.values.deleted_at

string<date-time>

The date the value was deleted.

product.collection.products.options.metadata

object

The product option's metadata, can hold custom key-value pairs.

product.collection.products.options.created_at

string<date-time>

The date the product option was created.

product.collection.products.options.updated_at

string<date-time>

The date the product option was updated.

product.collection.products.options.deleted_at

string<date-time>

The date the product option was deleted.

product.collection.products.description

string

required

The product's description.

product.collection.products.id

string

required

The product's ID.

product.collection.products.created_at

string<date-time>

required

The date the product was created.

product.collection.products.updated_at

string<date-time>

required

The date the product was updated.

product.collection.products.handle

string

required

The product's unique handle.

product.collection.products.subtitle

string

required

The product's subtitle.

product.collection.products.is_giftcard

boolean

required

Whether the product is a gift card.

product.collection.products.thumbnail

string

required

The product's thumbnail.

product.collection.products.width

number

required

The product's width.

product.collection.products.weight

number

required

The product's weight.

product.collection.products.height

number

required

The product's height.

product.collection.products.origin_country

string

required

The product's origin country.

product.collection.products.hs_code

string

required

The product's HS code.

product.collection.products.mid_code

string

required

The product's MID code.

product.collection.products.material

string

required

The product's material.

product.collection.products.collection_id

string

required

The ID of the collection that the product belongs to.

product.collection.products.type_id

string

required

The ID of the product's type.

product.collection.products.images

object[]

required

The product's images.

Show child attributes

product.collection.products.images.id

string

required

The image's ID.

product.collection.products.images.url

string

required

The image's URL.

product.collection.products.images.rank

number

required

The image's rank among its sibling images.

product.collection.products.images.created_at

string<date-time>

The date the image was created.

product.collection.products.images.updated_at

string<date-time>

The date the image was updated.

product.collection.products.images.deleted_at

string<date-time>

The date the image was deleted.

product.collection.products.images.metadata

object

The image's metadata, can hold custom key-value pairs.

product.collection.products.discountable

boolean

required

Whether discounts can be applied on the product.

product.collection.products.external_id

string

required

The ID of a product in an external system, such as an ERP or CMS.

product.collection.products.deleted_at

string<date-time>

required

The date the product was deleted.

product.collection.products.collection

object

The product collection's details.

Show child attributes

product.collection.products.collection.id

string

required

The collection's ID.

product.collection.products.collection.title

string

required

The collection's title.

product.collection.products.collection.handle

string

required

The collection's handle.

product.collection.products.collection.created_at

string<date-time>

required

The collection's creation date.

product.collection.products.collection.updated_at

string<date-time>

required

The collection's update date.

product.collection.products.collection.deleted_at

string<date-time>

required

The collection's deletion date.

product.collection.products.collection.metadata

object

required

The collection's metadata, used to store custom key-value pairs.

product.collection.products.collection.products

object[]

The collection's products.

product.collection.products.categories

object[]

The product's categories.

Show child attributes

product.collection.products.categories.category_children

object[]

required

The category's children.

Show child attributes

product.collection.products.categories.category_children.category_children

object[]

required

The category's children.

product.collection.products.categories.category_children.parent_category

object

required

product.collection.products.categories.category_children.name

string

required

The category's name.

product.collection.products.categories.category_children.description

string

required

The category's description.

product.collection.products.categories.category_children.id

string

required

The category's ID.

product.collection.products.categories.category_children.created_at

string<date-time>

required

The date the category was created.

product.collection.products.categories.category_children.updated_at

string<date-time>

required

The date the category was updated.

product.collection.products.categories.category_children.handle

string

required

The category's unique handle.

product.collection.products.categories.category_children.deleted_at

string<date-time>

required

The date the category was deleted.

product.collection.products.categories.category_children.is_active

boolean

required

Whether the category is active. If disabled, the category isn't shown in the storefront.

product.collection.products.categories.category_children.is_internal

boolean

required

Whether the category is internal. If enabled, the category is only seen by admin users.

product.collection.products.categories.category_children.rank

number

required

The category's rank among sibling categories.

product.collection.products.categories.category_children.parent_category_id

string

required

The ID of the category's parent.

product.collection.products.categories.category_children.products

object[]

The category's products.

product.collection.products.categories.category_children.metadata

object

The category's metadata, can hold custom key-value pairs.

product.collection.products.categories.parent_category

object

required

The product category's details.

Show child attributes

product.collection.products.categories.parent_category.category_children

object[]

required

The category's children.

product.collection.products.categories.parent_category.parent_category

object

required

product.collection.products.categories.parent_category.name

string

required

The category's name.

product.collection.products.categories.parent_category.description

string

required

The category's description.

product.collection.products.categories.parent_category.id

string

required

The category's ID.

product.collection.products.categories.parent_category.created_at

string<date-time>

required

The date the category was created.

product.collection.products.categories.parent_category.updated_at

string<date-time>

required

The date the category was updated.

product.collection.products.categories.parent_category.handle

string

required

The category's unique handle.

product.collection.products.categories.parent_category.deleted_at

string<date-time>

required

The date the category was deleted.

product.collection.products.categories.parent_category.is_active

boolean

required

Whether the category is active. If disabled, the category isn't shown in the storefront.

product.collection.products.categories.parent_category.is_internal

boolean

required

Whether the category is internal. If enabled, the category is only seen by admin users.

product.collection.products.categories.parent_category.rank

number

required

The category's rank among sibling categories.

product.collection.products.categories.parent_category.parent_category_id

string

required

The ID of the category's parent.

product.collection.products.categories.parent_category.products

object[]

The category's products.

product.collection.products.categories.parent_category.metadata

object

The category's metadata, can hold custom key-value pairs.

product.collection.products.categories.name

string

required

The category's name.

product.collection.products.categories.description

string

required

The category's description.

product.collection.products.categories.id

string

required

The category's ID.

product.collection.products.categories.created_at

string<date-time>

required

The date the category was created.

product.collection.products.categories.updated_at

string<date-time>

required

The date the category was updated.

product.collection.products.categories.handle

string

required

The category's unique handle.

product.collection.products.categories.deleted_at

string<date-time>

required

The date the category was deleted.

product.collection.products.categories.is_active

boolean

required

Whether the category is active. If disabled, the category isn't shown in the storefront.

product.collection.products.categories.is_internal

boolean

required

Whether the category is internal. If enabled, the category is only seen by admin users.

product.collection.products.categories.rank

number

required

The category's rank among sibling categories.

product.collection.products.categories.parent_category_id

string

required

The ID of the category's parent.

product.collection.products.categories.products

object[]

The category's products.

product.collection.products.categories.metadata

object

The category's metadata, can hold custom key-value pairs.

product.collection.products.type

object

The product type's details.

Show child attributes

product.collection.products.type.id

string

required

The type's ID.

product.collection.products.type.value

string

required

The type's value.

product.collection.products.type.created_at

string<date-time>

required

The date the type was created.

product.collection.products.type.updated_at

string<date-time>

required

The date the type was updated.

product.collection.products.type.deleted_at

string<date-time>

The date the type was deleted.

product.collection.products.type.metadata

object

The type's metadata, can hold custom key-value pairs.

product.collection.products.tags

object[]

The product's tags.

Show child attributes

product.collection.products.tags.id

string

required

The tag's ID.

product.collection.products.tags.value

string

required

The tag's value.

product.collection.products.tags.created_at

string<date-time>

required

The date the tag was created.

product.collection.products.tags.updated_at

string<date-time>

required

The date the tag was updated.

product.collection.products.tags.deleted_at

string<date-time>

The date the tag was deleted.

product.collection.products.tags.metadata

object

The tag's metadata, can hold custom key-value pairs.

product.collection.products.metadata

object

The product's metadata, can hold custom key-value pairs.

product.categories

object[]

The product's categories.

Show child attributes

product.categories.category_children

object[]

required

The category's children.

product.categories.parent_category

object

required

product.categories.name

string

required

The category's name.

product.categories.description

string

required

The category's description.

product.categories.id

string

required

The category's ID.

product.categories.created_at

string<date-time>

required

The date the category was created.

product.categories.updated_at

string<date-time>

required

The date the category was updated.

product.categories.handle

string

required

The category's unique handle.

product.categories.deleted_at

string<date-time>

required

The date the category was deleted.

product.categories.is_active

boolean

required

Whether the category is active. If disabled, the category isn't shown in the storefront.

product.categories.is_internal

boolean

required

Whether the category is internal. If enabled, the category is only seen by admin users.

product.categories.rank

number

required

The category's rank among sibling categories.

product.categories.parent_category_id

string

required

The ID of the category's parent.

product.categories.products

object[]

The category's products.

product.categories.metadata

object

The category's metadata, can hold custom key-value pairs.

product.sales_channels

object[]

The sales channels that the product is available in.

Show child attributes

product.sales_channels.id

string

required

The sales channel's ID.

product.sales_channels.name

string

required

The sales channel's name.

product.sales_channels.description

string

required

The sales channel's description.

product.sales_channels.is_disabled

boolean

required

Whether the sales channel is disabled.

product.sales_channels.metadata

object

required

The sales channel's metadata, can hold custom key-value pairs.

product.sales_channels.created_at

string<date-time>

required

The date the sales channel was created.

product.sales_channels.updated_at

string<date-time>

required

The date the sales channel was updated.

product.sales_channels.deleted_at

string<date-time>

required

The date the sales channel was deleted.

product.tags

object[]

The product's tags.

Show child attributes

product.tags.id

string

required

The tag's ID.

product.tags.value

string

required

The tag's value.

product.tags.created_at

string<date-time>

required

The date the tag was created.

product.tags.updated_at

string<date-time>

required

The date the tag was updated.

product.tags.deleted_at

string<date-time>

The date the tag was deleted.

product.tags.metadata

object

The tag's metadata, can hold custom key-value pairs.

product.metadata

object

The product's metadata, can hold custom key-value pairs.

product.shipping_profile

object

The shipping profile's details..

Show child attributes

product.shipping_profile.id

string

required

The shipping profile's ID.

product.shipping_profile.name

string

required

The shipping profile's name.

product.shipping_profile.type

string

required

The shipping profile's type.

product.shipping_profile.metadata

object

required

The shipping profile's metadata, holds custom key-value pairs.

product.shipping_profile.created_at

string<date-time>

required

The date the shipping profile was created.

product.shipping_profile.updated_at

string<date-time>

required

The date the shipping profile was updated.

product.shipping_profile.deleted_at

string<date-time>

required

The date the shipping profile was deleted.

Get a Product's Option

Delete an Option from Product

⌘I

Overview

Scanner API

Admin API

Authorizations

Path Parameters

Query Parameters

Body

Response