Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

ProductVariant - Product Module Data Models Reference

This documentation provides a reference to the ProductVariant data model. It belongs to the Product Module.

idPrimaryKeyModifier<IdProperty>
The ID of the product variant.
titleTextProperty
The title of the product variant
allow_backorderBooleanProperty
Whether customers can purchase this variant even if it's out of stock.
manage_inventoryBooleanProperty
Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock.
optionsManyToMany<ProductOptionValue>
The associated options.
skuTextPropertyOptional
The SKU of the product variant
barcodeTextPropertyOptional
The barcode of the product variant
eanTextPropertyOptional
The EAN of the product variant
upcTextPropertyOptional
The UPC of the product variant
hs_codeTextPropertyOptional
The HS code of the product variant
origin_countryTextPropertyOptional
The origin country of the product variant
mid_codeTextPropertyOptional
The MID code of the product variant
materialTextPropertyOptional
The material of the product variant
weightNumberPropertyOptional
The weight of the product variant
lengthNumberPropertyOptional
The length of the product variant
heightNumberPropertyOptional
The height of the product variant
widthNumberPropertyOptional
The width of the product variant
metadataJSONPropertyOptional
Holds custom data in key-value pairs.
variant_rankNumberPropertyOptional
The variant's rank among its siblings.
productBelongsTo<Product>Optional
The associated product.
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break
⇧↵