createPromotionRulesWorkflow - Medusa Core Workflows Reference
This documentation provides a reference to the createPromotionRulesWorkflow. It belongs to the @medusajs/medusa/core-flows package.
This workflow creates one or more promotion rules. It's used by other workflows, such as batchPromotionRulesWorkflow that manages the rules of a promotion.
You can use this workflow within your own customizations or custom workflows, allowing you to create promotion rules within your custom flows.
Source CodeExamples#
Steps#
Workflow hook
Step conditioned by when
View step details
Input#
AddPromotionRulesWorkflowDTOAddPromotionRulesWorkflowDTOThe data to create rules for a promotion.
AddPromotionRulesWorkflowDTOAddPromotionRulesWorkflowDTOrule_typePromotionRuleTypesThe type of rules to create.
rule_typePromotionRuleTypesdataobjectThe data to create the rules.
dataobjectOutput#
PromotionRuleDTO[]PromotionRuleDTO[]
PromotionRuleDTO[]PromotionRuleDTO[]idstringThe ID of the promotion rule.
idstringvaluesPromotionRuleValueDTO[]The values of the promotion rule.
valuesPromotionRuleValueDTO[]descriptionnull | stringOptionalThe description of the promotion rule.
descriptionnull | stringOptionalattributestringOptionalThe attribute of the promotion rule.
attributestringOptionalThe operator of the promotion rule.
Was this page helpful?