Menu
  • Get Started
  • Product
  • Resources
  • Tools & SDKs
  • Framework
  • Reference

updatePriceListsWorkflow - Medusa Core Workflows Reference

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

This workflow updates one or more price lists. It's used by the Update Price List Admin API Route.

You can use this workflow within your customizations or your own custom workflows, allowing you to update price lists in your custom flows.

Source Code

Examples#

Steps#

validatePriceListsStep

updatePriceListsStep

Workflow Hook

Step conditioned by when

Input#

price_lists_dataUpdatePriceListWorkflowInputDTO[]
idstring
The ID of the price list to update.
titlestringOptional
The title of the price list.
descriptionnull | stringOptional
The description of the price list.
starts_atnull | stringOptional
The start date of the price list.
ends_atnull | stringOptional
The end date of the price list.
statusPriceListStatusOptional
The status of the price list.
rulesRecord<string, string[]>Optional
The rules associated with the price list.
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
⇧↵