Sales Module

This is an abstract base class for Sales module entities (orders, invoices, shipments, credit memos) that provides common functionality for handling d...

This abstract class provides a base implementation for sending email notifications related to sales entities (orders, invoices, shipments, credit memo...

The AdminOrder\Create model manages the creation of orders in the Magento admin panel. Developers use this class when building custom admin order crea...

This class handles sending order confirmation and invoice emails when orders are created through the Magento admin panel. Developers use this when pro...

This class provides access to sales-related configuration data, specifically for managing totals renderers and available product types. Developers use...

This class converts sales configuration XML files (like sales.xml) into PHP arrays. It processes sections containing totals collectors for orders, inv...

This class provides access to sales configuration data, specifically sales totals configuration, by extending Magento's base Config\Data class. It act...

This abstract base class manages ordered collections of sales-related models (like order totals or invoice totals) in Magento 2. It handles loading, s...

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...

This class locates and provides paths to XSD schema files used for validating Magento 2 sales configuration XML files. Developers use this when workin...

This converter class transforms Magento 2 order objects and order items into related sales documents (invoices, shipments, and credit memos) and their...

This class is a cron job that automatically aggregates sales data for the bestsellers report in Magento 2. It runs periodically to refresh bestseller...

This class is a cron job that automatically aggregates and refreshes sales invoice report statistics. It runs on a scheduled basis to compile invoice...

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...

This class is a cron job that automatically aggregates and refreshes refunded sales report data for the previous day. Developers would reference this...

This class provides automated cleanup functionality for expired pending payment orders via a cron job. Developers would use this to automatically canc...

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...

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...

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...

This class handles asynchronous email sending for sales entities (orders, invoices, shipments, creditmemos) through cron jobs. Developers would use th...

EntityStorage provides an in-memory registry for storing and retrieving sales entities (like orders, invoices, shipments) during a single request life...

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...

This class manages asynchronous indexing of sales entity grids (Orders, Invoices, Shipments, and Credit Memos) during cron jobs. Developers use this w...

This class updates transaction grid collections to filter child transactions based on a parent transaction ID. Developers would use this when displayi...

This class updates sales transaction grid collections by filtering them based on the current order being viewed in the registry. Developers use this c...

This class manages caching of the last update timestamp for sales grid tables (orders, invoices, shipments, etc.). Developers use it to track when gri...

This deprecated class manages the generation and retrieval of sequential increment IDs for sales orders. Developers historically used it to get the ne...

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...

This class handles the creation of invoices for orders in Magento 2. Developers use this class when they need to programmatically generate an invoice...

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...

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 prevents race conditions when multiple concurrent requests try to update the same order simultaneously. It uses database row-level locking...

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 is the primary data access class for managing Magento 2 orders. Developers use this class to retrieve, save, and delete orders program...

This class represents an order address (billing or shipping) in Magento 2. Developers use it to manage and manipulate address data associated with sal...

This repository class manages CRUD operations for order addresses in Magento 2. Developers use it to retrieve, save, delete, or search for order billi...

This class formats order addresses according to specific display types (like HTML, PDF, or text formats) while respecting store-specific configuration...

This validator class ensures order addresses contain all required fields before saving or processing. Developers use it to validate billing and shippi...

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...

This class manages order status and state configurations in Magento 2. Developers use it to retrieve available order statuses, get default statuses fo...

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...

The Creditmemo class represents a credit memo (refund document) in Magento 2's order management system. Developers use this class to create, manage, a...

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...

This repository class provides CRUD operations for managing credit memos (refunds) in Magento 2. Developers use this class to retrieve, create, save,...

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...

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...

This class serves as a data transfer object (DTO) for creating comments on credit memos in Magento 2. Developers use this class when programmatically...

This repository class manages CRUD operations for credit memo comments in Magento 2. Developers use it to retrieve, save, delete, or search for commen...

This class manages the configuration for credit memo total collectors in Magento 2. It extends the base total configuration class to handle the sortin...

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...

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...

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...

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...

This validator class validates credit memo items during their creation process. Developers use it to ensure credit memo items meet all business rules...

This repository class manages CRUD operations for credit memo items in Magento 2. Developers use it to retrieve, save, delete, or search for individua...

This class handles sending credit memo notifications to customers and administrators when a credit memo is created or updated. Developers use this cla...

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,...

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...

This class converts guest orders into customer accounts in Magento 2. Developers use it when implementing functionality to create a customer account f...

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...

This abstract base class provides common functionality for sending order-related emails in Magento 2. Developers extend this class when creating custo...

This class builds and sends order-related emails in Magento 2, such as order confirmations, invoices, and shipment notifications. Developers use this...

The Invoice class represents a sales invoice in Magento 2, used when creating invoices for customer orders. Developers use this class to create, manag...

This class handles sending invoice email notifications to customers when an invoice is created for an order. Developers use this class to programmatic...

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...

This repository class provides CRUD (Create, Read, Update, Delete) operations for order invoices in Magento 2. Developers use this class to programmat...

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...

This class represents a data transfer object (DTO) for creating invoice comments in Magento 2. Developers use this class when programmatically adding...

This repository manages CRUD operations for invoice comments in Magento 2. Developers use this class to retrieve, save, or delete comments associated...

This class manages the configuration for invoice total collectors in Magento 2. It extends the base total configuration to specifically handle how inv...

This class serves as a data container for additional arguments passed during invoice creation in Magento 2. Developers use it to pass custom extension...

This class retrieves the custom logo file URL configured for invoice HTML printing. Developers would use this when generating invoice PDFs or HTML vie...

This class validates invoice entities before they are saved or processed in Magento 2. Developers use this validator to ensure invoices meet all busin...

This class represents an individual line item within a Magento invoice. Developers use it when creating, managing, or processing invoices to track pro...

This class represents the data structure for creating invoice line items when generating an invoice for an order. Developers use this class to specify...

This repository class manages CRUD operations for invoice line items in Magento 2. Developers use it to retrieve, save, or delete individual items wit...

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...

This class handles the payment processing logic when an invoice is created for an order. It manages payment capture, updates invoice and order totals,...

The Order Item model represents individual products within a Magento 2 order. Developers use this class to access and manipulate order item data inclu...

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...

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...

This class extracts customer data from an order, either retrieving an existing customer from the database or creating a new customer data object from...

This class validates Magento order entities by running them through a collection of validation rules. Developers use this when they need to ensure an...

The Payment class manages all payment-related operations for orders in Magento 2. Developers use this class to handle payment authorization, capture,...

This adapter class handles payment processing for order invoices in Magento 2. Developers use this class when they need to execute payment operations...

This class manages payment information for orders in Magento 2. Developers use it to store, retrieve, and encrypt sensitive payment data like credit c...

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...

This repository class manages CRUD operations for order payment entities in Magento 2. Developers use it to retrieve, save, delete, or create order pa...

This class manages payment transactions in Magento 2, tracking transaction history and building hierarchical relationships between different transacti...

This abstract base class provides core functionality for generating PDF documents for sales orders, invoices, shipments, and credit memos in Magento 2...

This class provides configuration data for PDF generation in Magento 2's Sales module. Developers use it to retrieve renderer configurations for diffe...

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...

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...

This class generates PDF documents for order shipments/packing slips in Magento 2. Developers use this to create printable shipment documents that dis...

This class manages the addition of product options (like custom options, configurable product selections, bundle choices) to order items. Developers u...

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...

This class checks whether products from an existing order are available for reorder operations. Developers use this when implementing reorder function...

This class identifies products from an order that are no longer available for reordering. Developers use this when implementing reorder functionality...

This class represents a shipment entity in Magento 2's order fulfillment workflow. Developers use it to create, manage, and track product shipments fo...

This class processes and merges extension attributes when creating shipments in Magento 2. It combines existing shipment extension attributes with any...

This repository class manages CRUD operations for shipment entities in Magento 2. Developers use it to load, save, delete, search for shipments, and c...

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...

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...

This repository class manages CRUD operations for shipment comments in Magento 2. Developers use it to retrieve, save, or delete comments associated w...

This class serves as a data container for passing additional arguments during shipment creation in Magento 2. Developers use this when creating shipme...

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...

This class is a Data Transfer Object (DTO) used when creating shipment items programmatically via Magento's API. Developers use this class to specify...

This repository class manages CRUD operations for shipment items in Magento 2. Developers use it to retrieve, save, or delete individual items within...

This class handles sending shipment notifications to customers when an order is shipped. Developers use this class to trigger shipment emails and othe...

This class registers a shipment with its parent order by processing shipment items, calculating the total shipped quantity, and updating item states....

This class represents a package within a shipment in Magento 2's order fulfillment process. Developers use this class when creating or managing shipme...

This class represents a data model for package creation during the shipment process in Magento 2. Developers use it when creating packages for orders...

This class validates shipment items before creating a shipment in Magento 2. It aggregates multiple validation rules through injected validators and c...

This class validates shipment entities in Magento 2 before they are saved or processed. Developers use it to ensure shipment data meets business rules...

This model class manages shipment tracking information for orders in Magento 2. Developers use it to create, retrieve, and update tracking numbers, ca...

This class is a data transfer object (DTO) used when creating shipment tracking information via API or programmatic operations. Developers use this cl...

This repository class manages shipment tracking information in Magento 2. Developers use it to create, retrieve, update, and delete tracking numbers f...

This class represents the shipping information for an order in Magento 2. Developers use it to manage shipping-related data including the shipping add...

This class represents a shipping assignment in Magento 2, which groups order items together with their associated shipping information and stock sourc...

This builder class creates shipping assignment objects for sales orders, which group order items with their shipping information. Developers use this...

This builder class constructs ShippingInterface objects from order data, encapsulating all shipping-related information including address, method, and...

This class represents a data model for order shipping totals in Magento 2, providing getters and setters for all shipping-related amounts including ba...

This class determines the appropriate state for an order based on its current conditions and workflow stage. Developers use it to automatically calcul...

This class manages order status entities in Magento 2, allowing developers to create, assign, and manage statuses that track order lifecycle stages. U...

This class retrieves localized order status labels based on the store view and application area (frontend/adminhtml). Developers use it to display the...

This class determines the appropriate order status based on the order's state and payment method configuration. Developers use it when creating or upd...

This class manages order status history records in Magento 2, tracking comments, status changes, and customer notifications for orders. Developers use...

This repository class provides CRUD operations for managing order status history records in Magento 2. Developers use it to retrieve, save, or delete...

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...

This class represents tax details for individual items in a sales order, storing information about what type of item was taxed (product, shipping, gif...

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...

This abstract base class serves as the foundation for order total calculation models in Magento 2. Developers extend this class when creating custom t...

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...

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...

This validator class determines whether an order can have a shipment created for it. Developers use this when implementing shipping functionality to e...

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...

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...

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...

This class validates whether an order can be shipped in Magento 2. It checks if the order state allows shipment creation, validates shipment quantitie...

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...

This class handles the business logic for refunding an invoice in Magento 2. Developers would use this class (or its interface RefundInvoiceInterface)...

This class handles the complete refund process for Magento 2 orders. Developers use it to programmatically create credit memos, process refunds, updat...

This class serves as a Data Transfer Object (DTO) that represents error information during order reorder operations. Developers use it to encapsulate...

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...

This class retrieves and processes the buy request information from an order item, specifically handling custom product options during reorder operati...

This class handles the reorder functionality in Magento 2, allowing customers to quickly add products from a previous order back to their shopping car...

This abstract base class provides common functionality for Magento 2 sales grid tables (like order grids, invoice grids, etc.). Developers extend this...

This class handles saving specific attributes of sales entities (orders, invoices, shipments, etc.) without triggering a full model save. Developers u...

This abstract resource model serves as the base class for all sales entity resource models (orders, invoices, shipments, credit memos) in Magento 2. I...

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...

This class manages a collection of sales-related grid resources (like orders, invoices, shipments grids) and provides a centralized way to refresh the...

This helper class manages database operations for sales reporting, specifically handling the calculation and updating of product ranking positions in...

This class serves as a metadata container and factory for Sales entities, providing access to both the resource model (mapper) and model instances. De...

This resource model handles database operations for sales orders in Magento 2. Developers use it to save orders to the database, aggregate product inf...

This resource model manages database operations for sales order addresses in Magento 2. Developers use it to save, load, validate, and retrieve order...

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...

This resource model handles database operations for order invoices in Magento 2. Developers use this class to save, load, and query invoice data from...

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...

This resource model handles database operations for order payment records in Magento 2. It manages saving and retrieving payment information from the...

This class manages the persistence of related entities when saving a Magento order. It automatically saves order items, payment information, status hi...

This resource model handles database operations for order shipments in Magento 2. Developers use this class when they need to save, load, or manipulat...

This resource model manages order statuses in Magento 2, handling database operations for status configuration, labels, and state assignments. Develop...

This resource model manages database operations for order tax records in Magento 2. Developers use this class when they need to perform CRUD operation...

This class acts as a composite provider that aggregates multiple data providers to identify records that are not synchronized between main sales table...

This class identifies entities in Magento Sales tables that need to be synchronized to their corresponding grid tables by comparing updated_at timesta...

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....

This is a flexible resource model for sales reports that allows dynamic initialization of different database tables. Developers use this as a base cla...

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...

This resource model generates and manages bestsellers reports by aggregating sales order data from the sales_order and sales_order_item tables. Develo...

This resource model aggregates invoice-related sales data into reporting tables for analytics and dashboard purposes. Developers use this class when t...

This resource model aggregates sales order data for reporting purposes in Magento 2. Developers use this class to generate statistical summaries of or...

This resource model aggregates and generates statistical reports about refunded orders in Magento 2. Developers use this class when they need to compi...

This class aggregates shipping data from orders and invoices into reporting tables for analytics purposes. Developers would use this to generate shipp...

This resource model manages the order status change history in Magento 2. Developers use it to track and retrieve historical status changes for sales...

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...

This class provides RSS feed functionality for order status updates in Magento 2. Developers use it to generate RSS feeds that customers can subscribe...

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...

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...

This service class manages credit memo operations in Magento 2, including processing refunds, sending notifications, and retrieving credit memo commen...

InvoiceService handles the creation and management of invoices in Magento 2. Developers use this service to prepare invoices from orders, capture paym...

OrderService is the primary service class for managing order operations in Magento 2. Developers use this class to perform common order actions like c...

This service handles failed payment transactions in Magento 2 by sending notification emails to store administrators. Developers would use this servic...

This service class provides core functionality for managing shipments in Magento 2. Developers use it to retrieve shipping labels, get shipment commen...

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...

This class manages a collection of status information items that different modules can add to track various statuses on sales objects. Developers use...

This class serves as a validation orchestrator that runs multiple validators against sales entities (orders, invoices, etc.). Developers use it to val...

This class stores and manages validation result messages in the Sales module. Developers use it to collect validation error or warning messages when v...

This class merges multiple validator result objects into a single consolidated result. Developers use it when they need to combine validation outcomes...