updateProductsWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the updateProductsWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow updates one or more products. It's used by the Update Product Admin API Route.
This workflow has a hook that allows you to perform custom actions on the updated products. For example, you can pass under additional_data custom data that
allows you to update custom data models linked to the products.
You can also use this workflow within your customizations or your own custom workflows, allowing you to wrap custom logic around product update.
Source CodeExamples#
To update products by their IDs:
You can also update products by a selector:
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
UpdateProductWorkflowInputUpdateProductWorkflowInputThe data to update one or more products, along with custom data that's passed to the workflow's hooks.
UpdateProductWorkflowInputUpdateProductWorkflowInputselectorFilterableProductPropsThe filters to find products to update.
selectorFilterableProductPropsupdateOmit<UpdateProductDTO, "variants"> & objectThe data to update the products with.
updateOmit<UpdateProductDTO, "variants"> & objectproductsOmit<UpsertProductDTO, "variants"> & object[]The products to update.
productsOmit<UpsertProductDTO, "variants"> & object[]additional_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#
ProductDTO[]ProductDTO[]
ProductDTO[]ProductDTO[]idstringThe ID of the product.
idstringtitlestringThe title of the product.
titlestringhandlestringThe handle of the product. The handle can be used to create slug URL paths.
handlestringsubtitlenull | stringThe subttle of the product.
subtitlenull | stringdescriptionnull | stringThe description of the product.
descriptionnull | stringis_giftcardbooleanWhether the product is a gift card.
is_giftcardbooleanstatusProductStatusThe status of the product.
statusProductStatusthumbnailnull | stringThe URL of the product's thumbnail.
thumbnailnull | stringwidthnull | numberThe width of the product.
widthnull | numberweightnull | numberThe weight of the product.
weightnull | numberlengthnull | numberThe length of the product.
lengthnull | numberheightnull | numberThe height of the product.
heightnull | numberorigin_countrynull | stringThe origin country of the product.
origin_countrynull | stringhs_codenull | stringThe HS Code of the product.
hs_codenull | stringmid_codenull | stringThe MID Code of the product.
mid_codenull | stringmaterialnull | stringThe material of the product.
materialnull | stringThe associated product collection.
collection_idnull | stringThe associated product collection id.
collection_idnull | stringThe associated product type.
type_idnull | stringThe associated product type id.
type_idnull | stringThe associated product tags.
The associated product variants.
The associated product options.
The associated product images.
external_idnull | stringThe ID of the product in an external system. This is useful if you're integrating the product with a third-party service and want to maintain
a reference to the ID in the integrated service.
external_idnull | stringcreated_atstring | DateWhen the product was created.
created_atstring | Dateupdated_atstring | DateWhen the product was updated.
updated_atstring | Datedeleted_atstring | DateWhen the product was deleted.
deleted_atstring | DateThe associated product categories.
discountablebooleanOptionalWhether the product can be discounted.
discountablebooleanOptionalHolds custom data in key-value pairs.
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.
productsUpdated#
Handlers consuming this hook accept the following input.
invokeInvokeFn<object, TOutput, TCompensateInput>