Log in
Interface

RuleInterface

Magento\SalesRule\Api\Data\RuleInterface

What it does

This interface defines the contract for sales promotion rules (cart price rules) in Magento 2.

Developers use it when programmatically creating, reading, or modifying promotional rules that offer discounts, free shipping, or coupon-based incentives.

It provides getter/setter methods for all rule properties including conditions, discount types, customer groups, date ranges, and coupon configurations.

Public Methods

  • getRuleId()
  • setRuleId()
  • getName()
  • setName()
  • getStoreLabels()
  • setStoreLabels()
  • getDescription()
  • setDescription()
  • getWebsiteIds()
  • setWebsiteIds()
  • getCustomerGroupIds()
  • setCustomerGroupIds()
  • getFromDate()
  • setFromDate()
  • getToDate()
  • setToDate()
  • getUsesPerCustomer()
  • setUsesPerCustomer()
  • getIsActive()
  • setIsActive()
  • getCondition()
  • setCondition()
  • getActionCondition()
  • setActionCondition()
  • getStopRulesProcessing()
  • setStopRulesProcessing()
  • getIsAdvanced()
  • setIsAdvanced()
  • getProductIds()
  • setProductIds()
  • getSortOrder()
  • setSortOrder()
  • getSimpleAction()
  • setSimpleAction()
  • getDiscountAmount()
  • setDiscountAmount()
  • getDiscountQty()
  • setDiscountQty()
  • getDiscountStep()
  • setDiscountStep()
  • getApplyToShipping()
  • setApplyToShipping()
  • getTimesUsed()
  • setTimesUsed()
  • getIsRss()
  • setIsRss()
  • getCouponType()
  • setCouponType()
  • getUseAutoGeneration()
  • setUseAutoGeneration()
  • getUsesPerCoupon()
  • setUsesPerCoupon()
  • getSimpleFreeShipping()
  • setSimpleFreeShipping()
  • getExtensionAttributes()
  • setExtensionAttributes()