updateProductTypesWorkflow - Medusa Core Workflows Reference

This documentation provides a reference to the updateProductTypesWorkflow. It belongs to the @medusajs/medusa/core-flows package.

This workflow updates one or more product types. It's used by the Update Product Type Admin API Route.

This workflow has a hook that allows you to perform custom actions on the updated product types. For example, you can pass under additional_data custom data that allows you to update 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 updates.

Source Code

Examples#

Steps#

Workflow hook

Step conditioned by when

View step details

Input#

UpdateProductTypesWorkflowInputUpdateProductTypesWorkflowInput

Output#

ProductTypeDTO[]ProductTypeDTO[]
idstring
The ID of the product type.
valuestring
The value of the product type.
created_atstring | Date
When the product type was created.
updated_atstring | Date
When the product type was updated.
metadataMetadataTypeOptional
Holds custom data in key-value pairs.
deleted_atstring | DateOptional
When the product type was deleted.

Hooks#

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.

productTypesUpdated#

This hook is executed after the product types are updated. You can consume this hook to perform custom actions on the updated product types.

Example

Code
1import { updateProductTypesWorkflow } from "@medusajs/medusa/core-flows"2
3updateProductTypesWorkflow.hooks.productTypesUpdated(4  (async ({ product_types, additional_data }, { container }) => {5    //TODO6  })7)

Input

Handlers consuming this hook accept the following input.

inputinput
The input data for the hook.
product_typesProductTypeDTO[]
additional_dataRecord<string, unknown> | undefined
Additional data that can be passed through the additional_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

product-type.updated

Emitted when product types are updated.

[{
  id, // The ID of the product type
}]
Was this page helpful?
Ask Anything
FAQ
What is Medusa?
How can I create a module?
How can I create a data model?
How do I create a workflow?
How can I extend a data model in the Product Module?
Recipes
How do I build a marketplace with Medusa?
How do I build digital products with Medusa?
How do I build subscription-based purchases with Medusa?
What other recipes are available in the Medusa documentation?
Chat is cleared on refresh
Line break