updateProductCategoriesWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the updateProductCategoriesWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow updates product categories matching specified filters. It's used by the Update Product Category Admin API Route.
You can use this workflow within your customizations or your own custom workflows, allowing you to update product categories within your custom flows.
Source CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
UpdateProductCategoriesWorkflowInputUpdateProductCategoriesWorkflowInput
UpdateProductCategoriesWorkflowInputUpdateProductCategoriesWorkflowInputselectorFilterableProductCategoryPropsThe filters to select the product categories to update.
selectorFilterableProductCategoryPropsupdateUpdateProductCategoryDTOThe data to update in the product categories.
updateUpdateProductCategoryDTOadditional_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#
ProductCategoryDTO[]ProductCategoryDTO[]
ProductCategoryDTO[]ProductCategoryDTO[]idstringThe ID of the product category.
idstringnamestringThe name of the product category.
namestringdescriptionstringThe description of the product category.
descriptionstringhandlestringThe handle of the product category. The handle can be used to create slug URL paths.
handlestringis_activebooleanWhether the product category is active.
is_activebooleanis_internalbooleanWhether the product category is internal. This can be used to only show the product category to admins and hide it from customers.
is_internalbooleanranknumberThe ranking of the product category among sibling categories.
ranknumberThe associated parent category.
parent_category_idnull | stringThe associated parent category id.
parent_category_idnull | stringThe associated child categories.
The associated products.
created_atstring | DateWhen the product category was created.
created_atstring | Dateupdated_atstring | DateWhen the product category was updated.
updated_atstring | DateThe ranking of the product category among sibling categories.
deleted_atstring | DateOptionalWhen the product category 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.
categoriesUpdated#
This step is a hook that you can inject custom functionality into.
Example
Input
Handlers consuming this hook accept the following input.
inputinputThe input data for the hook.
inputinputcategoriesProductCategoryDTO[]
categoriesProductCategoryDTO[]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.Emitted Events#
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 updated. |
|