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

batchPromotionRulesWorkflow - Medusa Core Workflows Reference

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

This workflow manages a promotion's rules. It's used by the Manage Promotion Rules Admin API Route, Manage Promotion Buy Rules Admin API Route, and Manage Promotion Target Rules Admin API Route.

You can use this workflow within your own customizations or custom workflows, allowing you to manage promotion rules within your custom flows.

Source Code

Examples#

Steps#

createPromotionRulesWorkflow

updatePromotionRulesWorkflow

Workflow Hook

Step conditioned by when

Input#

BatchPromotionRulesWorkflowInputBatchPromotionRulesWorkflowInput
The data to manage a promotion's rules.
idstring
The ID of the promotion to manage the rules of.
rule_typeRuleType
The type of rule to manage.
createCreatePromotionRuleDTO[]Optional
The rules to create.
updateUpdatePromotionRuleDTO[]Optional
The rules to update.
deletestring[]Optional
The IDs of the rules to delete.

Output#

BatchPromotionRulesWorkflowOutputBatchPromotionRulesWorkflowOutput
The result of managing the promotion's rules.
createdPromotionRuleDTO[]
The created rules.
updatedPromotionRuleDTO[]
The updated rules.
deletedstring[]
The deleted rule IDs.
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
⇧↵