- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
Menu
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
BaseProductVariant
Properties#
idstringThe variant's ID.
titlenull | stringThe variant's title.
skunull | stringThe variant's SKU.
barcodenull | stringThe variant's barcode.
eannull | stringThe variant's EAN.
upcnull | stringThe variant's UPC.
allow_backordernull | booleanWhether the variant can be ordered even if it's out of stock.
manage_inventorynull | booleanWhether Medusa manages the variant's inventory. If disabled, the variant
is always considered in stock.
hs_codenull | stringThe variant's HS code.
origin_countrynull | stringThe variant's origin country.
mid_codenull | stringThe variant's MID code.
materialnull | stringThe variant's material.
weightnull | numberThe variant's weight.
lengthnull | numberThe variant's length.
heightnull | numberThe variant's height.
widthnull | numberThe variant's width.
optionsnull | BaseProductOptionValue[]The variant's values for the product's options.
optionsnull | BaseProductOptionValue[]created_atstringThe date the variant was created.
updated_atstringThe date the variant was updated.
deleted_atnull | stringThe date the variant was deleted.
inventory_quantitynumberOptionalThe variant's inventory quantity if
manage_inventory is enabled.variant_ranknull | numberOptionalThe variant's ranking among its siblings.
The variant's product.
product_idstringOptionalThe ID of the product that the variant belongs to.
The variant's calculated price for the provided context.
metadatanull | Record<string, unknown>OptionalKey-value pairs of custom data.
Was this page helpful?