Loading...
Was this page helpful?
Loading...
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#
Input#
CreateProductVariantDTO[]CreateProductVariantDTO[]
CreateProductVariantDTO[]CreateProductVariantDTO[]titlestringThe tile of the product variant.
titlestringproduct_idstringOptionalThe id of the product
product_idstringOptionalskustringOptionalThe SKU of the product variant.
skustringOptionalbarcodestringOptionalThe barcode of the product variant.
barcodestringOptionaleanstringOptionalThe EAN of the product variant.
eanstringOptionalupcstringOptionalThe UPC of the product variant.
upcstringOptionalallow_backorderbooleanOptionalWhether the product variant can be ordered when it's out of stock.
allow_backorderbooleanOptionalmanage_inventorybooleanOptionalWhether the product variant's inventory should be managed by the core system.
manage_inventorybooleanOptionalThe variant's inventory items. It's only
available if manage_inventory is enabled.
manage_inventory is enabled.hs_codestringOptionalThe HS Code of the product variant.
hs_codestringOptionalorigin_countrystringOptionalThe origin country of the product variant.
origin_countrystringOptionalmid_codestringOptionalThe MID Code of the product variant.
mid_codestringOptionalmaterialstringOptionalThe material of the product variant.
materialstringOptionalweightnumberOptionalThe weight of the product variant.
weightnumberOptionallengthnumberOptionalThe length of the product variant.
lengthnumberOptionalheightnumberOptionalThe height of the product variant.
heightnumberOptionalwidthnumberOptionalThe width of the product variant.
widthnumberOptionaloptionsRecord<string, string>OptionalThe 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.
optionsRecord<string, string>OptionalHolds custom data in key-value pairs.
Output#
ProductVariantDTO[]ProductVariantDTO[]
ProductVariantDTO[]ProductVariantDTO[]idstringThe ID of the product variant.
idstringtitlestringThe tile of the product variant.
titlestringskunull | stringThe SKU of the product variant.
skunull | stringbarcodenull | stringThe barcode of the product variant.
barcodenull | stringeannull | stringThe EAN of the product variant.
eannull | stringupcnull | stringThe UPC of the product variant.
upcnull | stringallow_backorderbooleanWhether the product variant can be ordered when it's out of stock.
allow_backorderbooleanmanage_inventorybooleanWhether the product variant's inventory should be managed by the core system.
manage_inventorybooleanrequires_shippingbooleanWhether the product variant's requires shipping.
requires_shippingbooleanhs_codenull | stringThe HS Code of the product variant.
hs_codenull | stringorigin_countrynull | stringThe origin country of the product variant.
origin_countrynull | stringmid_codenull | stringThe MID Code of the product variant.
mid_codenull | stringmaterialnull | stringThe material of the product variant.
materialnull | stringweightnull | numberThe weight of the product variant.
weightnull | numberlengthnull | numberThe length of the product variant.
lengthnull | numberheightnull | numberThe height of the product variant.
heightnull | numberwidthnull | numberThe width of the product variant.
widthnull | numberThe associated product options.
metadatanull | Record<string, unknown>Holds custom data in key-value pairs.
metadatanull | Record<string, unknown>product_idnull | stringThe associated product id.
product_idnull | stringcreated_atstring | DateWhen the product variant was created.
created_atstring | Dateupdated_atstring | DateWhen the product variant was updated.
updated_atstring | Datedeleted_atstring | DateWhen the product variant was deleted.
deleted_atstring | DateThe associated product.
variant_ranknull | numberOptionalhe ranking of the variant among other variants associated with the product.
variant_ranknull | numberOptional