Manage Variants in a Product

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.batchVariants("prod_123", {
  create: [
    {
      title: "Blue Shirt",
      options: {
        Color: "Blue"
      },
      prices: []
    }
  ],
  update: [
    {
      id: "variant_123",
      title: "Pants"
    }
  ],
  delete: ["variant_123"]
})
.then(({ created, updated, deleted }) => {
  console.log(created, updated, deleted)
})

{
  "created": [
    {
      "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
        }
      ]
    }
  ],
  "updated": [
    {
      "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
        }
      ]
    }
  ],
  "deleted": {
    "ids": [
      "<string>"
    ],
    "object": "variant",
    "deleted": true
  }
}

POST

admin

products

{id}

variants

batch

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.batchVariants("prod_123", {
  create: [
    {
      title: "Blue Shirt",
      options: {
        Color: "Blue"
      },
      prices: []
    }
  ],
  update: [
    {
      id: "variant_123",
      title: "Pants"
    }
  ],
  delete: ["variant_123"]
})
.then(({ created, updated, deleted }) => {
  console.log(created, updated, deleted)
})

{
  "created": [
    {
      "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
        }
      ]
    }
  ],
  "updated": [
    {
      "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
        }
      ]
    }
  ],
  "deleted": {
    "ids": [
      "<string>"
    ],
    "object": "variant",
    "deleted": true
  }
}

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.

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 variants to create, update, or delete.

create

object[]

The product variants to create.

Show child attributes

create.title

string

required

The variant's title.

create.prices

object[]

required

The variant's prices.

Show child attributes

create.prices.currency_code

string

required

The price's currency code.

create.prices.amount

number

required

The price's amount.

create.prices.min_quantity

number

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

create.prices.max_quantity

number

The maximum quantity that must not be surpassed in the cart for this price to apply.

create.prices.rules

object

The price's rules.

Show child attributes

create.prices.rules.region_id

string

required

The ID of a region.

Example:

{ "region_id": "reg_123" }

create.sku

string

The variant's SKU.

create.ean

string

The variant's EAN.

create.upc

string

The variant's UPC.

create.barcode

string

The variant's barcode.

create.hs_code

string

The variant's HS code.

create.mid_code

string

The variant's MID code.

create.allow_backorder

boolean

Whether it's allowed to order this variant when it's out of stock.

create.manage_inventory

boolean

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

create.variant_rank

number

The sorting order of the variant among other variants in the product.

create.weight

number

The variant's weight.

create.length

number

The variant's length.

create.height

number

The variant's height.

create.width

number

The variant's width.

create.origin_country

string

The variant's origin country.

create.material

string

The variant's material.

create.metadata

object

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

create.options

object

The variant's options, where the key is an option's name, and the value is the option's value.

Example:

{ "Color": "Black" }

create.inventory_items

object[]

The variant's inventory items to create.

Show child attributes

create.inventory_items.inventory_item_id

string

required

The inventory item's ID.

create.inventory_items.required_quantity

number

The number of units a single quantity is equivalent to. For example, if a customer orders one quantity of the variant, Medusa checks the availability of the quantity multiplied by the value set for required_quantity. When the customer orders the quantity, Medusa reserves the ordered quantity multiplied by the value set for required_quantity.

update

object[]

The product variants to update.

Show child attributes

update.id

string

required

The update's ID.

update.title

string

The product variant's title.

update.sku

string

The product variant's SKU.

update.ean

string

The product variant's EAN.

update.upc

string

The product variant's UPC.

update.barcode

string

The product variant's barcode.

update.hs_code

string

The product variant's HS code.

update.mid_code

string

The product variant's MID code.

update.allow_backorder

boolean

Whether customers can order the variant even if it's not in stock.

update.manage_inventory

boolean

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

update.variant_rank

number

The product variant's rank among its siblings.

update.weight

number

The product variant's weight.

update.length

number

The product variant's length.

update.height

number

The product variant's height.

update.width

number

