createProductTypesWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the createProductTypesWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow creates one or more product types. It's used by the Create Product Type Admin API Route.
This workflow has a hook that allows you to perform custom actions on the created product types. For example, you can pass under additional_data custom data that
allows you to create custom data models linked to the product types.
You can also use this workflow within your own custom workflows, allowing you to wrap custom logic around product-type creation.
Source CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
CreateProductTypesWorkflowInputCreateProductTypesWorkflowInputThe data to create one or more product types, along with custom data that's passed to the workflow's hooks.
CreateProductTypesWorkflowInputCreateProductTypesWorkflowInputproduct_typesCreateProductTypeDTO[]The product types to create.
product_typesCreateProductTypeDTO[]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#
ProductTypeDTO[]ProductTypeDTO[]
ProductTypeDTO[]ProductTypeDTO[]idstringThe ID of the product type.
idstringvaluestringThe value of the product type.
valuestringcreated_atstring | DateWhen the product type was created.
created_atstring | Dateupdated_atstring | DateWhen the product type was updated.
updated_atstring | DateHolds custom data in key-value pairs.
deleted_atstring | DateOptionalWhen the product type was deleted.
deleted_atstring | DateOptionalHooks#
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.
productTypesCreated#
Handlers consuming this hook accept the following input.
inputobject
inputobjectproduct_typesProductTypeDTO[]
product_typesProductTypeDTO[]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.