Menu

createProductVariantsStep - Medusa Core Workflows Reference

This documentation provides a reference to the createProductVariantsStep. It belongs to the @medusajs/medusa/core-flows package.

This step creates one or more product variants.

Example#

Code
1const data = createProductVariantsStep([{2  title: "Small Shirt",3  options: {4    Size: "S",5  },6  product_id: "prod_123",7}])

Input#

CreateProductVariantDTO[]CreateProductVariantDTO[]
titlestring
The tile of the product variant.
product_idstringOptional
The id of the product
skustringOptional
The SKU of the product variant.
barcodestringOptional
The barcode of the product variant.
eanstringOptional
The EAN of the product variant.
upcstringOptional
The UPC of the product variant.
allow_backorderbooleanOptional
Whether the product variant can be ordered when it's out of stock.
manage_inventorybooleanOptional
Whether the product variant's inventory should be managed by the core system.
inventory_itemsCreateProductVariantInventoryKit[]Optional
The variant's inventory items. It's only available if manage_inventory is enabled.
hs_codestringOptional
The HS Code of the product variant.
origin_countrystringOptional
The origin country of the product variant.
mid_codestringOptional
The MID Code of the product variant.
materialstringOptional
The material of the product variant.
weightnumberOptional
The weight of the product variant.
lengthnumberOptional
The length of the product variant.
heightnumberOptional
The height of the product variant.
widthnumberOptional
The width of the product variant.
optionsRecord<string, string>Optional
The options of the variant. Each key is an option's title, and value is an option's value. If an option with the specified title doesn't exist, a new one is created.
metadataMetadataTypeOptional
Holds custom data in key-value pairs.

Output#

ProductVariantDTO[]ProductVariantDTO[]
idstring
The ID of the product variant.
titlestring
The tile of the product variant.
skunull | string
The SKU of the product variant.
barcodenull | string
The barcode of the product variant.
eannull | string
The EAN of the product variant.
upcnull | string
The UPC of the product variant.
allow_backorderboolean
Whether the product variant can be ordered when it's out of stock.
manage_inventoryboolean
Whether the product variant's inventory should be managed by the core system.
requires_shippingboolean
Whether the product variant's requires shipping.
hs_codenull | string
The HS Code of the product variant.
origin_countrynull | string
The origin country of the product variant.
mid_codenull | string
The MID Code of the product variant.
materialnull | string
The material of the product variant.
weightnull | number
The weight of the product variant.
lengthnull | number
The length of the product variant.
heightnull | number
The height of the product variant.
widthnull | number
The width of the product variant.
optionsProductOptionValueDTO[]
The associated product options.
metadatanull | Record<string, unknown>
Holds custom data in key-value pairs.
product_idnull | string
The associated product id.
created_atstring | Date
When the product variant was created.
updated_atstring | Date
When the product variant was updated.
deleted_atstring | Date
When the product variant was deleted.
productnull | ProductDTOOptional
The associated product.
variant_ranknull | numberOptional
he ranking of the variant among other variants associated with the 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
⇧↵