The product variant's width.

update.origin_country

string

The product variant's origin country.

update.material

string

The product variant's material.

update.metadata

object

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

update.prices

object[]

The product variant's prices.

Show child attributes

update.prices.currency_code

string

required

The price's currency code.

update.prices.amount

number

required

The price's amount.

update.prices.min_quantity

number

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

update.prices.max_quantity

number

The maximum quantity that must not be surpassed in the cart for this price to apply.

update.prices.rules

object

The price's rules.

Show child attributes

update.prices.rules.region_id

string

required

The ID of a region.

Example:

{ "region_id": "reg_123" }

update.options

object

The product variant's options.

update.thumbnail

string

The variant's thumbnail.

delete

string[]

The product variants to delete.

A product variant's ID.

Response

The details of the product variants created, updated, or deleted.

created

object[]

required

The created product variants.

Show child attributes

created.prices

object[]

required

The variant's prices.

Show child attributes

created.prices.id

string

required

The price's ID.

created.prices.title

string

required

The price's title.

created.prices.currency_code

string

required

The price's currency code.

Example:

"usd"

created.prices.amount

number

required

The price's amount.

created.prices.raw_amount

object

required

The price's raw amount.

created.prices.min_quantity

number

required

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

created.prices.max_quantity

number

required

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

created.prices.price_set_id

string

required

The ID of the associated price set.

created.prices.created_at

string<date-time>

required

The date the price was created.

created.prices.updated_at

string<date-time>

required

The date the price was updated.

created.prices.deleted_at

string<date-time>

required

The date the price was deleted.

created.id

string

required

The variant's ID.

created.title

string

required

The variant's title.

created.sku

string

required

The variant's SKU.

created.barcode

string

required

The variant's barcode.

created.ean

string

required

The variant's EAN code.

created.upc

string

required

The variant's UPC.

created.allow_backorder

boolean

required

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

created.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.

created.hs_code

string

required

The variant's HS code.

created.origin_country

string

required

The variant's origin country.

created.mid_code

string

required

The variant's MID code.

created.material

string

required

The variant's material.

created.weight

number

required

The variant's weight.

created.length

number

required

The variant's length.

created.height

number

required

The variant's height.

created.width

number

required

The variant's width.

created.options

object[]

required

The variant's option values.

Show child attributes

created.options.id

string

required

The value's ID.

created.options.value

string

required

The value.

created.options.option

object

The product option's details.

Show child attributes

created.options.option.id

string

required

The product option's ID.

created.options.option.title

string

required

The product option's title.

created.options.option.product

object

created.options.option.product_id

string

The ID of the product this option belongs to.

created.options.option.values

object[]

The product option's values.

created.options.option.metadata

object

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

created.options.option.created_at

string<date-time>

The date the product option was created.

created.options.option.updated_at

string<date-time>

The date the product option was updated.

created.options.option.deleted_at

string<date-time>

The date the product option was deleted.

created.options.option_id

string

The ID of the option this value belongs to.

created.options.metadata

object

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

created.options.created_at

string<date-time>

The date the value was created.

created.options.updated_at

string<date-time>

The date the value was updated.

created.options.deleted_at

string<date-time>

The date the value was deleted.

created.created_at

string<date-time>

required

The date the variant was created.

created.updated_at

string<date-time>

required

The date the variant was updated.

created.deleted_at

string<date-time>

required

The date the variant was deleted.

created.images

object[]

required

The variant's images.

Show child attributes

created.images.id

string

required

The image's ID.

created.images.url

string

required

The image's URL.

created.images.rank

number

required

The image's rank among its sibling images.

created.images.created_at

string<date-time>

The date the image was created.

created.images.updated_at

string<date-time>

The date the image was updated.

created.images.deleted_at

string<date-time>

The date the image was deleted.

created.images.metadata

object

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

created.thumbnail

string

required

The variant's thumbnail.

created.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.

created.variant_rank

number

The variant's rank among its sibling variants.

created.product

