Log in

Sales Module

AbstractModel

Model

This abstract base class provides common functionality for all Sales module entities like orders, invoices, shipmen...

AbstractNotifier

Model

AbstractNotifier is a base class for sending email notifications related to sales entities (orders, invoices, shipm...

Create

Model

This class manages the entire process of creating orders from the Magento admin panel. It handles quote manipulatio...

EmailSender

Model

This class handles sending order and invoice confirmation emails when orders are created through the Magento admin...

Config

Model

This class provides access to sales-related configuration data in Magento 2, specifically for order totals renderin...

Converter

Model

This class converts Magento 2 sales configuration XML files (like sales.xml) into PHP arrays. Developers typically...

Data

Model

This class serves as a data container for sales configuration in Magento 2, specifically handling the caching and r...

Ordered

Model

This abstract class serves as a base for managing ordered collections of sales-related calculation models (like ord...

Reader

Model

This class loads and reads sales-related configuration from sales.xml files across all Magento modules. Developers...

SchemaLocator

Model

This class provides the file paths to XSD schema files used for validating Sales module configuration XML files. De...

Order

Model

The Order Convert model handles the conversion of order objects and their items into related sales documents like i...

AggregateSalesReportBestsellersData

Model

This class is a cron job handler that automatically refreshes bestseller product statistics in Magento's sales repo...

AggregateSalesReportInvoicedData

Model

This class is a cron job that automatically aggregates sales invoice data for reporting purposes. It runs periodica...

AggregateSalesReportOrderData

Model

This class is a cron job that automatically aggregates sales order data for reporting purposes. It runs periodicall...

AggregateSalesReportRefundedData

Model

This class is a cron job that automatically aggregates and refreshes sales refunded report statistics in Magento 2....

CleanExpiredOrders

Model

This class automatically cancels pending payment orders that have exceeded their configured lifetime. It runs as a...

CustomerGroupRetriever

Model

This class retrieves the customer group ID from the admin quote session in Magento 2's backend area. Developers use...

Tax

Model

This class represents tax information associated with an order in Magento 2. Developers use it to access and manipu...

Download

Model

The Download class handles secure file downloads for sales-related documents like custom option files attached to o...

EmailSenderHandler

Model

This class handles asynchronous sending of sales-related emails (orders, invoices, shipments, credit memos) to cust...

EntityStorage

Model

EntityStorage acts as an in-memory registry for storing and retrieving Magento sales entities (like orders, invoice...

ExportViewFilterProcessor

Model

This class processes and filters columns for exporting Sales order grids based on custom views saved in bookmarks....

GridAsyncInsert

Model

This class manages asynchronous insertion of sales entities (Orders, Invoices, Shipments, Credit Memos) into their...

CollectionUpdater

Model

This class updates grid collections for child transactions in the Magento admin panel. It filters the transaction g...

CollectionUpdater

Model

This class is responsible for updating sales transaction grid collections by filtering them based on the currently...

LastUpdateTimeCache

Model

This class manages caching of the last update timestamp for Magento 2 sales grid tables (orders, invoices, shipment...

Increment

Model

This class manages the generation and retrieval of increment IDs for sales orders in Magento 2. Developers would us...

InsertOrderStatusChangeHistory

Model

This class is responsible for tracking order status changes in Magento 2 by recording them in the status change his...

InvoiceOrder

Model

This class handles the creation of invoices for Magento 2 orders. Developers use this when they need to programmati...

Order

Model

The Order model class represents a sales order in Magento 2 and provides comprehensive functionality for managing o...

Address

Model

This model represents a billing or shipping address associated with a sales order in Magento 2. Developers use this...

Renderer

Model

This class is responsible for formatting order addresses in Magento 2. Developers use it when they need to display...

AddressRepository

Model

The AddressRepository class manages order address data in Magento 2, providing methods to create, retrieve, update,...

Validator

Model

This validator class ensures that sales order addresses contain all required information before they are saved or u...

Item

Model

This class serves as a wrapper or helper for accessing order item data in the Magento admin area. It provides a con...

Config

Model

This class manages order status and state configurations in Magento 2. Developers use it to retrieve status labels,...

ValidateCoupon

Model

This class validates and provides user feedback when applying or removing coupon codes during order creation in the...

Creditmemo

Model

The Creditmemo model represents a credit memo (refund document) in Magento 2's order management system. Developers...

Comment

Model

This class represents a comment on a credit memo in Magento 2. Developers use it to create, retrieve, and manage co...

CommentCreation

Model

This class is a data transfer object (DTO) used when creating comments for credit memos in Magento 2. Developers us...

CommentRepository

Model

This class manages CRUD operations for credit memo comments in Magento 2. Developers use it to retrieve, save, dele...

Config

Model

This configuration class manages the order creditmemo (refund) total collectors in Magento 2. It determines the ord...

CreationArguments

Model

This class serves as a data container for optional arguments when creating a credit memo in Magento 2. Developers u...

CreditmemoValidator

Model

This class validates credit memos in Magento 2 before they are saved or processed. Developers use it to ensure cred...

Item

Model

This class represents a single line item within a Magento 2 credit memo (refund). Developers use this model when cr...

ItemCreation

Model

This class is a data transfer object (DTO) used when creating credit memo items through the Magento 2 API. Develope...

ItemCreationValidator

Model

This class validates credit memo items during the credit memo creation process in Magento 2. Developers use it to e...

ItemRepository

Model

This repository class provides CRUD (Create, Read, Update, Delete) operations for credit memo items in Magento 2. D...

Notifier

Model

This class handles sending notifications when a credit memo is created in Magento 2. Developers use this class to t...

CreditmemoNotifier

Model

The CreditmemoNotifier class is responsible for sending credit memo email notifications to customers when a refund...

RefundOperation

Model

This class handles the complete refund operation for credit memos in Magento 2. Developers use it when processing r...

CreditmemoRepository

Model

This repository class provides CRUD (Create, Read, Update, Delete) operations for Credit Memo entities in Magento 2...

CreditmemoValidator

Model

This validator class determines whether order items can be refunded when creating a credit memo in Magento 2. Devel...

CustomerAssignment

Model

This class handles the assignment of a registered customer to an existing order, typically converting a guest order...

CustomerManagement

Model

This class manages the conversion of guest checkout orders into customer accounts in Magento 2. Developers use this...

NotifySender

Model

This abstract class serves as a base for sending notification emails related to sales orders in Magento 2. Develope...

Sender

Model

This abstract class serves as the base for sending order-related emails in Magento 2, such as order confirmations,...

SenderBuilder

Model

SenderBuilder is responsible for constructing and sending transactional email messages for sales orders in Magento...

OrderIncrementIdChecker

Model

This class checks whether a specific order increment ID has already been used in the system. Developers use this ut...

Invoice

Model

The Invoice model represents a sales invoice document in Magento 2. Developers use this class to create, manage, an...

Comment

Model

This class represents a comment attached to an invoice in Magento 2. Developers use it to add, retrieve, and manage...

CommentCreation

Model

This class is a data transfer object (DTO) used when creating comments for invoices in Magento 2. Developers use th...

CommentRepository

Model

This repository class manages CRUD operations for invoice comments in Magento 2. Developers use it to retrieve, sav...

Config

Model

This class manages the configuration for invoice total collectors in Magento 2. It extends the base total configura...

CreationArguments

Model

This class serves as a data container for additional arguments used during invoice creation in Magento 2. Developer...

GetLogoFile

Model

This class retrieves the custom logo file URL configured for invoice HTML printing in Magento 2. Developers would u...

InvoiceValidator

Model

This class validates invoice entities in Magento 2 by running a set of validators against an invoice object. Develo...

Item

Model

This class represents a single item line in a Magento 2 invoice. Developers use it when creating invoices, capturin...

ItemCreation

Model

This class serves as a data transfer object (DTO) for creating invoice items in Magento 2. Developers use it when p...

ItemRepository

Model

This repository class provides CRUD operations for managing individual invoice item records in Magento 2. Developer...

Notifier

Model

This class is responsible for sending invoice notifications in Magento 2. Developers use this class when they need...

InvoiceNotifier

Model

InvoiceNotifier is responsible for sending invoice notification emails to customers when an invoice is created or u...

PayOperation

Model

This class handles the payment processing logic when an invoice is registered for an order in Magento 2. Developers...

InvoiceQuantityValidator

Model

This validator ensures that invoice quantities are valid before an invoice is created in Magento 2. It checks that...

InvoiceRepository

Model

The InvoiceRepository class provides a centralized way to manage invoice operations in Magento 2, including creatin...

Item

Model

The Order Item class represents individual products within a Magento 2 order. Developers use this class to access a...

ItemRepository

Model

The ItemRepository class manages CRUD operations for order items in Magento 2. Developers use this class to retriev...

OrderMutex

Model

This class prevents race conditions when multiple requests try to update the same order simultaneously. It uses dat...

OrderNotifier

Model

This class handles sending order confirmation emails to customers in Magento 2. Developers use this class when they...

OrderCustomerDelegate

Model

This class handles the delegation of guest orders to customer accounts during the customer registration process. Wh...

OrderCustomerExtractor

Model

This class extracts customer data from a sales order, either retrieving an existing customer from the database or b...

OrderValidator

Model

This class validates Order entities in Magento 2 by running specified validation rules against an order object. Dev...

Payment

Model

The Order Payment class manages all payment-related operations for Magento orders including authorization, capture,...

PaymentAdapter

Model

This adapter class simplifies the payment processing workflow for orders and invoices in Magento 2. Developers use...

Info

Model

This class manages payment information for orders in Magento 2, including storing and retrieving payment method det...

Processor

Model

The Payment Processor class acts as a central coordinator for processing payment operations in Magento 2 orders. De...

Payment\Repository

Model

The Order Payment Repository provides a centralized way to retrieve, save, delete, and search for order payment rec...

Transaction

Model

This class manages payment transaction records in Magento 2, tracking the hierarchy and relationships between diffe...

AbstractPdf

Model

This abstract class serves as the base for generating PDF documents for Magento 2 sales documents like invoices, sh...

Config

Model

This configuration class provides PDF rendering settings for Magento 2 sales documents like invoices, shipments, an...

Creditmemo

Model

This class generates PDF documents for credit memos in Magento 2. Developers use this class when they need to creat...

Invoice

Model

This class generates PDF documents for sales order invoices in Magento 2. Developers use this class when they need...

Shipment

Model

This class generates PDF documents for order shipments in Magento 2. Developers use it when they need to create or...

ProductOption

Model

This class manages product options for order items in Magento 2. It processes and adds product-specific configurati...

RefundAdapter

Model

The RefundAdapter class serves as a facade for processing refunds in Magento 2. Developers use this class when they...

OrderedProductAvailabilityChecker

Model

This class checks if products from a previous order can be reordered based on their product type. Developers use it...

UnavailableProductsProvider

Model

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

OrderRepository

Model

OrderRepository is the main class for managing order data in Magento 2. Developers use it to retrieve, save, delete...

Shipment

Model

The Shipment model represents a physical shipment of products from an order in Magento 2. Developers use this class...

Comment

Model

This class represents a comment attached to a shipment in Magento 2. Developers use it to add, retrieve, and manage...

CommentCreation

Model

This class serves as a data transfer object (DTO) for creating comments on shipments in Magento 2. Developers use t...

CommentRepository

Model

This repository class manages CRUD operations for shipment comments in Magento 2. Developers use it to retrieve, sa...

CreationArguments

Model

This class serves as a data container for passing additional arguments when creating a shipment in Magento 2. Devel...

ExtensionAttributesProcessor

Model

This class processes and merges extension attributes for shipment documents in Magento 2. It combines extension att...

Item

Model

This class represents an individual item within a shipment in Magento 2. Developers use it when creating or managin...

ItemCreation

Model

This class is a data transfer object (DTO) used when creating shipment items in Magento 2. Developers use this clas...

ItemRepository

Model

This repository class manages CRUD operations for shipment items in Magento 2. Developers use this class to retriev...

Notifier

Model

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

OrderRegistrar

Model

This class handles the registration of shipment items with their parent order during the shipment creation process....

Package

Model

This class represents a package within a shipment in Magento 2's order fulfillment system. Developers use this mode...

PackageCreation

Model

This class represents a data model for creating shipment packages in Magento 2. Developers use this class when prog...

ShipmentRepository

Model

The ShipmentRepository class provides a centralized way to manage order shipments in Magento 2. Developers use this...

ShipmentItemsValidator

Model

This class validates shipment items before creating a shipment in Magento 2. Developers use this class to ensure th...

ShipmentValidator

Model

This class validates Magento 2 shipment entities before they are saved or processed. Developers use this validator...

Track

Model

This class represents a shipment tracking record in Magento 2, storing information like tracking numbers, carrier c...

TrackCreation

Model

This class is a data transfer object (DTO) used to create tracking information for shipments in Magento 2. Develope...

TrackRepository

Model

This repository class manages shipment tracking information in Magento 2. Developers use it to create, retrieve, up...

Shipping

Model

This class represents shipping information for a sales order in Magento 2. Developers use it to access and manage o...

ShippingAssignment

Model

ShippingAssignment is a data model that groups together shipping information, order items, and inventory stock ID f...

ShippingAssignmentBuilder

Model

This builder class creates ShippingAssignment objects for Magento 2 orders, which bundle together shipping informat...

ShippingBuilder

Model

The ShippingBuilder class is responsible for creating a ShippingInterface object that contains all shipping-related...

ShippingTotal

Model

This class represents shipping-related totals for a Magento 2 order, providing getters and setters for all shipping...

StateResolver

Model

The StateResolver class determines the appropriate state for an order based on its current conditions and propertie...

Status

Model

This class manages order statuses in Magento 2, allowing developers to create, assign, and manipulate status labels...

History

Model

This class manages order status history records, which track changes to an order's status along with comments and t...

HistoryRepository

Model

This repository class manages CRUD operations for order status history records in Magento 2. Developers use this cl...

StatusLabel

Model

This class retrieves and manages order status labels for display in different areas of Magento 2 (frontend, admin,...

StatusResolver

Model

This class determines the appropriate status for an order based on its state and payment method configuration. Deve...

Tax

Model

This model class represents tax information applied to a Magento 2 order. Developers use it to retrieve and manage...

Item

Model

This class represents tax details for individual items in a Magento 2 order, storing information about which taxes...

Total

Model

This class represents order totals data in Magento 2's sales module. It serves as a data container for storing and...

AbstractTotal

Model

This is a base class for implementing order total calculation models in Magento 2. Developers extend this class whe...

CanInvoice

Model

This validator class determines whether an order can have an invoice created for it. Developers use this class to c...

CanRefund

Model

This validator class determines whether a Magento 2 order is eligible for a credit memo (refund). Developers use th...

CanShip

Model

This validator class determines whether a shipment can be created for a given order in Magento 2. Developers use th...

InvoiceOrder

Model

This class validates whether an order can be invoiced and whether the invoice being created is valid. Developers us...

RefundInvoice

Model

This class validates whether a refund (credit memo) can be created against an invoice in Magento 2. Developers use...

RefundOrder

Model

This class validates whether a refund (credit memo) can be created for an order in Magento 2. It performs comprehen...

ShipOrder

Model

This class validates whether an order can be shipped in Magento 2. Developers use this validator before creating sh...

ChangeOutputArray

Model

This class modifies the output array of order item data for Web API responses by recalculating row totals with and...

RefundInvoice

Model

This class handles the process of refunding an invoice in Magento 2. Developers would use this class (or its interf...

RefundOrder

Model

This class handles the complete refund process for Magento 2 orders. Developers use it to programmatically create c...

Error

Model

This is a Data Transfer Object (DTO) that represents an error during the reorder process in Magento 2. Developers u...

ReorderOutput

Model

This class is a Data Transfer Object (DTO) that represents the result of a reorder operation in Magento 2. Develope...

OrderInfoBuyRequestGetter

Model

This class retrieves and processes product configuration data (buy request) from order items when customers reorder...

Reorder

Model

This class handles the reorder functionality in Magento 2, allowing customers to quickly re-add products from a pre...

AbstractGrid

Model

AbstractGrid serves as a base class for managing grid tables in the Magento Sales module, providing common function...

Attribute

Model

This class provides functionality to save individual attributes of sales entities (orders, invoices, shipments, etc...

EntityAbstract

Model

EntityAbstract serves as the base resource model for all Magento 2 sales entities (orders, invoices, shipments, cre...

Grid

Model

This class manages the synchronization of sales order data between the main order table and grid tables used for ad...

GridPool

Model

This class manages and refreshes multiple sales grid tables (like order, invoice, shipment grids) when an order is...

ResourceModel\Helper

Model

This helper class provides database-related utility functions for Magento 2 Sales module operations. Developers use...

Metadata

Model

This class serves as a metadata provider for Sales entities, managing the relationship between model classes and th...

Order

Model

This resource model handles database operations for Magento 2 orders, including saving order data and managing orde...

Address

Model

This class manages database operations for order addresses in Magento 2. Developers use it to save, load, validate,...

Creditmemo

Model

This class handles database operations for credit memo entities in Magento 2. Developers interact with it indirectl...

Invoice

Model

This resource model manages database operations for order invoices in Magento 2. Developers use this class when the...

Item

Model

This resource model handles database operations for order items in Magento 2. Developers use this class when they n...

Payment

Model

This resource model handles database operations for order payment data in Magento 2. Developers use this class indi...

Relation

Model

This class manages the saving of all related entities when an order is saved in Magento 2. It ensures that order it...

Shipment

Model

This resource model handles database operations for order shipments in Magento 2. Developers use this class when th...

Status

Model

This resource model manages order status data in the database, including CRUD operations, status-to-state assignmen...

Tax

Model

This resource model handles database operations for order tax records in Magento 2. Developers use this class when...

NotSyncedDataProvider

Model

This class provides a composite pattern implementation to retrieve IDs of records that are not synchronized between...

UpdatedAtListProvider

Model

This class identifies sales entities (orders, invoices, shipments, etc.) that need to be synchronized between main...

UpdatedIdListProvider

Model

This class retrieves a list of entity IDs from sales tables that have been updated in the main table but not yet sy...

Report

Model

This is a base resource model for sales reports in Magento 2. It provides a flexible way to dynamically initialize...

AbstractReport

Model

This abstract class serves as a base for all sales report resource models in Magento 2. Developers extend this clas...

Bestsellers

Model

This class manages the aggregation and generation of bestseller product reports in Magento 2. Developers would use...

Invoiced

Model

This resource model aggregates invoice-related sales data for reporting purposes in Magento 2. Developers use this...

Order

Model

This resource model aggregates sales order data for reporting purposes in Magento 2. It generates statistical summa...

Refunded

Model

This class manages the aggregation and reporting of refunded order data in Magento 2. Developers use this class whe...

Shipping

Model

This class aggregates shipping data from sales orders and invoices into reporting tables for analysis and display i...

SalesOrderStatusChangeHistory

Model

This resource model manages the sales order status change history by tracking when order statuses change over time....

NewOrder

Model

This class provides RSS feed functionality for new orders in Magento 2's admin panel. It generates an RSS feed cont...

OrderStatus

Model

This class provides RSS feed functionality for order status updates in Magento 2. Developers use it to generate RSS...

Signature

Model

This class provides signature generation and validation functionality for RSS feeds in Magento 2's Sales module. De...

RtlTextHandler

Model

This class handles Right-to-Left (RTL) text processing for Arabic and Hebrew languages in Magento's Sales module. D...

CreditmemoService

Model

The CreditmemoService class manages credit memo operations in Magento 2, including processing refunds, retrieving c...

InvoiceService

Model

This service class handles invoice operations in Magento 2, including creating invoices from orders, capturing paym...

OrderService

Model

OrderService is the main service class for managing order operations in Magento 2. Developers use this class to per...

PaymentFailuresService

Model

This service handles failed payment transactions in Magento 2 by sending notification emails to store administrator...

ShipmentService

Model

This service class provides centralized operations for managing shipments in Magento 2. Developers use this class t...

ShipOrder

Model

This class handles the creation and processing of shipments for orders in Magento 2. Developers would use this serv...

ListStatus

Model

This class manages a collection of status information items for sales entities in Magento 2. Developers use it to t...

Validator

Model

This class serves as a centralized validation orchestrator for sales entities in Magento 2. It accepts an entity (l...

ValidatorResult

Model

This class stores and manages validation result messages in Magento 2 Sales operations. Developers use it to collec...

ValidatorResultMerger

Model

This class merges multiple validator results into a single unified result object in Magento 2's Sales module. Devel...