SalesRule Module
Api\CouponManagementInterface
This interface defines the contract for managing coupon codes in Magento 2 shopping cart price rules. Developers use this to programmatically generate...
Api\CouponRepositoryInterface
This interface defines the contract for managing shopping cart price rule coupons in Magento 2. Developers use this repository to create, retrieve, up...
Api\Data\ConditionInterface
This interface defines the structure for sales rule conditions in Magento 2's promotion system. Developers use it to create, read, and manipulate comp...
Api\Data\CouponGenerationSpecInterface
This interface defines the contract for specifying parameters when generating coupon codes in bulk for sales rules. Developers use this to programmati...
Api\Data\CouponInterface
This interface defines the contract for coupon data objects in Magento 2's sales rule system. Developers use this to work with coupon codes, including...
Api\Data\CouponMassDeleteResultInterface
This interface defines the structure for results returned from mass coupon deletion operations in Magento 2. Developers use this to handle and report...
Api\Data\CouponSearchResultInterface
This interface defines the contract for search results when querying for sales rule coupons in Magento 2. Developers use this when working with the Co...
Api\Data\DiscountAppliedToInterface
This interface defines the contract for identifying where a sales rule discount has been applied in Magento 2. Developers use this to determine if a d...
Api\Data\DiscountDataInterface
This interface defines the contract for retrieving discount data in Magento 2 sales rules. Developers use it to access discount amounts in both store...
Api\Data\RuleDiscountInterface
This interface defines the contract for rule discount data objects in Magento 2's sales rule system. Developers use this to retrieve discount informat...
Api\Data\RuleInterface
This interface defines the contract for sales promotion rules (cart price rules) in Magento 2. Developers use it when programmatically creating, readi...
Api\Data\RuleLabelInterface
This interface defines the contract for managing store-specific labels for sales rules (cart price rules) in Magento 2. Developers use this to get or...
Api\Data\RuleSearchResultInterface
This interface defines the contract for search results when querying sales rules (cart price rules/promotions). Developers use this when implementing...
Api\Exception\CodeRequestLimitException
This exception is thrown when a customer or system reaches the limit for requesting or generating coupon codes within a given timeframe. Developers sh...
Api\RuleRepositoryInterface
This interface defines the contract for managing sales rules (promotional/discount rules) in Magento 2. Developers use this repository to create, read...
CartFixedDiscount
This helper class handles discount calculations for cart-level fixed amount discount rules in Magento 2. Developers use it to calculate proportional d...
Converter\ToDataModel
This converter class transforms Magento SalesRule model objects (database entities) into their corresponding Data Transfer Objects (DTOs) that are use...
Converter\ToModel
This converter class transforms SalesRule data models (API/interface representations) into Rule model objects used internally by Magento. Developers u...
Coupon
This class manages coupon codes for Magento 2 sales rules (cart price rules). Developers use it to create, load, and manipulate coupon data including...
Coupon
This helper class manages coupon code generation and configuration in Magento 2. Developers use it to retrieve default settings for auto-generated cou...
CouponGenerator
This class generates pools of coupon codes for sales promotions and shopping cart price rules. Developers use it to programmatically create multiple c...
CouponRepository
This repository class provides CRUD operations for managing shopping cart price rule coupons in Magento 2. Developers use it to create, retrieve, upda...
CouponSearchResult
This class represents the search results container for coupon entities in Magento 2's sales rule system. Developers use this when working with the Cou...
CouponUsageConsumer
This consumer class processes asynchronous coupon usage updates in Magento 2's message queue system. Developers use this when implementing or troubles...
Coupon\AdminCodeLimitManager
This class implements code limit management for coupon code validation in the Magento admin area. Unlike frontend implementations, it intentionally pe...
Coupon\CaptchaConfigProvider
This class provides CAPTCHA configuration data specifically for coupon code requests in the checkout process. It determines whether CAPTCHA should be...
Coupon\CodeLimitManager
This class manages rate limiting for coupon code validation requests by integrating with Magento's CAPTCHA system. Developers use this to prevent auto...
Coupon\Codegenerator
This class generates random coupon codes for sales rules/promotions in Magento 2. Developers use this when creating coupon code generation functionali...
Coupon\Consumer
This class acts as a message queue consumer that processes asynchronous coupon generation requests in Magento 2. When a merchant generates a large bat...
Coupon\Massgenerator
This class generates multiple unique coupon codes in bulk for sales rules/promotions in Magento 2. Developers use it when creating cart price rules th...
Coupon\Quote\UpdateCouponUsages
This class manages the increment or decrement of coupon usage counts when a quote (shopping cart) is processed. Developers use this to track how many...
Coupon\UpdateCouponUsages
This class manages the tracking and updating of coupon usage statistics when orders are placed or canceled. Developers use this class to increment or...
Coupon\Usage\Processor
This class manages coupon and sales rule usage tracking in Magento 2. Developers use it to increment or decrement usage counters when coupons are appl...
Coupon\Usage\UpdateInfo
This class serves as a data transfer object (DTO) to carry information about coupon usage updates in Magento 2's sales rule system. Developers use thi...
Data\Condition
This class represents a single condition or rule criteria in Magento 2's sales rule/promotion system. Developers use it to programmatically define con...
Data\CouponGenerationSpec
This data model class defines the specifications for generating coupon codes in Magento 2's Sales Rule system. Developers use this class when programm...
Data\CouponMassDeleteResult
This class represents the result of a bulk coupon deletion operation in Magento 2. Developers use it to track which coupon codes failed to delete and...
Data\DiscountData
This class represents discount data for sales rules in Magento 2. Developers use it to store and retrieve discount amounts in both store and base curr...
Data\Rule
This data model represents a shopping cart price rule (sales rule) in Magento 2, implementing the RuleInterface. Developers use this class to create,...
Data\RuleDiscount
This class is a data model that represents discount information applied by a sales rule (shopping cart price rule) to an item or quote. Developers use...
Data\RuleLabel
This data model represents a store-specific label for a sales rule (shopping cart price rule). Developers use this class when managing multi-store car...
DeltaPriceRound
This class handles precise price rounding for sales rules by tracking rounding deltas across multiple operations. It prevents cumulative rounding erro...
GetCoupons
This class efficiently retrieves multiple coupon objects by their codes in a single operation, with built-in caching to avoid redundant database queri...
Model\Coupon\CodegeneratorInterface
This interface defines the contract for generating coupon codes in Magento 2's sales rule system. Developers implement this interface to create custom...
Model\Quote\GetCouponCodeLengthInterface
This interface defines a contract for retrieving the length of a coupon code in Magento's sales rule system. Developers would implement this interface...
Model\ResourceModel\Coupon\Collection
This collection class manages and retrieves coupon codes for sales rules in Magento 2. Developers use it to fetch, filter, and manipulate sets of coup...
Model\ResourceModel\Report\Collection
This collection class retrieves and aggregates sales rule (coupon) usage data for reporting purposes. Developers use it to generate reports showing co...
Model\ResourceModel\Rule\Collection
This collection class manages and retrieves sales price rules (cart price rules/promotions) in Magento 2. Developers use it to load, filter, and valid...
Model\Rule\Action\Collection
This class manages the collection of actions that can be applied when a sales rule is triggered in Magento's promotions system. Developers use this to...
Model\Spi\CodeLimitManagerInterface
This interface defines a contract for checking if coupon code requests have exceeded rate limits. Developers implement this interface to create servic...
Model\Spi\CouponResourceInterface
This interface defines the contract for managing coupon resource operations in Magento 2's sales rule system. Developers use implementations of this i...
Model\Spi\QuoteResetAppliedRulesInterface
This interface defines a contract for resetting applied sales rules (cart price rules/promotions) on a quote/shopping cart. Developers would implement...
Model\Spi\RuleQuoteRecollectTotalsInterface
This interface defines a contract for recollecting quote totals when a sales rule (promotional rule/coupon) is modified. Developers implement this int...
Queue\Consumer\RuleQuoteRecollectTotals
This class processes asynchronous queue messages to recalculate shopping cart totals when a sales rule (promotion/coupon) is modified. Developers use...
Quote\ChildrenValidationLocator
This class determines whether sales rule validation should be applied to child items of a quote item based on the product type. Developers use this wh...
Quote\Discount
This class calculates and applies shopping cart price rule discounts during quote totals collection in Magento 2. Developers interact with it when cus...
Quote\GetCouponCodeLength
This class calculates the required length for auto-generated coupon codes in Magento 2. Developers use it when programmatically creating coupon codes...
Quote\GetCouponCodes
This class retrieves coupon codes applied to a shopping cart quote. Developers use it to get an array of active coupon codes for a given quote, which...
RegistryConstants
This class defines constant keys used to store and retrieve sales rule (promotion/coupon) data from Magento's registry. Developers use these constants...
ResourceModel\Coupon
This resource model manages database operations for sales rule coupons in Magento 2. Developers use it to save, load, and validate coupon codes, check...
ResourceModel\Coupon\Usage
This resource model manages the tracking of how many times individual customers have used specific coupons in Magento 2. Developers use this class to...
ResourceModel\ReadHandler
This class handles reading and loading additional sales rule data from the database when a sales rule entity is retrieved. It enriches the rule entity...
ResourceModel\Report\Rule
This resource model aggregates and reports on sales rule (coupon) usage data in Magento 2. Developers use it to generate reporting statistics by creat...
ResourceModel\Rule
This resource model manages database operations for Sales Rules (cart price rules) in Magento 2. Developers use this class when creating, reading, upd...
ResourceModel\Rule\Customer
This resource model manages the database operations for tracking how many times a customer has used a specific sales rule (coupon or promotion). Devel...
ResourceModel\Rule\DateApplier
This class applies date range filters to database queries for sales rules. Developers use it to ensure only active sales rules (within their from_date...
ResourceModel\SaveHandler
This class handles saving sales rule entity relationships during the persistence process. It binds sales rules to their associated websites and custom...
Rss\Discounts
This class retrieves a collection of active sales rules (discounts/promotions) that are configured to be published via RSS feeds. Developers use this...
Rule
This class represents a Shopping Cart Price Rule (Sales Rule) in Magento 2, managing promotional discounts applied to shopping carts. Developers use t...
RuleRepository
This repository class manages CRUD (Create, Read, Update, Delete) operations for shopping cart price rules (sales rules) in Magento 2. Developers use...
RuleSearchResult
This class represents search results for sales rules (shopping cart price rules) in Magento 2. Developers use this when retrieving multiple sales rule...
Rule\Action\Product
This class defines the product price adjustment actions available in cart price rules (sales rules). Developers use this class when implementing or ex...
Rule\Action\SimpleActionOptionsProvider
This class provides a list of available discount action types for Magento 2 shopping cart price rules. Developers use this when building admin forms o...
Rule\Condition\Address
This class defines address-based conditions for shopping cart price rules in Magento 2. Developers use it to create rules that trigger based on shippi...
Rule\Condition\Combine
This class defines and manages the combination of conditions that can be used in Magento shopping cart price rules. Developers use this to specify wha...
Rule\Condition\Product
This class defines product-related conditions for shopping cart price rules (SalesRule) in Magento 2. Developers use this to create rule conditions th...
Rule\Customer
This model represents the relationship between a sales rule (coupon/discount) and a customer, tracking how many times a customer has used a specific r...
Rule\DataProvider
This DataProvider class supplies sales rule data to the Admin UI form for creating and editing cart price rules (promotions). Developers use this clas...
Rule\Metadata\ValueProvider
This class provides metadata and configuration values for the sales rule (cart price rule) edit form in Magento's admin panel. Developers use this whe...
Rule\QuoteResetAppliedRules
This class resets all applied sales rules (cart price rules) from a quote/cart by clearing the cart fixed rules array. Developers would use this when...
Rule\RuleQuoteRecollectTotalsAsync
This class handles asynchronous recalculation of shopping cart totals when sales rules (cart price rules) are modified. When a sales rule changes, thi...
Rule\RuleQuoteRecollectTotalsOnDemand
This class marks active quotes for total recalculation when a sales rule (coupon/discount rule) is modified. When a sales rule changes, this ensures a...
RulesApplier
This class applies sales/cart price rules (discount rules) to quote items during checkout. Developers use this to calculate and distribute discounts a...
SelectRuleCoupon
This class selects and validates which coupon code from a list of applied coupons actually belongs to a specific sales rule. Developers use this when...
Service\CouponManagementService
This service class manages coupon operations for sales rules in Magento 2. Developers use it to programmatically generate multiple coupons for a promo...
Service\CouponUsagePublisher
This class publishes coupon usage updates to an asynchronous message queue for processing. Developers would use this when they need to update coupon u...
Utility
This utility class provides helper methods for processing sales rules (promotional discounts) in Magento 2. Developers use it to validate if a rule ca...
ValidateCoupon
This class validates coupon codes for shopping cart price rules in Magento 2. Developers use it to verify if a coupon is valid by checking its existen...
ValidateCouponCode
This class validates coupon codes to determine if they can be applied to an order. Developers use this when they need to verify multiple coupon codes,...
Validator
This class validates and applies shopping cart price rules (sales rules) to quotes in Magento 2. Developers use it to calculate discounts on cart item...
Validator\Pool
This class serves as a registry for custom validators that need to run before sales rules are applied to cart items. Developers use this class to retr...