Sales Module
AbstractModel
ModelThis abstract base class provides common functionality for all Sales module entities like orders, invoices, shipmen...
AbstractNotifier
ModelAbstractNotifier is a base class for sending email notifications related to sales entities (orders, invoices, shipm...
Create
ModelThis class manages the entire process of creating orders from the Magento admin panel. It handles quote manipulatio...
EmailSender
ModelThis class handles sending order and invoice confirmation emails when orders are created through the Magento admin...
Config
ModelThis class provides access to sales-related configuration data in Magento 2, specifically for order totals renderin...
Converter
ModelThis class converts Magento 2 sales configuration XML files (like sales.xml) into PHP arrays. Developers typically...
Data
ModelThis class serves as a data container for sales configuration in Magento 2, specifically handling the caching and r...
Ordered
ModelThis abstract class serves as a base for managing ordered collections of sales-related calculation models (like ord...
Reader
ModelThis class loads and reads sales-related configuration from sales.xml files across all Magento modules. Developers...
SchemaLocator
ModelThis class provides the file paths to XSD schema files used for validating Sales module configuration XML files. De...
Order
ModelThe Order Convert model handles the conversion of order objects and their items into related sales documents like i...
AggregateSalesReportBestsellersData
ModelThis class is a cron job handler that automatically refreshes bestseller product statistics in Magento's sales repo...
AggregateSalesReportInvoicedData
ModelThis class is a cron job that automatically aggregates sales invoice data for reporting purposes. It runs periodica...
AggregateSalesReportOrderData
ModelThis class is a cron job that automatically aggregates sales order data for reporting purposes. It runs periodicall...
AggregateSalesReportRefundedData
ModelThis class is a cron job that automatically aggregates and refreshes sales refunded report statistics in Magento 2....
CleanExpiredOrders
ModelThis class automatically cancels pending payment orders that have exceeded their configured lifetime. It runs as a...
CustomerGroupRetriever
ModelThis class retrieves the customer group ID from the admin quote session in Magento 2's backend area. Developers use...
Tax
ModelThis class represents tax information associated with an order in Magento 2. Developers use it to access and manipu...
Download
ModelThe Download class handles secure file downloads for sales-related documents like custom option files attached to o...
EmailSenderHandler
ModelThis class handles asynchronous sending of sales-related emails (orders, invoices, shipments, credit memos) to cust...
EntityStorage
ModelEntityStorage acts as an in-memory registry for storing and retrieving Magento sales entities (like orders, invoice...
ExportViewFilterProcessor
ModelThis class processes and filters columns for exporting Sales order grids based on custom views saved in bookmarks....
GridAsyncInsert
ModelThis class manages asynchronous insertion of sales entities (Orders, Invoices, Shipments, Credit Memos) into their...
CollectionUpdater
ModelThis class updates grid collections for child transactions in the Magento admin panel. It filters the transaction g...
CollectionUpdater
ModelThis class is responsible for updating sales transaction grid collections by filtering them based on the currently...
LastUpdateTimeCache
ModelThis class manages caching of the last update timestamp for Magento 2 sales grid tables (orders, invoices, shipment...
Increment
ModelThis class manages the generation and retrieval of increment IDs for sales orders in Magento 2. Developers would us...
InsertOrderStatusChangeHistory
ModelThis class is responsible for tracking order status changes in Magento 2 by recording them in the status change his...
InvoiceOrder
ModelThis class handles the creation of invoices for Magento 2 orders. Developers use this when they need to programmati...
Order
ModelThe Order model class represents a sales order in Magento 2 and provides comprehensive functionality for managing o...
Address
ModelThis model represents a billing or shipping address associated with a sales order in Magento 2. Developers use this...
Renderer
ModelThis class is responsible for formatting order addresses in Magento 2. Developers use it when they need to display...
AddressRepository
ModelThe AddressRepository class manages order address data in Magento 2, providing methods to create, retrieve, update,...
Validator
ModelThis validator class ensures that sales order addresses contain all required information before they are saved or u...
Item
ModelThis class serves as a wrapper or helper for accessing order item data in the Magento admin area. It provides a con...
Config
ModelThis class manages order status and state configurations in Magento 2. Developers use it to retrieve status labels,...
ValidateCoupon
ModelThis class validates and provides user feedback when applying or removing coupon codes during order creation in the...
Creditmemo
ModelThe Creditmemo model represents a credit memo (refund document) in Magento 2's order management system. Developers...
Comment
ModelThis class represents a comment on a credit memo in Magento 2. Developers use it to create, retrieve, and manage co...
CommentCreation
ModelThis class is a data transfer object (DTO) used when creating comments for credit memos in Magento 2. Developers us...
CommentRepository
ModelThis class manages CRUD operations for credit memo comments in Magento 2. Developers use it to retrieve, save, dele...
Config
ModelThis configuration class manages the order creditmemo (refund) total collectors in Magento 2. It determines the ord...
CreationArguments
ModelThis class serves as a data container for optional arguments when creating a credit memo in Magento 2. Developers u...
CreditmemoValidator
ModelThis class validates credit memos in Magento 2 before they are saved or processed. Developers use it to ensure cred...
Item
ModelThis class represents a single line item within a Magento 2 credit memo (refund). Developers use this model when cr...
ItemCreation
ModelThis class is a data transfer object (DTO) used when creating credit memo items through the Magento 2 API. Develope...
ItemCreationValidator
ModelThis class validates credit memo items during the credit memo creation process in Magento 2. Developers use it to e...
ItemRepository
ModelThis repository class provides CRUD (Create, Read, Update, Delete) operations for credit memo items in Magento 2. D...
Notifier
ModelThis class handles sending notifications when a credit memo is created in Magento 2. Developers use this class to t...
CreditmemoNotifier
ModelThe CreditmemoNotifier class is responsible for sending credit memo email notifications to customers when a refund...
RefundOperation
ModelThis class handles the complete refund operation for credit memos in Magento 2. Developers use it when processing r...
CreditmemoRepository
ModelThis repository class provides CRUD (Create, Read, Update, Delete) operations for Credit Memo entities in Magento 2...
CreditmemoValidator
ModelThis validator class determines whether order items can be refunded when creating a credit memo in Magento 2. Devel...
CustomerAssignment
ModelThis class handles the assignment of a registered customer to an existing order, typically converting a guest order...
CustomerManagement
ModelThis class manages the conversion of guest checkout orders into customer accounts in Magento 2. Developers use this...
NotifySender
ModelThis abstract class serves as a base for sending notification emails related to sales orders in Magento 2. Develope...
Sender
ModelThis abstract class serves as the base for sending order-related emails in Magento 2, such as order confirmations,...
SenderBuilder
ModelSenderBuilder is responsible for constructing and sending transactional email messages for sales orders in Magento...
OrderIncrementIdChecker
ModelThis class checks whether a specific order increment ID has already been used in the system. Developers use this ut...
Invoice
ModelThe Invoice model represents a sales invoice document in Magento 2. Developers use this class to create, manage, an...
Comment
ModelThis class represents a comment attached to an invoice in Magento 2. Developers use it to add, retrieve, and manage...
CommentCreation
ModelThis class is a data transfer object (DTO) used when creating comments for invoices in Magento 2. Developers use th...
CommentRepository
ModelThis repository class manages CRUD operations for invoice comments in Magento 2. Developers use it to retrieve, sav...
Config
ModelThis class manages the configuration for invoice total collectors in Magento 2. It extends the base total configura...
CreationArguments
ModelThis class serves as a data container for additional arguments used during invoice creation in Magento 2. Developer...
GetLogoFile
ModelThis class retrieves the custom logo file URL configured for invoice HTML printing in Magento 2. Developers would u...
InvoiceValidator
ModelThis class validates invoice entities in Magento 2 by running a set of validators against an invoice object. Develo...
Item
ModelThis class represents a single item line in a Magento 2 invoice. Developers use it when creating invoices, capturin...
ItemCreation
ModelThis class serves as a data transfer object (DTO) for creating invoice items in Magento 2. Developers use it when p...
ItemRepository
ModelThis repository class provides CRUD operations for managing individual invoice item records in Magento 2. Developer...
Notifier
ModelThis class is responsible for sending invoice notifications in Magento 2. Developers use this class when they need...
InvoiceNotifier
ModelInvoiceNotifier is responsible for sending invoice notification emails to customers when an invoice is created or u...
PayOperation
ModelThis class handles the payment processing logic when an invoice is registered for an order in Magento 2. Developers...
InvoiceQuantityValidator
ModelThis validator ensures that invoice quantities are valid before an invoice is created in Magento 2. It checks that...
InvoiceRepository
ModelThe InvoiceRepository class provides a centralized way to manage invoice operations in Magento 2, including creatin...
Item
ModelThe Order Item class represents individual products within a Magento 2 order. Developers use this class to access a...
ItemRepository
ModelThe ItemRepository class manages CRUD operations for order items in Magento 2. Developers use this class to retriev...
OrderMutex
ModelThis class prevents race conditions when multiple requests try to update the same order simultaneously. It uses dat...
OrderNotifier
ModelThis class handles sending order confirmation emails to customers in Magento 2. Developers use this class when they...
OrderCustomerDelegate
ModelThis class handles the delegation of guest orders to customer accounts during the customer registration process. Wh...
OrderCustomerExtractor
ModelThis class extracts customer data from a sales order, either retrieving an existing customer from the database or b...
OrderValidator
ModelThis class validates Order entities in Magento 2 by running specified validation rules against an order object. Dev...
Payment
ModelThe Order Payment class manages all payment-related operations for Magento orders including authorization, capture,...
PaymentAdapter
ModelThis adapter class simplifies the payment processing workflow for orders and invoices in Magento 2. Developers use...
Info
ModelThis class manages payment information for orders in Magento 2, including storing and retrieving payment method det...
Processor
ModelThe Payment Processor class acts as a central coordinator for processing payment operations in Magento 2 orders. De...
Payment\Repository
ModelThe Order Payment Repository provides a centralized way to retrieve, save, delete, and search for order payment rec...
Transaction
ModelThis class manages payment transaction records in Magento 2, tracking the hierarchy and relationships between diffe...
AbstractPdf
ModelThis abstract class serves as the base for generating PDF documents for Magento 2 sales documents like invoices, sh...
Config
ModelThis configuration class provides PDF rendering settings for Magento 2 sales documents like invoices, shipments, an...
Creditmemo
ModelThis class generates PDF documents for credit memos in Magento 2. Developers use this class when they need to creat...
Invoice
ModelThis class generates PDF documents for sales order invoices in Magento 2. Developers use this class when they need...
Shipment
ModelThis class generates PDF documents for order shipments in Magento 2. Developers use it when they need to create or...
ProductOption
ModelThis class manages product options for order items in Magento 2. It processes and adds product-specific configurati...
RefundAdapter
ModelThe RefundAdapter class serves as a facade for processing refunds in Magento 2. Developers use this class when they...
OrderedProductAvailabilityChecker
ModelThis class checks if products from a previous order can be reordered based on their product type. Developers use it...
UnavailableProductsProvider
ModelThis class identifies products from an order that are no longer available for reorder. Developers use this when imp...
OrderRepository
ModelOrderRepository is the main class for managing order data in Magento 2. Developers use it to retrieve, save, delete...
Shipment
ModelThe Shipment model represents a physical shipment of products from an order in Magento 2. Developers use this class...
Comment
ModelThis class represents a comment attached to a shipment in Magento 2. Developers use it to add, retrieve, and manage...
CommentCreation
ModelThis class serves as a data transfer object (DTO) for creating comments on shipments in Magento 2. Developers use t...
CommentRepository
ModelThis repository class manages CRUD operations for shipment comments in Magento 2. Developers use it to retrieve, sa...
CreationArguments
ModelThis class serves as a data container for passing additional arguments when creating a shipment in Magento 2. Devel...
ExtensionAttributesProcessor
ModelThis class processes and merges extension attributes for shipment documents in Magento 2. It combines extension att...
Item
ModelThis class represents an individual item within a shipment in Magento 2. Developers use it when creating or managin...
ItemCreation
ModelThis class is a data transfer object (DTO) used when creating shipment items in Magento 2. Developers use this clas...
ItemRepository
ModelThis repository class manages CRUD operations for shipment items in Magento 2. Developers use this class to retriev...
Notifier
ModelThis class handles sending shipment notifications to customers when an order is shipped. Developers use this class...
OrderRegistrar
ModelThis class handles the registration of shipment items with their parent order during the shipment creation process....
Package
ModelThis class represents a package within a shipment in Magento 2's order fulfillment system. Developers use this mode...
PackageCreation
ModelThis class represents a data model for creating shipment packages in Magento 2. Developers use this class when prog...
ShipmentRepository
ModelThe ShipmentRepository class provides a centralized way to manage order shipments in Magento 2. Developers use this...
ShipmentItemsValidator
ModelThis class validates shipment items before creating a shipment in Magento 2. Developers use this class to ensure th...
ShipmentValidator
ModelThis class validates Magento 2 shipment entities before they are saved or processed. Developers use this validator...
Track
ModelThis class represents a shipment tracking record in Magento 2, storing information like tracking numbers, carrier c...
TrackCreation
ModelThis class is a data transfer object (DTO) used to create tracking information for shipments in Magento 2. Develope...
TrackRepository
ModelThis repository class manages shipment tracking information in Magento 2. Developers use it to create, retrieve, up...
Shipping
ModelThis class represents shipping information for a sales order in Magento 2. Developers use it to access and manage o...
ShippingAssignment
ModelShippingAssignment is a data model that groups together shipping information, order items, and inventory stock ID f...
ShippingAssignmentBuilder
ModelThis builder class creates ShippingAssignment objects for Magento 2 orders, which bundle together shipping informat...
ShippingBuilder
ModelThe ShippingBuilder class is responsible for creating a ShippingInterface object that contains all shipping-related...
ShippingTotal
ModelThis class represents shipping-related totals for a Magento 2 order, providing getters and setters for all shipping...
StateResolver
ModelThe StateResolver class determines the appropriate state for an order based on its current conditions and propertie...
Status
ModelThis class manages order statuses in Magento 2, allowing developers to create, assign, and manipulate status labels...
History
ModelThis class manages order status history records, which track changes to an order's status along with comments and t...
HistoryRepository
ModelThis repository class manages CRUD operations for order status history records in Magento 2. Developers use this cl...
StatusLabel
ModelThis class retrieves and manages order status labels for display in different areas of Magento 2 (frontend, admin,...
StatusResolver
ModelThis class determines the appropriate status for an order based on its state and payment method configuration. Deve...
Tax
ModelThis model class represents tax information applied to a Magento 2 order. Developers use it to retrieve and manage...
Item
ModelThis class represents tax details for individual items in a Magento 2 order, storing information about which taxes...
Total
ModelThis class represents order totals data in Magento 2's sales module. It serves as a data container for storing and...
AbstractTotal
ModelThis is a base class for implementing order total calculation models in Magento 2. Developers extend this class whe...
CanInvoice
ModelThis validator class determines whether an order can have an invoice created for it. Developers use this class to c...
CanRefund
ModelThis validator class determines whether a Magento 2 order is eligible for a credit memo (refund). Developers use th...
CanShip
ModelThis validator class determines whether a shipment can be created for a given order in Magento 2. Developers use th...
InvoiceOrder
ModelThis class validates whether an order can be invoiced and whether the invoice being created is valid. Developers us...
RefundInvoice
ModelThis class validates whether a refund (credit memo) can be created against an invoice in Magento 2. Developers use...
RefundOrder
ModelThis class validates whether a refund (credit memo) can be created for an order in Magento 2. It performs comprehen...
ShipOrder
ModelThis class validates whether an order can be shipped in Magento 2. Developers use this validator before creating sh...
ChangeOutputArray
ModelThis class modifies the output array of order item data for Web API responses by recalculating row totals with and...
RefundInvoice
ModelThis class handles the process of refunding an invoice in Magento 2. Developers would use this class (or its interf...
RefundOrder
ModelThis class handles the complete refund process for Magento 2 orders. Developers use it to programmatically create c...
Error
ModelThis is a Data Transfer Object (DTO) that represents an error during the reorder process in Magento 2. Developers u...
ReorderOutput
ModelThis class is a Data Transfer Object (DTO) that represents the result of a reorder operation in Magento 2. Develope...
OrderInfoBuyRequestGetter
ModelThis class retrieves and processes product configuration data (buy request) from order items when customers reorder...
Reorder
ModelThis class handles the reorder functionality in Magento 2, allowing customers to quickly re-add products from a pre...
AbstractGrid
ModelAbstractGrid serves as a base class for managing grid tables in the Magento Sales module, providing common function...
Attribute
ModelThis class provides functionality to save individual attributes of sales entities (orders, invoices, shipments, etc...
EntityAbstract
ModelEntityAbstract serves as the base resource model for all Magento 2 sales entities (orders, invoices, shipments, cre...
Grid
ModelThis class manages the synchronization of sales order data between the main order table and grid tables used for ad...
GridPool
ModelThis class manages and refreshes multiple sales grid tables (like order, invoice, shipment grids) when an order is...
ResourceModel\Helper
ModelThis helper class provides database-related utility functions for Magento 2 Sales module operations. Developers use...
Metadata
ModelThis class serves as a metadata provider for Sales entities, managing the relationship between model classes and th...
Order
ModelThis resource model handles database operations for Magento 2 orders, including saving order data and managing orde...
Address
ModelThis class manages database operations for order addresses in Magento 2. Developers use it to save, load, validate,...
Creditmemo
ModelThis class handles database operations for credit memo entities in Magento 2. Developers interact with it indirectl...
Invoice
ModelThis resource model manages database operations for order invoices in Magento 2. Developers use this class when the...
Item
ModelThis resource model handles database operations for order items in Magento 2. Developers use this class when they n...
Payment
ModelThis resource model handles database operations for order payment data in Magento 2. Developers use this class indi...
Relation
ModelThis class manages the saving of all related entities when an order is saved in Magento 2. It ensures that order it...
Shipment
ModelThis resource model handles database operations for order shipments in Magento 2. Developers use this class when th...
Status
ModelThis resource model manages order status data in the database, including CRUD operations, status-to-state assignmen...
Tax
ModelThis resource model handles database operations for order tax records in Magento 2. Developers use this class when...
NotSyncedDataProvider
ModelThis class provides a composite pattern implementation to retrieve IDs of records that are not synchronized between...
UpdatedAtListProvider
ModelThis class identifies sales entities (orders, invoices, shipments, etc.) that need to be synchronized between main...
UpdatedIdListProvider
ModelThis class retrieves a list of entity IDs from sales tables that have been updated in the main table but not yet sy...
Report
ModelThis is a base resource model for sales reports in Magento 2. It provides a flexible way to dynamically initialize...
AbstractReport
ModelThis abstract class serves as a base for all sales report resource models in Magento 2. Developers extend this clas...
Bestsellers
ModelThis class manages the aggregation and generation of bestseller product reports in Magento 2. Developers would use...
Invoiced
ModelThis resource model aggregates invoice-related sales data for reporting purposes in Magento 2. Developers use this...
Order
ModelThis resource model aggregates sales order data for reporting purposes in Magento 2. It generates statistical summa...
Refunded
ModelThis class manages the aggregation and reporting of refunded order data in Magento 2. Developers use this class whe...
Shipping
ModelThis class aggregates shipping data from sales orders and invoices into reporting tables for analysis and display i...
SalesOrderStatusChangeHistory
ModelThis resource model manages the sales order status change history by tracking when order statuses change over time....
NewOrder
ModelThis class provides RSS feed functionality for new orders in Magento 2's admin panel. It generates an RSS feed cont...
OrderStatus
ModelThis class provides RSS feed functionality for order status updates in Magento 2. Developers use it to generate RSS...
Signature
ModelThis class provides signature generation and validation functionality for RSS feeds in Magento 2's Sales module. De...
RtlTextHandler
ModelThis class handles Right-to-Left (RTL) text processing for Arabic and Hebrew languages in Magento's Sales module. D...
CreditmemoService
ModelThe CreditmemoService class manages credit memo operations in Magento 2, including processing refunds, retrieving c...
InvoiceService
ModelThis service class handles invoice operations in Magento 2, including creating invoices from orders, capturing paym...
OrderService
ModelOrderService is the main service class for managing order operations in Magento 2. Developers use this class to per...
PaymentFailuresService
ModelThis service handles failed payment transactions in Magento 2 by sending notification emails to store administrator...
ShipmentService
ModelThis service class provides centralized operations for managing shipments in Magento 2. Developers use this class t...
ShipOrder
ModelThis class handles the creation and processing of shipments for orders in Magento 2. Developers would use this serv...
ListStatus
ModelThis class manages a collection of status information items for sales entities in Magento 2. Developers use it to t...
Validator
ModelThis class serves as a centralized validation orchestrator for sales entities in Magento 2. It accepts an entity (l...
ValidatorResult
ModelThis class stores and manages validation result messages in Magento 2 Sales operations. Developers use it to collec...
ValidatorResultMerger
ModelThis class merges multiple validator results into a single unified result object in Magento 2's Sales module. Devel...