createProductVariantsWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the createProductVariantsWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow creates one or more product variants. It's used by the Create Product Variant Admin API Route.
This workflow has a hook that allows you to perform custom actions on the created product variants. For example, you can pass under additional_data custom data that
allows you to create custom data models linked to the product variants.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around product-variant creation.
Source CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
CreateProductVariantsWorkflowInputCreateProductVariantsWorkflowInputThe data to create one or more product variants, along with custom data that's passed to the workflow's hooks.
CreateProductVariantsWorkflowInputCreateProductVariantsWorkflowInputproduct_variantsCreateProductVariantDTO & object & object[]The product variants to create.
product_variantsCreateProductVariantDTO & object & object[]additional_dataRecord<string, unknown>OptionalAdditional data that can be passed through the additional_data property in HTTP requests.
Learn more in this documentation.
additional_dataRecord<string, unknown>Optionaladditional_data property in HTTP requests.
Learn more in this documentation.Output#
object[]object[]
object[]object[]pricesMoneyAmountDTO[]
pricesMoneyAmountDTO[]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 | numberOptionalHooks#
Hooks allow you to inject custom functionalities into the workflow. You'll receive data from the workflow, as well as additional data sent through an HTTP request.
Learn more about Hooks and Additional Data.
productVariantsCreated#
This hook is executed after the product variants are created. You can consume this hook to perform custom actions on the created product variants.
Example
Input
Handlers consuming this hook accept the following input.
inputobjectThe input data for the hook.
inputobjectproduct_variantsobject[]
product_variantsobject[]additional_dataRecord<string, unknown> | undefinedAdditional data that can be passed through the additional_data property in HTTP requests.
Learn more in this documentation.
additional_dataRecord<string, unknown> | undefinedadditional_data property in HTTP requests.
Learn more in this documentation.