object

created.product_id

string

The ID of the product that the variant belongs to.

created.calculated_price

object

The calculated price's details.

Show child attributes

created.calculated_price.id

string

required

The calculated price's ID.

created.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.

created.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.

created.calculated_price.currency_code

string

required

The calculated price's currency code.

Example:

"usd"

created.calculated_price.original_amount_with_tax

number

required

The amount of the original price with taxes applied.

created.calculated_price.original_amount_without_tax

number

required

The amount of the original price without taxes.

created.calculated_price.is_calculated_price_price_list

boolean

Whether the calculated price belongs to a price list.

created.calculated_price.is_calculated_price_tax_inclusive

boolean

Whether the calculated price is tax inclusive.

created.calculated_price.calculated_amount_with_tax

number

The calculated price's amount with taxes applied.

created.calculated_price.calculated_amount_without_tax

number

The calculated price's amount without taxes applied.

created.calculated_price.is_original_price_price_list

boolean

Whether the original price belongs to a price list.

created.calculated_price.is_original_price_tax_inclusive

boolean

Whether the original price is tax inclusive.

created.calculated_price.calculated_price

object

The calculated price's details.

created.calculated_price.original_price

object

The original price's details.

created.metadata

object

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

created.inventory_items

object[]

The variant's inventory items.

Show child attributes

created.inventory_items.id

string

required

The ID of the association.

created.inventory_items.variant_id

string

required

The associated product variant's ID.

created.inventory_items.inventory_item_id

string

required

The associated inventory item's ID.

created.inventory_items.variant

object

created.inventory_items.inventory

object

The inventory item's details.

Show child attributes

created.inventory_items.inventory.id

string

required

The inventory item's ID.

created.inventory_items.inventory.requires_shipping

boolean

required

Whether the inventory item requires shipping.

created.inventory_items.inventory.sku

string

The inventory item's sku.

created.inventory_items.inventory.origin_country

string

The inventory item's origin country.

created.inventory_items.inventory.hs_code

string

The inventory item's HS code.

created.inventory_items.inventory.mid_code

string

The inventory item's MID code.

created.inventory_items.inventory.material

string

The inventory item's material.

created.inventory_items.inventory.weight

number

The inventory item's weight.

created.inventory_items.inventory.length

number

The inventory item's length.

created.inventory_items.inventory.height

number

The inventory item's height.

created.inventory_items.inventory.width

number

The inventory item's width.

created.inventory_items.inventory.title

string

The inventory item's title.

created.inventory_items.inventory.description

string

The inventory item's description.

created.inventory_items.inventory.thumbnail

string

The thumbnail URL of the inventory item.

created.inventory_items.inventory.metadata

object

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

created.inventory_items.inventory.location_levels

object[]

The inventory item's location levels.

Show child attributes

created.inventory_items.inventory.location_levels.id

string

required

The location level's ID.

created.inventory_items.inventory.location_levels.created_at

string<date-time>

required

The location level's created at.

created.inventory_items.inventory.location_levels.updated_at

string<date-time>

required

The location level's updated at.

created.inventory_items.inventory.location_levels.deleted_at

string<date-time>

required

The location level's deleted at.

created.inventory_items.inventory.location_levels.inventory_item_id

string

required

The location level's inventory item id.

created.inventory_items.inventory.location_levels.location_id

string

required

The location level's location id.

created.inventory_items.inventory.location_levels.stocked_quantity

number

required

The location level's stocked quantity.

created.inventory_items.inventory.location_levels.reserved_quantity

number

required

The location level's reserved quantity.

created.inventory_items.inventory.location_levels.incoming_quantity

number

required

The location level's incoming quantity.

created.inventory_items.inventory.location_levels.metadata

object

required

The location level's metadata.

created.inventory_items.inventory.location_levels.available_quantity

number

required

The location level's available quantity.

created.inventory_items.inventory.location_levels.inventory_item

object

created.inventory_items.required_quantity

number

