Rule

What it does

This data model represents a shopping cart price rule (sales rule) in Magento 2, implementing the RuleInterface.

Developers use this class to create, read, update, or delete sales rules programmatically, managing properties like discount amounts, customer groups, conditions, coupon types, and date ranges.

It serves as the data transfer object for sales rule operations through the API or service layer.

Public Methods

• getRuleId()
• setRuleId()
• getName()
• setName()
• getDescription()
• setDescription()
• getFromDate()
• setFromDate()
• getToDate()
• setToDate()
• getUsesPerCustomer()
• setUsesPerCustomer()
• getIsActive()
• setIsActive()
• getCondition()
• setCondition()
• getActionCondition()
• setActionCondition()
• getStopRulesProcessing()
• setStopRulesProcessing()
• getIsAdvanced()
• setIsAdvanced()
• getStoreLabels()
• setStoreLabels()
• getWebsiteIds()
• setWebsiteIds()
• getCustomerGroupIds()
• setCustomerGroupIds()
• 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()