This documentation provides a reference to the createProductCategoriesWorkflow
. It belongs to the @medusajs/medusa/core-flows
package.
This workflow creates one or more product categories. It's used by the Create Product Category Admin API Route.
You can use this workflow within your customizations or your own custom workflows, allowing you to create product categories within your custom flows.
Source CodeWorkflow hook
Step conditioned by when
View step details
CreateProductCategoriesWorkflowInput
CreateProductCategoriesWorkflowInputproduct_categories
CreateProductCategoryDTO[]additional_data
Record<string, unknown>Optionaladditional_data
property in HTTP requests.
Learn more in this documentation.ProductCategoryDTO[]
ProductCategoryDTO[]id
stringname
stringdescription
stringhandle
stringis_active
booleanis_internal
booleanrank
numberparent_category_id
null | stringcreated_at
string | Dateupdated_at
string | Datedeleted_at
string | DateOptionalHooks 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.
This step is a hook that you can inject custom functionality into.
Handlers consuming this hook accept the following input.
input
inputcategories
ProductCategoryDTO[]additional_data
Record<string, unknown> | undefinedadditional_data
property in HTTP requests.
Learn more in this documentation.This section lists the events that are either triggered by the emitEventStep
in the workflow, or by another workflow executed within this workflow.
You can listen to these events in a subscriber, as explained in the Subscribers documentation.
Event | Description | Payload | Action |
---|---|---|---|
| Emitted when product categories are created. |
|