The inventory item's required quantity.

updated

object[]

required

The updated product variants.

Show child attributes

updated.prices

object[]

required

The variant's prices.

Show child attributes

updated.prices.id

string

required

The price's ID.

updated.prices.title

string

required

The price's title.

updated.prices.currency_code

string

required

The price's currency code.

Example:

"usd"

updated.prices.amount

number

required

The price's amount.

updated.prices.raw_amount

object

required

The price's raw amount.

updated.prices.min_quantity

number

required

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

updated.prices.max_quantity

number

required

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

updated.prices.price_set_id

string

required

The ID of the associated price set.

updated.prices.created_at

string<date-time>

required

The date the price was created.

updated.prices.updated_at

string<date-time>

required

The date the price was updated.

updated.prices.deleted_at

string<date-time>

required

The date the price was deleted.

updated.id

string

required

The variant's ID.

updated.title

string

required

The variant's title.

updated.sku

string

required

The variant's SKU.

updated.barcode

string

required

The variant's barcode.

updated.ean

string

required

The variant's EAN code.

updated.upc

string

required

The variant's UPC.

updated.allow_backorder

boolean

required

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

updated.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.

updated.hs_code

string

required

The variant's HS code.

updated.origin_country

string

required

The variant's origin country.

updated.mid_code

string

required

The variant's MID code.

updated.material

string

required

The variant's material.

updated.weight

number

required

The variant's weight.

updated.length

number

required

The variant's length.

updated.height

number

required

The variant's height.

updated.width

number

required

The variant's width.

updated.options

object[]

required

The variant's option values.

Show child attributes

updated.options.id

string

required

The value's ID.

updated.options.value

string

required

The value.

updated.options.option

object

The product option's details.

Show child attributes

updated.options.option.id

string

required

The product option's ID.

updated.options.option.title

string

required

The product option's title.

updated.options.option.product

object

updated.options.option.product_id

string

The ID of the product this option belongs to.

updated.options.option.values

object[]

The product option's values.

updated.options.option.metadata

object

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

updated.options.option.created_at

string<date-time>

The date the product option was created.

updated.options.option.updated_at

string<date-time>

The date the product option was updated.

updated.options.option.deleted_at

string<date-time>

The date the product option was deleted.

updated.options.option_id

string

The ID of the option this value belongs to.

updated.options.metadata

object

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

updated.options.created_at

string<date-time>

The date the value was created.

updated.options.updated_at

string<date-time>

The date the value was updated.

updated.options.deleted_at

string<date-time>

The date the value was deleted.

updated.created_at

string<date-time>

required

The date the variant was created.

updated.updated_at

string<date-time>

required

The date the variant was updated.

updated.deleted_at

string<date-time>

required

The date the variant was deleted.

updated.images

object[]

required

The variant's images.

Show child attributes

updated.images.id

string

required

The image's ID.

updated.images.url

string

required

The image's URL.

updated.images.rank

number

required

The image's rank among its sibling images.

updated.images.created_at

string<date-time>

The date the image was created.

updated.images.updated_at

string<date-time>

The date the image was updated.

updated.images.deleted_at

string<date-time>

The date the image was deleted.

updated.images.metadata

object

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

updated.thumbnail

string

required

The variant's thumbnail.

updated.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.

updated.variant_rank

number

The variant's rank among its sibling variants.

updated.product

object

updated.product_id

string

The ID of the product that the variant belongs to.

updated.calculated_price

object

The calculated price's details.

Show child attributes

updated.calculated_price.id

string

required

The calculated price's ID.

updated.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.

updated.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.

updated.calculated_price.currency_code

string

required

The calculated price's currency code.

Example:

"usd"

updated.calculated_price.original_amount_with_tax

number

required

The amount of the original price with taxes applied.

updated.calculated_price.original_amount_without_tax

number

required

The amount of the original price without taxes.

updated.calculated_price.is_calculated_price_price_list

boolean

Whether the calculated price belongs to a price list.

