addRulesToPromotionsStep - Medusa Core Workflows Reference

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

This step adds rules to a promotion.

Example#

Code
1const data = addRulesToPromotionsStep({2  // import { RuleType } from "@medusajs/framework/utils"3  rule_type: RuleType.RULES,4  data: {5    id: "promo_123",6    rules: [7      {8        attribute: "customer_group",9        operator: "eq",10        values: "custgrp_123"11      }12    ]13  }14})

Input#

AddPromotionRulesWorkflowDTOAddPromotionRulesWorkflowDTO

The data to create rules for a promotion.

rule_typePromotionRuleTypes

The type of rules to create.

dataobject

The data to create the rules.

Output#

PromotionRuleDTO[]PromotionRuleDTO[]

idstring

The ID of the promotion rule.

valuesPromotionRuleValueDTO[]

The values of the promotion rule.

descriptionnull | stringOptional

The description of the promotion rule.

attributestringOptional

The attribute of the promotion rule.

operatorPromotionRuleOperatorValuesOptional

The operator of the promotion rule.

Was this page helpful?