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 CodeWorkflow hook
Step conditioned by when
View step details
CreateProductOptionsWorkflowInput
CreateProductOptionsWorkflowInputproduct_options
CreateProductOptionDTO[]additional_data
Record<string, unknown>Optionaladditional_data
property in HTTP requests.
Learn more in this documentation.ProductOptionDTO[]
ProductOptionDTO[]id
stringtitle
stringcreated_at
string | Dateupdated_at
string | Dateproduct_id
null | stringOptionaldeleted_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 hook is executed after the product options are created. You can consume this hook to perform custom actions on the created product options.
Handlers consuming this hook accept the following input.
input
inputproduct_options
ProductOptionDTO[]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 options are created. |
|