- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
- Get Started
- Product
- Resources
- Tools & SDKs
- Framework
- Reference
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#
Input#
CreateProductTypesWorkflowInput
CreateProductTypesWorkflowInputThe data to create one or more product types, along with custom data that's passed to the workflow's hooks.
CreateProductTypesWorkflowInput
CreateProductTypesWorkflowInputproduct_types
CreateProductTypeDTO[]The product types to create.
product_types
CreateProductTypeDTO[]additional_data
Record<string, unknown>OptionalAdditional data that can be passed through the additional_data
property in HTTP requests.
Learn more in this documentation.
additional_data
Record<string, unknown>Optionaladditional_data
property in HTTP requests.
Learn more in this documentation.Output#
ProductTypeDTO[]
ProductTypeDTO[]
ProductTypeDTO[]
ProductTypeDTO[]ProductTypeDTO
ProductTypeDTOA product type's data.
ProductTypeDTO
ProductTypeDTOHooks#
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#
This hook is executed after the product types are created. You can consume this hook to perform custom actions on the created product types.
Example
Input
Handlers consuming this hook accept the following input.
input
objectThe input data for the hook.
input
objectproduct_types
ProductTypeDTO[]
product_types
ProductTypeDTO[]additional_data
Record<string, unknown> | undefinedAdditional data that can be passed through the additional\_data
property in HTTP requests.
Learn more in this documentation.
additional_data
Record<string, unknown> | undefinedadditional\_data
property in HTTP requests.
Learn more in this documentation.