Sales Module
AbstractCollection
This abstract base class provides a foundation for sales-related database collections in Magento 2 (orders, invoices, shipments, etc.). It bridges EAV...
AbstractModel
This is an abstract base class for Sales module entities (orders, invoices, shipments, credit memos) that provides common functionality for handling d...
AbstractNotifier
This abstract class provides a base implementation for sending email notifications related to sales entities (orders, invoices, shipments, credit memo...
Admin
This helper class provides utility methods for displaying and formatting sales-related data in Magento 2's admin panel. Developers use it to display p...
AdminOrder\Create
The AdminOrder\Create model manages the creation of orders in the Magento admin panel. Developers use this class when building custom admin order crea...
AdminOrder\EmailSender
This class handles sending order confirmation and invoice emails when orders are created through the Magento admin panel. Developers use this when pro...
Api\CreditmemoCommentRepositoryInterface
This interface defines the contract for managing credit memo comments in Magento 2. Developers use this repository to retrieve, save, delete, or searc...
Api\CreditmemoItemRepositoryInterface
This repository interface manages CRUD operations for individual credit memo items in Magento 2. Developers use it to retrieve, save, delete, or searc...
Api\CreditmemoManagementInterface
This interface defines the contract for managing credit memos (refunds) in Magento 2. Developers use this service to perform operations like canceling...
Api\CreditmemoRepositoryInterface
This repository interface manages CRUD operations for credit memos in Magento 2. Developers use it to retrieve, create, save, or delete credit memos (...
Api\Data\CommentInterface
This interface defines the contract for comment data objects in the Magento Sales module. Developers use this interface when working with comments on...
Api\Data\CreditmemoCommentCreationInterface
This interface defines the contract for creating comments on credit memos in Magento 2. Developers use this when programmatically adding comments to c...
Api\Data\CreditmemoCommentInterface
This interface defines the contract for credit memo comment objects in Magento 2. Developers use it to work with comments attached to credit memos, in...
Api\Data\CreditmemoCommentSearchResultInterface
This interface defines the contract for search results when querying credit memo comments in Magento 2. Developers use this when working with reposito...
Api\Data\CreditmemoCreationArgumentsInterface
This interface defines the contract for managing additional arguments when creating a credit memo in Magento 2. Developers use it to specify shipping...
Api\Data\CreditmemoInterface
This interface defines the data structure for credit memos in Magento 2. Developers use it to retrieve and manipulate credit memo information when pro...
Api\Data\CreditmemoItemCreationInterface
This interface defines the contract for creating individual credit memo items when issuing refunds in Magento 2. Developers use this interface when pr...
Api\Data\CreditmemoItemInterface
This interface defines the contract for credit memo item data objects in Magento 2. Developers use this when working with refunds to access or modify...
Api\Data\CreditmemoItemSearchResultInterface
This interface defines the contract for search results when querying credit memo items through Magento's API. Developers use this when retrieving coll...
Api\Data\CreditmemoSearchResultInterface
This interface defines the contract for credit memo search result collections returned by repository search operations. Developers use this when retri...
Api\Data\EntityInterface
This interface defines the base contract for sales entities in Magento 2, providing standard methods to get and set the entity ID and creation timesta...
Api\Data\InvoiceCommentCreationInterface
This interface defines the contract for creating invoice comments in Magento 2. Developers use this when programmatically adding comments to invoices...
Api\Data\InvoiceCommentInterface
This interface defines the contract for invoice comment data objects in Magento 2. Developers use it to manage comments added to invoices, including t...
Api\Data\InvoiceCommentSearchResultInterface
This interface defines the contract for search results when querying invoice comments in Magento 2. Developers use this when implementing repositories...
Api\Data\InvoiceCreationArgumentsInterface
This interface defines the contract for passing additional arguments when creating an invoice in Magento 2. Developers use this to extend invoice crea...
Api\Data\InvoiceInterface
This interface defines the contract for invoice data objects in Magento 2. Developers use this when working with invoice records that represent paymen...
Api\Data\InvoiceItemCreationInterface
This interface defines the data structure for creating individual invoice items when generating invoices programmatically through Magento's API. Devel...
Api\Data\InvoiceItemInterface
This interface defines the contract for invoice item data objects in Magento 2's Sales module. Developers use it when working with invoice items progr...
Api\Data\InvoiceItemSearchResultInterface
This interface defines the contract for search results when querying invoice items through Magento's API. Developers use this when implementing reposi...
Api\Data\InvoiceSearchResultInterface
This interface defines the structure for invoice search results in Magento 2. Developers use it when retrieving collections of invoices through reposi...
Api\Data\LineItemInterface
This interface defines the contract for line items in Magento 2 sales entities like invoices, shipments, and credit memos. It provides methods to get...
Api\Data\OrderAddressInterface
This interface defines the contract for order address data in Magento 2, representing both billing and shipping addresses associated with sales orders...
Api\Data\OrderAddressSearchResultInterface
This interface defines the contract for search results containing order address collections in Magento 2. Developers use this when retrieving multiple...
Api\Data\OrderInterface
OrderInterface defines the data contract for orders in Magento 2. Developers use this interface to work with order data through the API, including ord...
Api\Data\OrderItemInterface
This interface defines the contract for order item data objects in Magento 2, representing individual products within a sales order. Developers use th...
Api\Data\OrderItemSearchResultInterface
This interface defines the contract for search results when querying order items in Magento 2. Developers use this when implementing repositories or s...
Api\Data\OrderPaymentInterface
This interface defines the data structure and methods for managing payment information associated with sales orders in Magento 2. Developers use it to...
Api\Data\OrderPaymentSearchResultInterface
This interface defines the contract for search results when querying order payment records in Magento 2. Developers use this when working with reposit...
Api\Data\OrderSearchResultInterface
This interface defines the contract for order search result collections in Magento 2. Developers use this when retrieving multiple orders through repo...
Api\Data\OrderStatusHistoryInterface
This interface defines the contract for order status history records in Magento 2. Developers use it to track and manage changes to an order's status...
Api\Data\OrderStatusHistorySearchResultInterface
This interface defines a contract for search results when querying order status history records in Magento 2. Developers use this interface when retri...
Api\Data\ShipmentCommentCreationInterface
This interface defines the contract for creating shipment comments in Magento 2. Developers use this when programmatically adding comments to shipment...
Api\Data\ShipmentCommentInterface
This interface defines the contract for shipment comment data objects in Magento 2. Developers use it when working with comments attached to shipment...
Api\Data\ShipmentCommentSearchResultInterface
This interface defines the contract for search results when querying shipment comments in Magento 2. Developers use this interface when retrieving fil...
Api\Data\ShipmentCreationArgumentsInterface
This interface defines the contract for passing additional arguments when creating shipments in Magento 2. Developers use this interface to extend shi...
Api\Data\ShipmentInterface
This interface defines the contract for shipment data objects in Magento 2. Developers use it to retrieve and manipulate shipment information includin...
Api\Data\ShipmentItemCreationInterface
This interface defines the structure for creating shipment items when processing orders in Magento 2. Developers use this interface when building ship...
Api\Data\ShipmentItemInterface
This interface defines the contract for shipment items in Magento 2, representing individual products included in a delivery package. Developers use t...
Api\Data\ShipmentItemSearchResultInterface
This interface defines the contract for search results when querying shipment items in Magento 2. Developers use this when implementing repository met...
Api\Data\ShipmentPackageCreationInterface
This interface defines the contract for creating shipment packages in Magento 2. Developers use this when programmatically creating delivery packages...
Api\Data\ShipmentPackageInterface
This interface defines the contract for shipment package data objects in Magento 2. Developers use this when working with order shipments to represent...
Api\Data\ShipmentSearchResultInterface
This interface defines the contract for search results when querying shipments in Magento 2. Developers use this when retrieving multiple shipment rec...
Api\Data\ShipmentTrackCreationInterface
This interface defines the contract for creating shipment tracking information in Magento 2. Developers use this when programmatically adding tracking...
Api\Data\ShipmentTrackInterface
This interface defines the contract for shipment tracking information in Magento 2. Developers use it when working with shipment tracking data, such a...
Api\Data\ShipmentTrackSearchResultInterface
This interface defines the contract for search results when querying shipment tracking records in Magento 2. Developers use this when implementing rep...
Api\Data\ShippingAssignmentInterface
This interface defines the structure for shipping assignments in Magento 2, which group order items together with their shipping information and assoc...
Api\Data\ShippingInterface
This interface defines the contract for shipping information objects in Magento 2 orders. Developers use this to retrieve or set shipping details incl...
Api\Data\TotalInterface
This interface defines the contract for managing shipping-related totals in Magento 2 sales orders, including amounts, taxes, discounts, invoices, ref...
Api\Data\TrackInterface
This interface defines the contract for shipment tracking information in Magento 2. Developers use this when creating or managing tracking numbers for...
Api\Data\TransactionInterface
This interface defines the contract for payment transaction data objects in Magento 2. Developers use it to interact with transaction records that rep...
Api\Data\TransactionSearchResultInterface
This interface defines the contract for returning collections of transaction search results in Magento 2. Developers use this when implementing or wor...
Api\Exception\CouldNotInvoiceExceptionInterface
This is a marker interface used to identify exceptions that occur when an invoice cannot be created for an order in Magento 2. Developers should throw...
Api\Exception\CouldNotRefundExceptionInterface
This interface marks exceptions that occur when a refund operation cannot be completed in Magento's sales system. Developers should implement this int...
Api\Exception\CouldNotShipExceptionInterface
This interface serves as a marker for exceptions that occur when a shipment cannot be created for an order in Magento 2. Developers should throw excep...
Api\Exception\DocumentValidationExceptionInterface
This is a marker interface used to identify exceptions that occur during sales document validation in Magento 2. Developers should implement this inte...
Api\InvoiceCommentRepositoryInterface
This repository interface manages CRUD operations for invoice comments in Magento 2. Developers use it to retrieve, save, or delete comments associate...
Api\InvoiceItemRepositoryInterface
This repository interface provides CRUD operations for managing individual invoice item records in Magento 2. Developers use this to retrieve, save, o...
Api\InvoiceManagementInterface
This interface defines the contract for managing invoice operations in Magento 2. Developers use this to capture payment on invoices, retrieve invoice...
Api\InvoiceOrderInterface
This interface defines the contract for creating invoices from orders in Magento 2. Developers use this to programmatically invoice an order, with opt...
Api\InvoiceRepositoryInterface
This repository interface provides methods for managing invoice entities in Magento 2. Developers use it to retrieve, create, save, and delete invoice...
Api\OrderAddressRepositoryInterface
This interface defines the contract for managing order addresses in Magento 2. Developers use this repository to retrieve, save, or delete billing and...
Api\OrderCustomerDelegateInterface
This interface defines a contract for delegating order-related customer operations to the Customer module. Developers would implement this interface t...
Api\OrderCustomerManagementInterface
This interface defines the contract for creating a customer account from an existing order. Developers use this when they need to convert a guest chec...
Api\OrderItemRepositoryInterface
This interface defines the contract for managing order items in Magento 2, providing CRUD operations to retrieve, create, update, and delete individua...
Api\OrderManagementInterface
This interface defines the contract for managing order operations in Magento 2. Developers use this to perform actions like canceling orders, adding c...
Api\OrderPaymentRepositoryInterface
This repository interface provides methods for managing order payment records in Magento 2. Developers use this to retrieve, create, update, or delete...
Api\OrderRepositoryInterface
This interface defines the contract for managing Magento order entities through CRUD operations. Developers use this repository to retrieve, save, del...
Api\OrderStatusHistoryRepositoryInterface
This repository interface provides methods to manage order status history comments in Magento 2. Developers use it to retrieve, save, or delete commen...
Api\PaymentFailuresInterface
This interface defines a contract for handling payment gateway failures in Magento 2. Developers would implement or use this interface to process and...
Api\RefundInvoiceInterface
This interface defines the contract for creating credit memos (refunds) for invoices in Magento 2. Developers use this when implementing refund functi...
Api\RefundOrderInterface
This interface defines the contract for creating offline refunds (credit memos) for orders in Magento 2. Developers use this when they need to program...
Api\ShipOrderInterface
This interface defines the contract for creating shipments for orders in Magento 2. Developers use this when they need to programmatically ship orders...
Api\ShipmentCommentRepositoryInterface
This interface defines the contract for managing shipment comments in Magento 2. Developers use this repository to retrieve, save, delete, or search f...
Api\ShipmentItemRepositoryInterface
This repository interface manages CRUD operations for individual items within shipments in Magento 2. Developers use it to retrieve, save, or delete s...
Api\ShipmentManagementInterface
This interface defines the contract for managing shipment operations in Magento 2. Developers use this interface to retrieve shipment labels, fetch sh...
Api\ShipmentRepositoryInterface
This interface defines the contract for managing shipment entities in Magento 2. Developers use this repository to retrieve, create, save, or delete s...
Api\ShipmentTrackRepositoryInterface
This repository interface manages CRUD operations for shipment tracking information in Magento 2. Developers use it to create, retrieve, update, and d...
Api\TransactionRepositoryInterface
This repository interface manages payment transaction data in Magento 2, providing CRUD operations for transactions between merchants and customers (p...
Config
This class provides access to sales-related configuration data, specifically for managing totals renderers and available product types. Developers use...
Config\Converter
This class converts sales configuration XML files (like sales.xml) into PHP arrays. It processes sections containing totals collectors for orders, inv...
Config\Data
This class provides access to sales configuration data, specifically sales totals configuration, by extending Magento's base Config\Data class. It act...
Config\Ordered
This abstract base class manages ordered collections of sales-related models (like order totals or invoice totals) in Magento 2. It handles loading, s...
Config\Reader
This class reads and loads sales configuration from sales.xml files across all modules. It defines how XML nodes are merged together using specific id...
Config\SchemaLocator
This class locates and provides paths to XSD schema files used for validating Magento 2 sales configuration XML files. Developers use this when workin...
Convert\Order
This converter class transforms Magento 2 order objects and order items into related sales documents (invoices, shipments, and credit memos) and their...
CronJob\AggregateSalesReportBestsellersData
This class is a cron job that automatically aggregates sales data for the bestsellers report in Magento 2. It runs periodically to refresh bestseller...
CronJob\AggregateSalesReportInvoicedData
This class is a cron job that automatically aggregates and refreshes sales invoice report statistics. It runs on a scheduled basis to compile invoice...
CronJob\AggregateSalesReportOrderData
This class is a scheduled cron job that aggregates sales order data for reporting purposes. It refreshes sales statistics for the last 25 hours, ensur...
CronJob\AggregateSalesReportRefundedData
This class is a cron job that automatically aggregates and refreshes refunded sales report data for the previous day. Developers would reference this...
CronJob\CleanExpiredOrders
This class provides automated cleanup functionality for expired pending payment orders via a cron job. Developers would use this to automatically canc...
CustomerGroupRetriever
This class retrieves the customer group ID for the current quote in the admin area. It checks if a quote exists in the admin session and returns its c...
Data
This helper class provides utility methods to check if various sales-related email notifications are enabled in the store configuration. Developers us...
Data\Order\Tax
This class represents tax data associated with sales orders in Magento 2. Developers use it to retrieve and manipulate order tax information such as t...
Download
This class handles secure file downloads for custom order and quote options in Magento 2. Developers use it to create file download responses while en...
EmailSenderHandler
This class handles asynchronous email sending for sales entities (orders, invoices, shipments, creditmemos) through cron jobs. Developers would use th...
EntityStorage
EntityStorage provides an in-memory registry for storing and retrieving sales entities (like orders, invoices, shipments) during a single request life...
ExpiredQuotesCollection
This class retrieves expired shopping cart quotes from the database based on store-specific lifetime configuration. Developers use it in cron jobs or...
ExportViewFilterProcessor
This class processes and filters columns for export operations in sales grids (like order grids) based on user-saved custom views. Developers use it t...
GridAsyncInsert
This class manages asynchronous indexing of sales entity grids (Orders, Invoices, Shipments, and Credit Memos) during cron jobs. Developers use this w...
Grid\Child\CollectionUpdater
This class updates transaction grid collections to filter child transactions based on a parent transaction ID. Developers would use this when displayi...
Grid\CollectionUpdater
This class updates sales transaction grid collections by filtering them based on the current order being viewed in the registry. Developers use this c...
Grid\LastUpdateTimeCache
This class manages caching of the last update timestamp for sales grid tables (orders, invoices, shipments, etc.). Developers use it to track when gri...
Guest
This helper class manages guest order tracking functionality in Magento 2, allowing non-logged-in customers to view their order details. It validates...
Increment
This deprecated class manages the generation and retrieval of sequential increment IDs for sales orders. Developers historically used it to get the ne...
InsertOrderStatusChangeHistory
This class tracks order status changes by inserting a new history record whenever an order's status is modified. Developers would use this to maintain...
InvoiceOrder
This class handles the creation of invoices for orders in Magento 2. Developers use this class when they need to programmatically generate an invoice...
Model\ConfigInterface
This interface defines the contract for accessing sales-related configuration in Magento 2. Developers use it to retrieve total renderers for displayi...
Model\EntityInterface
This interface defines a contract for sales entities (orders, invoices, shipments, credit memos) that have increment IDs - the human-readable identifi...
Model\OrderMutexInterface
This interface defines a locking mechanism to prevent race conditions when multiple processes try to update the same order simultaneously. Developers...
Model\Order\CreditmemoDocumentFactory
This factory class creates credit memo documents in Magento 2, either from an order or from an invoice. Developers use this when they need to programm...
Model\Order\CreditmemoFactory
The CreditmemoFactory creates credit memo (refund) objects in Magento 2 either from an order or an invoice. Developers use this factory when processin...
Model\Order\Creditmemo\CreditmemoValidatorInterface
This interface defines a contract for validating credit memos in Magento 2 before they are saved or processed. Developers use this when implementing c...
Model\Order\Creditmemo\ItemCreationValidatorInterface
This interface defines the contract for validating credit memo items during creation. Developers implement this interface to create custom validators...
Model\Order\Creditmemo\NotifierInterface
This interface defines the contract for sending credit memo notifications to customers. Developers would implement or use this interface when they nee...
Model\Order\Creditmemo\SenderInterface
This interface defines the contract for sending credit memo notification emails to customers in Magento 2. Developers implement this interface when cr...
Model\Order\InvoiceDocumentFactory
This factory class creates invoice documents for orders in Magento 2. Developers use it when programmatically generating invoices, as it prepares the...
Model\Order\InvoiceStatisticInterface
This interface defines a contract for classes that handle invoice statistics registration. Developers implement this interface to update order statist...
Model\Order\Invoice\InvoiceValidatorInterface
This interface defines the contract for validating invoices in Magento 2. Developers implement this interface to create validators that check if an in...
Model\Order\Invoice\NotifierInterface
This interface defines the contract for notifying customers when an invoice is created in Magento 2. Developers use this to send invoice notification...
Model\Order\Invoice\SenderInterface
This interface defines the contract for sending invoice notification emails to customers in Magento 2. Developers use this when implementing custom in...
Model\Order\OrderStateResolverInterface
This interface defines a contract for resolving the appropriate state of an order based on its current properties and additional arguments. Developers...
Model\Order\OrderValidatorInterface
This interface defines a contract for validating Magento order entities. Developers implement this interface to create custom order validators that ru...
Model\Order\PaymentAdapterInterface
This interface defines a contract for processing payment operations on orders during invoice creation. Developers use this to implement custom payment...
Model\Order\Pdf\ItemsFactory
This factory class creates instances of PDF item renderer classes used when generating PDF documents for sales orders, invoices, shipments, and credit...
Model\Order\RefundAdapterInterface
This interface defines a contract for processing refund operations in Magento 2. Developers implement this interface to create custom refund adapters...
Model\Order\Reorder\OrderedProductAvailabilityCheckerInterface
This interface defines a contract for checking if a previously ordered product with its selected options is still available in the catalog for reorder...
Model\Order\ShipmentDocumentFactory
This factory class creates shipment documents for orders in Magento 2. Developers use it when programmatically creating shipments, as it handles the c...
Model\Order\ShipmentFactory
This factory class creates Shipment objects for orders in Magento 2. Developers use it when programmatically creating shipments, as it handles the com...
Model\Order\Shipment\NotifierInterface
This interface defines a contract for notifying customers about shipment updates in Magento 2. Developers implement this interface to create custom sh...
Model\Order\Shipment\OrderRegistrarInterface
This interface defines a contract for updating order data when a shipment is created. Developers implement this interface to calculate and register sh...
Model\Order\Shipment\SenderInterface
This interface defines the contract for sending shipment notification emails to customers in Magento 2. Developers implement this interface to customi...
Model\Order\Shipment\ShipmentItemsValidatorInterface
This interface defines a contract for validators that check if order items can be shipped before creating a shipment. Developers implement this interf...
Model\Order\Shipment\ShipmentValidatorInterface
This interface defines a contract for validating shipment entities in Magento 2. Developers implement this interface to create validators that check i...
Model\Order\TotalFactory
This factory class creates instances of order total calculation classes that extend AbstractTotal. Developers use it when they need to dynamically ins...
Model\Order\Validation\InvoiceOrderInterface
This interface defines a contract for validating invoice creation in Magento 2. Developers implement this interface to add custom validation logic tha...
Model\Order\Validation\RefundInvoiceInterface
This interface defines the contract for validating refund operations on invoices in Magento 2. Developers implement this interface to create validatio...
Model\Order\Validation\RefundOrderInterface
This interface defines the contract for validating refund operations (credit memos) in Magento 2. Developers use this to ensure that an order meets al...
Model\Order\Validation\ShipOrderInterface
This interface defines the contract for validating shipment creation in Magento 2. Developers implement this interface to add custom validation logic...
Model\ResourceModel\GridInterface
This interface defines the contract for managing Magento sales grid tables (orders, invoices, shipments, credit memos). Developers implement this inte...
Model\ResourceModel\Grid\Collection
This class serves as a base collection for displaying sales document grids (orders, invoices, shipments, credit memos) in Magento 2's admin panel. It...
Model\ResourceModel\HelperInterface
This interface defines a contract for sales resource helper classes that support database operations related to sales reports. Developers use implemen...
Model\ResourceModel\Order\Collection
This collection class retrieves and manages sales order data from the database. Developers use it to fetch, filter, and search order records, includin...
Model\ResourceModel\Order\CollectionFactory
This factory class creates instances of Order Collection objects, which are used to retrieve and work with multiple orders from the database. Develope...
Model\ResourceModel\Order\CollectionFactoryInterface
This factory interface defines a contract for creating Order Collection instances in Magento 2. Developers use this to generate collections of orders,...
Model\ResourceModel\Provider\NotSyncedDataProviderInterface
This interface defines a contract for providers that identify sales entities (orders, invoices, shipments, etc.) that are out of sync between main tab...
Model\ResourceModel\Sale\Collection
This collection retrieves aggregated sales data for customers, calculating lifetime sales totals, average sale amounts, and order counts grouped by st...
Model\ResourceModel\Status\Collection
This collection class retrieves order status data from the database with state information automatically joined. Developers use this when they need to...
Model\Spi\CreditmemoCommentResourceInterface
This interface defines the contract for resource models that handle database operations for credit memo comments in Magento 2. Developers use this whe...
Model\Spi\CreditmemoItemResourceInterface
This interface defines the contract for resource models that handle database operations for credit memo items in Magento 2. Developers implement this...
Model\Spi\CreditmemoResourceInterface
This interface defines the contract for credit memo resource operations in Magento 2, specifically handling database persistence operations. Developer...
Model\Spi\InvoiceCommentResourceInterface
This interface defines the contract for database operations (save, load, delete) on invoice comment entities in Magento 2. Developers use this when im...
Model\Spi\InvoiceItemResourceInterface
This interface defines the contract for persisting invoice item data to the database in Magento 2. Developers use this when implementing custom resour...
Model\Spi\InvoiceResourceInterface
This interface defines the contract for invoice resource operations in Magento 2's Service Provider Interface (SPI) layer. Developers implement this i...
Model\Spi\OrderAddressResourceInterface
This interface defines the contract for persisting order address data in Magento 2. Developers would implement this interface when creating custom res...
Model\Spi\OrderItemResourceInterface
This interface defines the contract for order item resource operations in Magento 2. Developers use this when implementing custom persistence logic fo...
Model\Spi\OrderPaymentResourceInterface
This interface defines the contract for managing persistence operations (save, load, delete) of order payment data in Magento 2. Developers would impl...
Model\Spi\OrderResourceInterface
This interface defines the contract for Order resource models that handle database operations for order entities in Magento 2. Developers implement th...
Model\Spi\OrderStatusHistoryResourceInterface
This interface defines the contract for persisting order status history records in Magento 2. Developers use this when implementing custom resource mo...
Model\Spi\ShipmentCommentResourceInterface
This interface defines the contract for persisting shipment comment data to the database in Magento 2. It provides standard CRUD operations (save, loa...
Model\Spi\ShipmentItemResourceInterface
This interface defines the contract for resource models that handle database operations for shipment items in Magento 2. Developers use this when impl...
Model\Spi\ShipmentResourceInterface
This interface defines the contract for shipment resource operations in Magento 2, specifying standard CRUD methods (save, load, delete) for managing...
Model\Spi\ShipmentTrackResourceInterface
This interface defines the contract for resource models that handle database operations for shipment tracking records in Magento 2. Developers use thi...
Model\Spi\TransactionResourceInterface
This interface defines the contract for resource models that handle database operations for sales transactions in Magento 2. Developers implement this...
Model\Status\ListFactory
This factory class creates instances of the ListStatus model, which manages collections of order/invoice/shipment/credit memo statuses in Magento. Dev...
Model\ValidatorInterface
This interface defines a contract for validators in Magento 2's Sales module. Developers implement this interface to create custom validation logic fo...
Model\ValidatorResultInterface
This interface defines a contract for validator result objects in Magento's Sales module. Developers use this to collect and retrieve validation error...
Order
The Order class is the main model for managing sales orders in Magento 2. Developers use this class to load, manipulate, and perform operations on ord...
OrderIncrementIdChecker
This class verifies whether a specific order increment ID (order number) has already been used in the system. Developers use this to prevent duplicate...
OrderMutex
OrderMutex prevents race conditions when multiple concurrent requests try to update the same order simultaneously. It uses database row-level locking...
OrderNotifier
This class handles sending order confirmation emails to customers when a new order is placed. Developers would use this when they need to programmatic...
OrderRepository
OrderRepository is the primary data access class for managing Magento 2 orders. Developers use this class to retrieve, save, and delete orders program...
Order\Address
This class represents an order address (billing or shipping) in Magento 2. Developers use it to manage and manipulate address data associated with sal...
Order\AddressRepository
This repository class manages CRUD operations for order addresses in Magento 2. Developers use it to retrieve, save, delete, or search for order billi...
Order\Address\Renderer
This class formats order addresses according to specific display types (like HTML, PDF, or text formats) while respecting store-specific configuration...
Order\Address\Validator
This validator class ensures order addresses contain all required fields before saving or processing. Developers use it to validate billing and shippi...
Order\Admin\Item
This class serves as a wrapper or helper for retrieving basic product information from order items in the Magento admin area. Developers would use thi...
Order\Config
This class manages order status and state configurations in Magento 2. Developers use it to retrieve available order statuses, get default statuses fo...
Order\Create\ValidateCoupon
This class validates coupon codes applied during admin order creation in Magento 2. It checks if the coupon can be applied to quote items (considering...
Order\Creditmemo
The Creditmemo class represents a credit memo (refund document) in Magento 2's order management system. Developers use this class to create, manage, a...
Order\CreditmemoNotifier
This class handles sending credit memo notification emails to customers when a credit memo is created for an order. Developers use this notifier to tr...
Order\CreditmemoRepository
This repository class provides CRUD operations for managing credit memos (refunds) in Magento 2. Developers use this class to retrieve, create, save,...
Order\CreditmemoValidator
This validator class checks whether order items can be refunded when creating a credit memo in Magento 2. Developers use this to validate refund eligi...
Order\Creditmemo\Comment
This class represents a comment attached to a credit memo in Magento 2's order management system. Developers use it to add, retrieve, and manage admin...
Order\Creditmemo\CommentCreation
This class serves as a data transfer object (DTO) for creating comments on credit memos in Magento 2. Developers use this class when programmatically...
Order\Creditmemo\CommentRepository
This repository class manages CRUD operations for credit memo comments in Magento 2. Developers use it to retrieve, save, delete, or search for commen...
Order\Creditmemo\Config
This class manages the configuration for credit memo total collectors in Magento 2. It extends the base total configuration class to handle the sortin...
Order\Creditmemo\CreationArguments
This class serves as a data transfer object (DTO) for passing additional arguments when creating a credit memo in Magento 2. Developers use it to spec...
Order\Creditmemo\CreditmemoValidator
This class validates credit memo entities in Magento 2 by running a collection of validators against a credit memo before it's processed. Developers u...
Order\Creditmemo\Item
This class represents an individual line item within a credit memo (refund) in Magento 2. Developers use this model to access and manipulate credit me...
Order\Creditmemo\ItemCreation
This class represents a data transfer object (DTO) used when creating credit memo items via Magento's API. Developers use this class to specify which...
Order\Creditmemo\ItemCreationValidator
This validator class validates credit memo items during their creation process. Developers use it to ensure credit memo items meet all business rules...
Order\Creditmemo\ItemRepository
This repository class manages CRUD operations for credit memo items in Magento 2. Developers use it to retrieve, save, delete, or search for individua...
Order\Creditmemo\Notifier
This class handles sending credit memo notifications to customers and administrators when a credit memo is created or updated. Developers use this cla...
Order\Creditmemo\RefundOperation
This class handles the business logic for processing refunds when a credit memo is created in Magento 2. It updates the order's refund totals (taxes,...
Order\CustomerAssignment
This class handles the assignment of a customer account to an existing order, typically used when converting a guest checkout order to a registered cu...
Order\CustomerManagement
This class converts guest orders into customer accounts in Magento 2. Developers use it when implementing functionality to create a customer account f...
Order\Email\NotifySender
This abstract class serves as a base for sending email notifications to customers about their orders in Magento 2. Developers extend this class to cre...
Order\Email\Sender
This abstract base class provides common functionality for sending order-related emails in Magento 2. Developers extend this class when creating custo...
Order\Email\SenderBuilder
This class builds and sends order-related emails in Magento 2, such as order confirmations, invoices, and shipment notifications. Developers use this...
Order\Invoice
The Invoice class represents a sales invoice in Magento 2, used when creating invoices for customer orders. Developers use this class to create, manag...
Order\InvoiceNotifier
This class handles sending invoice email notifications to customers when an invoice is created for an order. Developers use this class to programmatic...
Order\InvoiceQuantityValidator
This validator ensures that invoice quantities are valid before an invoice is created. It checks that the invoice is associated with an order, that in...
Order\InvoiceRepository
This repository class provides CRUD (Create, Read, Update, Delete) operations for order invoices in Magento 2. Developers use this class to programmat...
Order\Invoice\Comment
This class represents a comment attached to an invoice in Magento 2. Developers use it to add notes or communication history to invoices, such as inte...
Order\Invoice\CommentCreation
This class represents a data transfer object (DTO) for creating invoice comments in Magento 2. Developers use this class when programmatically adding...
Order\Invoice\CommentRepository
This repository manages CRUD operations for invoice comments in Magento 2. Developers use this class to retrieve, save, or delete comments associated...
Order\Invoice\Config
This class manages the configuration for invoice total collectors in Magento 2. It extends the base total configuration to specifically handle how inv...
Order\Invoice\CreationArguments
This class serves as a data container for additional arguments passed during invoice creation in Magento 2. Developers use it to pass custom extension...
Order\Invoice\GetLogoFile
This class retrieves the custom logo file URL configured for invoice HTML printing. Developers would use this when generating invoice PDFs or HTML vie...
Order\Invoice\InvoiceValidator
This class validates invoice entities before they are saved or processed in Magento 2. Developers use this validator to ensure invoices meet all busin...
Order\Invoice\Item
This class represents an individual line item within a Magento invoice. Developers use it when creating, managing, or processing invoices to track pro...
Order\Invoice\ItemCreation
This class represents the data structure for creating invoice line items when generating an invoice for an order. Developers use this class to specify...
Order\Invoice\ItemRepository
This repository class manages CRUD operations for invoice line items in Magento 2. Developers use it to retrieve, save, or delete individual items wit...
Order\Invoice\Notifier
This class handles sending invoice notifications to customers after an invoice is created for an order. Developers use it when they need to trigger in...
Order\Invoice\PayOperation
This class handles the payment processing logic when an invoice is created for an order. It manages payment capture, updates invoice and order totals,...
Order\Item
The Order Item model represents individual products within a Magento 2 order. Developers use this class to access and manipulate order item data inclu...
Order\ItemRepository
This repository class manages CRUD operations for order items in Magento 2. Developers use it to load, save, delete, and search for order items progra...
Order\OrderCustomerDelegate
This class handles the delegation of guest orders to newly created customer accounts. It extracts customer data from an order and creates a redirect t...
Order\OrderCustomerExtractor
This class extracts customer data from an order, either retrieving an existing customer from the database or creating a new customer data object from...
Order\OrderValidator
This class validates Magento order entities by running them through a collection of validation rules. Developers use this when they need to ensure an...
Order\Payment
The Payment class manages all payment-related operations for orders in Magento 2. Developers use this class to handle payment authorization, capture,...
Order\PaymentAdapter
This adapter class handles payment processing for order invoices in Magento 2. Developers use this class when they need to execute payment operations...
Order\Payment\Info
This class manages payment information for orders in Magento 2. Developers use it to store, retrieve, and encrypt sensitive payment data like credit c...
Order\Payment\Processor
This class acts as a facade/processor for handling payment operations in Magento 2 orders. Developers use it to execute key payment actions like autho...
Order\Payment\Repository
This repository class manages CRUD operations for order payment entities in Magento 2. Developers use it to retrieve, save, delete, or create order pa...
Order\Payment\Transaction
This class manages payment transactions in Magento 2, tracking transaction history and building hierarchical relationships between different transacti...
Order\Pdf\AbstractPdf
This abstract base class provides core functionality for generating PDF documents for sales orders, invoices, shipments, and credit memos in Magento 2...
Order\Pdf\Config
This class provides configuration data for PDF generation in Magento 2's Sales module. Developers use it to retrieve renderer configurations for diffe...
Order\Pdf\Creditmemo
This class generates PDF documents for credit memos in Magento 2. Developers use this model when they need to create printable credit memo PDFs for cu...
Order\Pdf\Invoice
This class generates PDF documents for sales order invoices in Magento 2. Developers use this class when they need to create printable invoice PDFs, t...
Order\Pdf\Shipment
This class generates PDF documents for order shipments/packing slips in Magento 2. Developers use this to create printable shipment documents that dis...
Order\ProductOption
This class manages the addition of product options (like custom options, configurable product selections, bundle choices) to order items. Developers u...
Order\RefundAdapter
This adapter class serves as an interface wrapper for executing refund operations in Magento 2. Developers would use this class when they need to proc...
Order\Reorder\OrderedProductAvailabilityChecker
This class checks whether products from an existing order are available for reorder operations. Developers use this when implementing reorder function...
Order\Reorder\UnavailableProductsProvider
This class identifies products from an order that are no longer available for reordering. Developers use this when implementing reorder functionality...
Order\Shipment
This class represents a shipment entity in Magento 2's order fulfillment workflow. Developers use it to create, manage, and track product shipments fo...
Order\ShipmentDocumentFactory\ExtensionAttributesProcessor
This class processes and merges extension attributes when creating shipments in Magento 2. It combines existing shipment extension attributes with any...
Order\ShipmentRepository
This repository class manages CRUD operations for shipment entities in Magento 2. Developers use it to load, save, delete, search for shipments, and c...
Order\Shipment\Comment
This model class represents a comment or note attached to an order shipment in Magento 2. Developers use it to add internal notes or customer-visible...
Order\Shipment\CommentCreation
This class is a data transfer object (DTO) used when creating comments for shipments via Magento's API. Developers use it to pass comment data includi...
Order\Shipment\CommentRepository
This repository class manages CRUD operations for shipment comments in Magento 2. Developers use it to retrieve, save, or delete comments associated w...
Order\Shipment\CreationArguments
This class serves as a data container for passing additional arguments during shipment creation in Magento 2. Developers use this when creating shipme...
Order\Shipment\Item
This class represents a single item within a shipment in Magento 2's order fulfillment process. Developers use it when creating shipments to track whi...
Order\Shipment\ItemCreation
This class is a Data Transfer Object (DTO) used when creating shipment items programmatically via Magento's API. Developers use this class to specify...
Order\Shipment\ItemRepository
This repository class manages CRUD operations for shipment items in Magento 2. Developers use it to retrieve, save, or delete individual items within...
Order\Shipment\Notifier
This class handles sending shipment notifications to customers when an order is shipped. Developers use this class to trigger shipment emails and othe...
Order\Shipment\OrderRegistrar
This class registers a shipment with its parent order by processing shipment items, calculating the total shipped quantity, and updating item states....
Order\Shipment\Package
This class represents a package within a shipment in Magento 2's order fulfillment process. Developers use this class when creating or managing shipme...
Order\Shipment\PackageCreation
This class represents a data model for package creation during the shipment process in Magento 2. Developers use it when creating packages for orders...
Order\Shipment\ShipmentItemsValidator
This class validates shipment items before creating a shipment in Magento 2. It aggregates multiple validation rules through injected validators and c...
Order\Shipment\ShipmentValidator
This class validates shipment entities in Magento 2 before they are saved or processed. Developers use it to ensure shipment data meets business rules...
Order\Shipment\Track
This model class manages shipment tracking information for orders in Magento 2. Developers use it to create, retrieve, and update tracking numbers, ca...
Order\Shipment\TrackCreation
This class is a data transfer object (DTO) used when creating shipment tracking information via API or programmatic operations. Developers use this cl...
Order\Shipment\TrackRepository
This repository class manages shipment tracking information in Magento 2. Developers use it to create, retrieve, update, and delete tracking numbers f...
Order\Shipping
This class represents the shipping information for an order in Magento 2. Developers use it to manage shipping-related data including the shipping add...
Order\ShippingAssignment
This class represents a shipping assignment in Magento 2, which groups order items together with their associated shipping information and stock sourc...
Order\ShippingAssignmentBuilder
This builder class creates shipping assignment objects for sales orders, which group order items with their shipping information. Developers use this...
Order\ShippingBuilder
This builder class constructs ShippingInterface objects from order data, encapsulating all shipping-related information including address, method, and...
Order\ShippingTotal
This class represents a data model for order shipping totals in Magento 2, providing getters and setters for all shipping-related amounts including ba...
Order\StateResolver
This class determines the appropriate state for an order based on its current conditions and workflow stage. Developers use it to automatically calcul...
Order\Status
This class manages order status entities in Magento 2, allowing developers to create, assign, and manage statuses that track order lifecycle stages. U...
Order\StatusLabel
This class retrieves localized order status labels based on the store view and application area (frontend/adminhtml). Developers use it to display the...
Order\StatusResolver
This class determines the appropriate order status based on the order's state and payment method configuration. Developers use it when creating or upd...
Order\Status\History
This class manages order status history records in Magento 2, tracking comments, status changes, and customer notifications for orders. Developers use...
Order\Status\HistoryRepository
This repository class provides CRUD operations for managing order status history records in Magento 2. Developers use it to retrieve, save, or delete...
Order\Tax
This model represents tax information applied to a sales order in Magento 2. Developers use this class to access and manage tax details including tax...
Order\Tax\Item
This class represents tax details for individual items in a sales order, storing information about what type of item was taxed (product, shipping, gif...
Order\Total
This class serves as a data container for order total information in Magento 2. Developers use it to hold and transfer order total data (like subtotal...
Order\Total\AbstractTotal
This abstract base class serves as the foundation for order total calculation models in Magento 2. Developers extend this class when creating custom t...
Order\Validation\CanInvoice
This validator checks whether an invoice can be created for a Magento order. Developers use this class to validate that an order is in an appropriate...
Order\Validation\CanRefund
This validator checks if a Magento order can have a credit memo (refund) created for it. Developers use this class to validate refund eligibility by c...
Order\Validation\CanShip
This validator class determines whether an order can have a shipment created for it. Developers use this when implementing shipping functionality to e...
Order\Validation\InvoiceOrder
This class validates whether an order can be invoiced by checking both the invoice data and order state. Developers use this class when creating invoi...
Order\Validation\RefundInvoice
This class validates whether a refund can be created against an invoice in Magento 2. It coordinates multiple validators to check if the order allows...
Order\Validation\RefundOrder
This class validates whether a refund (credit memo) can be created for an order in Magento 2. It checks if the order can be refunded, validates the cr...
Order\Validation\ShipOrder
This class validates whether an order can be shipped in Magento 2. It checks if the order state allows shipment creation, validates shipment quantitie...
Order\Webapi\ChangeOutputArray
This class modifies order item data returned by Magento's Web API to ensure row totals are correctly calculated and formatted. It recalculates row tot...
RefundInvoice
This class handles the business logic for refunding an invoice in Magento 2. Developers would use this class (or its interface RefundInvoiceInterface)...
RefundOrder
This class handles the complete refund process for Magento 2 orders. Developers use it to programmatically create credit memos, process refunds, updat...
Reorder
This helper class manages reorder functionality in Magento 2's Sales module. Developers use it to check if the reorder feature is enabled in store con...
Reorder\Data\Error
This class serves as a Data Transfer Object (DTO) that represents error information during order reorder operations. Developers use it to encapsulate...
Reorder\Data\ReorderOutput
This is a Data Transfer Object (DTO) that represents the result of a reorder operation in Magento 2. It encapsulates both the shopping cart created fr...
Reorder\OrderInfoBuyRequestGetter
This class retrieves and processes the buy request information from an order item, specifically handling custom product options during reorder operati...
Reorder\Reorder
This class handles the reorder functionality in Magento 2, allowing customers to quickly add products from a previous order back to their shopping car...
ResourceModel\AbstractGrid
This abstract base class provides common functionality for Magento 2 sales grid tables (like order grids, invoice grids, etc.). Developers extend this...
ResourceModel\Attribute
This class handles saving specific attributes of sales entities (orders, invoices, shipments, etc.) without triggering a full model save. Developers u...
ResourceModel\EntityAbstract
This abstract resource model serves as the base class for all sales entity resource models (orders, invoices, shipments, credit memos) in Magento 2. I...
ResourceModel\Grid
This class manages the synchronization of sales order data from the main order tables to grid tables used for displaying orders in the admin panel. De...
ResourceModel\GridPool
This class manages a collection of sales-related grid resources (like orders, invoices, shipments grids) and provides a centralized way to refresh the...
ResourceModel\Helper
This helper class manages database operations for sales reporting, specifically handling the calculation and updating of product ranking positions in...
ResourceModel\Metadata
This class serves as a metadata container and factory for Sales entities, providing access to both the resource model (mapper) and model instances. De...
ResourceModel\Order
This resource model handles database operations for sales orders in Magento 2. Developers use it to save orders to the database, aggregate product inf...
ResourceModel\Order\Address
This resource model manages database operations for sales order addresses in Magento 2. Developers use it to save, load, validate, and retrieve order...
ResourceModel\Order\Creditmemo
This resource model manages database operations for credit memos in Magento 2. Developers use this class when they need to save, load, or perform data...
ResourceModel\Order\Invoice
This resource model handles database operations for order invoices in Magento 2. Developers use this class to save, load, and query invoice data from...
ResourceModel\Order\Item
This resource model handles database operations for order items in Magento 2. Developers use this class when they need to save, load, update, or delet...
ResourceModel\Order\Payment
This resource model handles database operations for order payment records in Magento 2. It manages saving and retrieving payment information from the...
ResourceModel\Order\Relation
This class manages the persistence of related entities when saving a Magento order. It automatically saves order items, payment information, status hi...
ResourceModel\Order\Shipment
This resource model handles database operations for order shipments in Magento 2. Developers use this class when they need to save, load, or manipulat...
ResourceModel\Order\Status
This resource model manages order statuses in Magento 2, handling database operations for status configuration, labels, and state assignments. Develop...
ResourceModel\Order\Tax
This resource model manages database operations for order tax records in Magento 2. Developers use this class when they need to perform CRUD operation...
ResourceModel\Provider\NotSyncedDataProvider
This class acts as a composite provider that aggregates multiple data providers to identify records that are not synchronized between main sales table...
ResourceModel\Provider\UpdatedAtListProvider
This class identifies entities in Magento Sales tables that need to be synchronized to their corresponding grid tables by comparing updated_at timesta...
ResourceModel\Provider\UpdatedIdListProvider
This class retrieves a list of entity IDs from the main sales table that have been updated but not yet synchronized to their corresponding grid table....
ResourceModel\Report
This is a flexible resource model for sales reports that allows dynamic initialization of different database tables. Developers use this as a base cla...
ResourceModel\Report\AbstractReport
This is a base abstract class for sales-related report resource models in Magento 2. Developers extend this class when creating custom sales report re...
ResourceModel\Report\Bestsellers
This resource model generates and manages bestsellers reports by aggregating sales order data from the sales_order and sales_order_item tables. Develo...
ResourceModel\Report\Invoiced
This resource model aggregates invoice-related sales data into reporting tables for analytics and dashboard purposes. Developers use this class when t...
ResourceModel\Report\Order
This resource model aggregates sales order data for reporting purposes in Magento 2. Developers use this class to generate statistical summaries of or...
ResourceModel\Report\Refunded
This resource model aggregates and generates statistical reports about refunded orders in Magento 2. Developers use this class when they need to compi...
ResourceModel\Report\Shipping
This class aggregates shipping data from orders and invoices into reporting tables for analytics purposes. Developers would use this to generate shipp...
ResourceModel\SalesOrderStatusChangeHistory
This resource model manages the order status change history in Magento 2. Developers use it to track and retrieve historical status changes for sales...
Rss\NewOrder
This class generates an RSS feed for new orders created in the last 7 days in Magento 2. Developers would use this to provide administrators with an R...
Rss\OrderStatus
This class provides RSS feed functionality for order status updates in Magento 2. Developers use it to generate RSS feeds that customers can subscribe...
Rss\Signature
This class provides signature generation and validation for RSS feeds in Magento 2's Sales module. Developers use it to sign data strings (like order...
RtlTextHandler
This class handles Right-to-Left (RTL) text processing for Arabic and Hebrew languages in sales-related contexts. Developers use it to detect if text...
SalesEntityCommentValidator
This helper validates whether a user is allowed to edit comments on sales entities (credit memos, invoices, and shipments). Developers use this class...
Service\CreditmemoService
This service class manages credit memo operations in Magento 2, including processing refunds, sending notifications, and retrieving credit memo commen...
Service\InvoiceService
InvoiceService handles the creation and management of invoices in Magento 2. Developers use this service to prepare invoices from orders, capture paym...
Service\OrderService
OrderService is the primary service class for managing order operations in Magento 2. Developers use this class to perform common order actions like c...
Service\PaymentFailuresService
This service handles failed payment transactions in Magento 2 by sending notification emails to store administrators. Developers would use this servic...
Service\ShipmentService
This service class provides core functionality for managing shipments in Magento 2. Developers use it to retrieve shipping labels, get shipment commen...
ShipOrder
This class handles the complete process of creating and saving shipments for orders in Magento 2. Developers use this class when they need to programm...
Status\ListStatus
This class manages a collection of status information items that different modules can add to track various statuses on sales objects. Developers use...
Validator
This class serves as a validation orchestrator that runs multiple validators against sales entities (orders, invoices, etc.). Developers use it to val...
ValidatorResult
This class stores and manages validation result messages in the Sales module. Developers use it to collect validation error or warning messages when v...
ValidatorResultMerger
This class merges multiple validator result objects into a single consolidated result. Developers use it when they need to combine validation outcomes...