updated.calculated_price.is_calculated_price_tax_inclusive

boolean

Whether the calculated price is tax inclusive.

updated.calculated_price.calculated_amount_with_tax

number

The calculated price's amount with taxes applied.

updated.calculated_price.calculated_amount_without_tax

number

The calculated price's amount without taxes applied.

updated.calculated_price.is_original_price_price_list

boolean

Whether the original price belongs to a price list.

updated.calculated_price.is_original_price_tax_inclusive

boolean

Whether the original price is tax inclusive.

updated.calculated_price.calculated_price

object

The calculated price's details.

updated.calculated_price.original_price

object

The original price's details.

updated.metadata

object

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

updated.inventory_items

object[]

The variant's inventory items.

Show child attributes

updated.inventory_items.id

string

required

The ID of the association.

updated.inventory_items.variant_id

string

required

The associated product variant's ID.

updated.inventory_items.inventory_item_id

string

required

The associated inventory item's ID.

updated.inventory_items.variant

object

updated.inventory_items.inventory

object

The inventory item's details.

Show child attributes

updated.inventory_items.inventory.id

string

required

The inventory item's ID.

updated.inventory_items.inventory.requires_shipping

boolean

required

Whether the inventory item requires shipping.

updated.inventory_items.inventory.sku

string

The inventory item's sku.

updated.inventory_items.inventory.origin_country

string

The inventory item's origin country.

updated.inventory_items.inventory.hs_code

string

The inventory item's HS code.

updated.inventory_items.inventory.mid_code

string

The inventory item's MID code.

updated.inventory_items.inventory.material

string

The inventory item's material.

updated.inventory_items.inventory.weight

number

The inventory item's weight.

updated.inventory_items.inventory.length

number

The inventory item's length.

updated.inventory_items.inventory.height

number

The inventory item's height.

updated.inventory_items.inventory.width

number

The inventory item's width.

updated.inventory_items.inventory.title

string

The inventory item's title.

updated.inventory_items.inventory.description

string

The inventory item's description.

updated.inventory_items.inventory.thumbnail

string

The thumbnail URL of the inventory item.

updated.inventory_items.inventory.metadata

object

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

updated.inventory_items.inventory.location_levels

object[]

The inventory item's location levels.

Show child attributes

updated.inventory_items.inventory.location_levels.id

string

required

The location level's ID.

updated.inventory_items.inventory.location_levels.created_at

string<date-time>

required

The location level's created at.

updated.inventory_items.inventory.location_levels.updated_at

string<date-time>

required

The location level's updated at.

updated.inventory_items.inventory.location_levels.deleted_at

string<date-time>

required

The location level's deleted at.

updated.inventory_items.inventory.location_levels.inventory_item_id

string

required

The location level's inventory item id.

updated.inventory_items.inventory.location_levels.location_id

string

required

The location level's location id.

updated.inventory_items.inventory.location_levels.stocked_quantity

number

required

The location level's stocked quantity.

updated.inventory_items.inventory.location_levels.reserved_quantity

number

required

The location level's reserved quantity.

updated.inventory_items.inventory.location_levels.incoming_quantity

number

required

The location level's incoming quantity.

updated.inventory_items.inventory.location_levels.metadata

object

required

The location level's metadata.

updated.inventory_items.inventory.location_levels.available_quantity

number

required

The location level's available quantity.

updated.inventory_items.inventory.location_levels.inventory_item

object

updated.inventory_items.required_quantity

number

The inventory item's required quantity.

deleted

object

required

The details of the deleted product variants.

Show child attributes

deleted.ids

string[]

required

The IDs of the deleted product variants.

The ID of a deleted variant.

deleted.object

string

default:variant

required

The name of the deleted objects.

deleted.deleted

boolean

required

Whether the product variants were deleted.

Create a Product Variant

Manage Variants Inventory in a Product

⌘I

Overview

Scanner API

Admin API

Authorizations

Path Parameters

Query Parameters

Body

Response