createProductOptionsWorkflow - Medusa Core Workflows Reference

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

This workflow creates one or more product options. It's used by the Create Product Option Admin API Route.

This workflow has a hook that allows you to perform custom actions on the created product options. For example, you can pass under additional_data custom data that allows you to create custom data models linked to the product options.

You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around product-option creation.

Source Code

Examples#

Steps#

Input#

CreateProductOptionsWorkflowInputCreateProductOptionsWorkflowInput
The data to create one or more product options, along with custom data that's passed to the workflow's hooks.
product_optionsCreateProductOptionDTO[]
The product options to create.
additional_dataRecord<string, unknown>Optional
Additional data that can be passed through the additional_data property in HTTP requests. Learn more in this documentation.

Output#

ProductOptionDTO[]ProductOptionDTO[]
ProductOptionDTOProductOptionDTO
A product option's data.

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.

productOptionsCreated#

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

Example

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

Input

Handlers consuming this hook accept the following input.

inputobject
The input data for the hook.
product_optionsProductOptionDTO[]
additional_dataRecord<string, unknown> | undefined
Additional data that can be passed through the additional\_data property in HTTP requests. Learn more in this documentation.
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