updateProductOptionsWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the updateProductOptionsWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow updates one or more product options. It's used by the Update Product Option Admin API Route.
This workflow has a hook that allows you to perform custom actions on the updated product options. For example, you can pass under additional_data custom data that
allows you to update 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 update.
Source CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
UpdateProductOptionsWorkflowInputUpdateProductOptionsWorkflowInputThe data to update one or more product options, along with custom data that's passed to the workflow's hooks.
UpdateProductOptionsWorkflowInputUpdateProductOptionsWorkflowInputselectorFilterableProductOptionPropsThe filters to select the product options to update.
selectorFilterableProductOptionPropsupdateUpdateProductOptionDTOThe data to update in the product options.
updateUpdateProductOptionDTOadditional_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#
ProductOptionDTO[]ProductOptionDTO[]
ProductOptionDTO[]ProductOptionDTO[]idstringThe ID of the product option.
idstringtitlestringThe title of the product option.
titlestringThe associated product option values.
created_atstring | DateWhen the product option was created.
created_atstring | Dateupdated_atstring | DateWhen the product option was updated.
updated_atstring | DateThe associated product.
product_idnull | stringOptionalThe associated product id.
product_idnull | stringOptionalHolds custom data in key-value pairs.
deleted_atstring | DateOptionalWhen the product option 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.
productOptionsUpdated#
Handlers consuming this hook accept the following input.
inputobject
inputobjectproduct_optionsProductOptionDTO[]
product_optionsProductOptionDTO[]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.