Log in

Sales Module

CreditmemoManagementInterface

Interface

This interface defines the contract for managing credit memos in Magento 2. Developers use this to perform operatio...

CommentInterface

Interface

This interface defines the contract for comment objects in Magento 2 Sales module. Developers use it when working w...

CreditmemoCommentCreationInterface

Interface

This interface defines the contract for creating comments when generating credit memos in Magento 2. Developers use...

CreditmemoCommentInterface

Interface

This interface defines the contract for credit memo comment objects in Magento 2. Developers use it when working wi...

CreditmemoCommentSearchResultInterface

Interface

This interface defines the contract for search results when querying credit memo comments in Magento 2. Developers...

CreditmemoCreationArgumentsInterface

Interface

This interface defines the contract for credit memo creation arguments in Magento 2. Developers use this when progr...

CreditmemoInterface

Interface

This interface defines the data structure and operations for credit memos (refund documents) in Magento 2. Develope...

CreditmemoItemCreationInterface

Interface

This interface defines the contract for creating credit memo items in Magento 2. Developers use this when programma...

CreditmemoItemInterface

Interface

This interface defines the contract for credit memo item data in Magento 2. Developers use it when working with ref...

CreditmemoItemSearchResultInterface

Interface

This interface defines the contract for search results when querying credit memo items in Magento 2. Developers use...

CreditmemoSearchResultInterface

Interface

This interface defines the contract for search results when querying credit memos in Magento 2. Developers use this...

EntityInterface

Interface

This interface defines the base contract for sales entities in Magento 2, providing common methods for accessing en...

InvoiceCommentCreationInterface

Interface

This interface defines the contract for creating invoice comments in Magento 2. Developers use this when programmat...

InvoiceCommentInterface

Interface

This interface defines the contract for invoice comment data objects in Magento 2. Developers use it when working w...

InvoiceCommentSearchResultInterface

Interface

This interface defines the contract for search results when querying invoice comments in Magento 2. Developers use...

InvoiceCreationArgumentsInterface

Interface

This interface defines the contract for passing additional creation arguments when generating invoices in Magento 2...

InvoiceInterface

Interface

This interface defines the data contract for invoice entities in Magento 2. Developers use this interface when work...

InvoiceItemCreationInterface

Interface

This interface defines the structure for creating invoice items programmatically in Magento 2. Developers use this...

InvoiceItemInterface

Interface

InvoiceItemInterface defines the contract for individual line items within a Magento 2 invoice. Developers use this...

InvoiceItemSearchResultInterface

Interface

This interface defines the contract for search results when querying invoice items in Magento 2. Developers use thi...

InvoiceSearchResultInterface

Interface

This interface defines the contract for search results when querying invoices in Magento 2. Developers use this int...

LineItemInterface

Interface

This interface defines the base contract for line items in Magento 2 sales entities like invoices, shipments, and c...

OrderAddressInterface

Interface

This interface defines the structure for order address data in Magento 2's Sales module. Developers use this when w...

OrderAddressSearchResultInterface

Interface

This interface defines the contract for search results when querying order addresses in Magento 2. Developers use t...

OrderInterface

Interface

OrderInterface defines the data contract for sales orders in Magento 2. It provides getter and setter methods for a...

OrderItemInterface

Interface

This interface defines the data contract for individual items within a Magento 2 order. Developers use it when work...

OrderItemSearchResultInterface

Interface

This interface defines the contract for search results when querying order items in Magento 2. Developers use this...

OrderPaymentInterface

Interface

This interface defines the contract for order payment data in Magento 2. Developers use it to access and manipulate...

OrderPaymentSearchResultInterface

Interface

This interface defines the contract for search results when querying order payment records in Magento 2. Developers...

OrderSearchResultInterface

Interface

This interface defines the contract for order search results in Magento 2. Developers use this when working with or...

OrderStatusHistoryInterface

Interface

This interface defines the contract for order status history entries in Magento 2. Developers use it to track and m...

OrderStatusHistorySearchResultInterface

Interface

This interface defines the contract for search results when querying order status history records in Magento 2. It...

ShipmentCommentCreationInterface

Interface

This interface defines the contract for creating shipment comments in Magento 2. Developers use this when they need...

ShipmentCommentInterface

Interface

This interface defines the contract for shipment comment data objects in Magento 2. Developers use it when working...

ShipmentCommentSearchResultInterface

Interface

This interface defines the contract for search results when querying shipment comments in Magento 2. Developers use...

ShipmentCreationArgumentsInterface

Interface

This interface defines a contract for passing additional arguments when creating a shipment in Magento 2. Developer...

ShipmentInterface

Interface

This interface defines the data structure and contract for shipment records in Magento 2. Developers use it when wo...

ShipmentItemCreationInterface

Interface

This interface defines the contract for creating shipment items when processing orders in Magento 2. Developers use...

ShipmentItemInterface

Interface

This interface defines the contract for individual items within a shipment in Magento 2. Developers use it when wor...

ShipmentItemSearchResultInterface

Interface

This interface defines the contract for search results when querying shipment items in Magento 2. Developers use th...

ShipmentPackageCreationInterface

Interface

This interface defines the contract for creating shipment packages in Magento 2. Developers use this when programma...

ShipmentPackageInterface

Interface

This interface defines the contract for shipment package data objects in Magento 2. Developers use it when working...

ShipmentSearchResultInterface

Interface

This interface defines the contract for search results when querying shipments in Magento 2. Developers use this wh...

ShipmentTrackCreationInterface

Interface

This interface defines the contract for creating shipment tracking information in Magento 2. Developers use it when...

ShipmentTrackInterface

Interface

This interface defines the contract for shipment tracking data in Magento 2. Developers use it to work with trackin...

ShipmentTrackSearchResultInterface

Interface

This interface defines the contract for search results containing shipment tracking information in Magento 2. Devel...

ShippingAssignmentInterface

Interface

This interface defines the contract for a shipping assignment in Magento 2, which groups order items with their shi...

ShippingInterface

Interface

This interface defines the contract for handling shipping information in Magento 2 orders. Developers use it to acc...

TotalInterface

Interface

This interface defines the contract for managing shipping-related totals in Magento 2 sales orders, including amoun...

TrackInterface

Interface

This interface defines the contract for shipment tracking information in Magento 2. Developers use it when creating...

TransactionInterface

Interface

This interface defines the contract for payment transaction data objects in Magento 2. Developers use it to access...

TransactionSearchResultInterface

Interface

This interface defines the contract for search results when querying sales transactions in Magento 2. Developers us...

CouldNotInvoiceExceptionInterface

Interface

This is a marker interface used to identify exceptions that occur when an invoice cannot be created in Magento 2. D...

CouldNotRefundExceptionInterface

Interface

This interface serves as a marker for exceptions that occur when a refund operation cannot be completed in Magento...

CouldNotShipExceptionInterface

Interface

This is a marker interface used to identify exceptions that occur when a shipment cannot be created in Magento 2. D...

DocumentValidationExceptionInterface

Interface

This interface serves as a marker for exceptions thrown during sales document validation in Magento 2. Developers u...

InvoiceManagementInterface

Interface

This interface defines the contract for managing Magento 2 invoices, including operations like capturing payment, v...

InvoiceOrderInterface

Interface

This interface defines the contract for creating invoices from existing orders in Magento 2. Developers use this wh...

OrderCustomerDelegateInterface

Interface

This interface defines a contract for delegating customer account creation operations from the Sales module to the...

OrderCustomerManagementInterface

Interface

This interface defines a contract for creating customer accounts from existing orders. Developers use this when the...

OrderManagementInterface

Interface

This interface defines the contract for managing sales orders in Magento 2. Developers use this interface to perfor...

PaymentFailuresInterface

Interface

This interface defines a contract for handling payment gateway failures in Magento 2. Developers would use this to...

RefundInvoiceInterface

Interface

This interface defines a service contract for refunding invoices in Magento 2. Developers use this to programmatica...

RefundOrderInterface

Interface

This interface defines the contract for creating offline refunds (credit memos) for orders in Magento 2. Developers...

ShipmentManagementInterface

Interface

This interface defines the contract for managing shipment operations in Magento 2. Developers use this to retrieve...

ShipOrderInterface

Interface

This interface defines a contract for creating shipments in Magento 2. Developers use this to programmatically crea...

ConfigInterface

Interface

This interface defines a contract for accessing sales-related configuration in Magento 2. Developers use it to retr...

EntityInterface

Interface

This interface defines a contract for Magento sales entities (orders, invoices, shipments, credit memos) that requi...

CreditmemoValidatorInterface

Interface

This interface defines a contract for validating credit memo entities in Magento 2 before they are processed or sav...

ItemCreationValidatorInterface

Interface

This interface defines a contract for validating credit memo items during creation in Magento 2. Developers impleme...

NotifierInterface

Interface

This interface defines the contract for notifying customers about credit memo creation in Magento 2. Developers use...

SenderInterface

Interface

This interface defines the contract for sending credit memo notification emails to customers in Magento 2. Develope...

InvoiceValidatorInterface

Interface

This interface defines a contract for validating invoice entities in Magento 2. Developers use implementations of t...

NotifierInterface

Interface

This interface defines the contract for sending invoice notifications to customers in Magento 2. Developers use thi...

SenderInterface

Interface

This interface defines the contract for sending invoice notification emails to customers in Magento 2. Developers i...

InvoiceStatisticInterface

Interface

This interface defines a contract for registering invoice statistics on an order. Developers implement this interfa...

OrderMutexInterface

Interface

This interface defines a mutex (mutual exclusion) mechanism for Order operations in Magento 2. Developers use this...

OrderStateResolverInterface

Interface

This interface defines a contract for determining the appropriate state of an order in Magento 2 based on the order...

OrderValidatorInterface

Interface

This interface defines a contract for validating Magento 2 orders before performing operations like creation, updat...

PaymentAdapterInterface

Interface

This interface defines a contract for processing payment operations on orders in Magento 2. Developers implement th...

RefundAdapterInterface

Interface

This interface defines a contract for processing refunds in Magento 2. Developers implement this interface to creat...

OrderedProductAvailabilityCheckerInterface

Interface

This interface defines a contract for checking if a previously ordered product and its selected options are still a...

NotifierInterface

Interface

This interface defines a contract for notifying customers when a shipment is created or updated in Magento 2. Devel...

OrderRegistrarInterface

Interface

This interface defines a contract for updating order information when a shipment is created. Developers use this to...

SenderInterface

Interface

This interface defines a contract for sending shipment notification emails to customers in Magento 2. Developers wo...

ShipmentItemsValidatorInterface

Interface

This interface defines a contract for validating items before creating a shipment in Magento 2. Developers implemen...

ShipmentValidatorInterface

Interface

This interface defines a contract for validating shipment data in Magento 2. Developers implement this interface to...

InvoiceOrderInterface

Interface

This interface defines a contract for validating invoice creation in Magento 2. Developers implement this interface...

RefundInvoiceInterface

Interface

This interface defines a contract for validating credit memo refunds against invoices in Magento 2. Developers impl...

RefundOrderInterface

Interface

This interface defines a contract for validating refund operations (credit memos) in Magento 2. Developers implemen...

ShipOrderInterface

Interface

This interface defines a contract for validating order shipment operations in Magento 2. Developers use this when t...

GridInterface

Interface

This interface defines the contract for managing Magento 2 sales grid tables (like order grid, invoice grid, shipme...

HelperInterface

Interface

This interface defines a contract for sales resource helper classes that need to handle bestseller report operation...

CollectionFactoryInterface

Interface

This interface defines a factory contract for creating Order Collection instances in Magento 2. Developers use this...

NotSyncedDataProviderInterface

Interface

This interface defines a contract for providers that identify entities needing synchronization between main tables...

CreditmemoCommentResourceInterface

Interface

This interface defines the contract for database operations on credit memo comments in Magento 2. Developers use th...

CreditmemoItemResourceInterface

Interface

This interface defines the contract for database operations on credit memo items in Magento 2. Developers use this...

CreditmemoResourceInterface

Interface

This interface defines the contract for credit memo resource operations in Magento 2, providing methods to save, lo...

InvoiceCommentResourceInterface

Interface

This interface defines the contract for managing invoice comment persistence operations in Magento 2. Developers us...

InvoiceItemResourceInterface

Interface

This interface defines the contract for database operations (CRUD) on invoice item resources in Magento 2. Develope...

InvoiceResourceInterface

Interface

This interface defines the contract for managing Invoice resource operations in Magento 2's database layer. Develop...

OrderAddressResourceInterface

Interface

This interface defines the contract for data persistence operations on order address entities in Magento 2. Develop...

OrderItemResourceInterface

Interface

This interface defines the contract for managing database operations (CRUD) for order items in Magento 2. Developer...

OrderPaymentResourceInterface

Interface

This interface defines the contract for managing Order Payment data persistence operations in Magento 2. Developers...

OrderResourceInterface

Interface

This interface defines the contract for database operations (save, load, delete) on Magento 2 order objects. Develo...

OrderStatusHistoryResourceInterface

Interface

This interface defines the contract for managing order status history records in the database. Developers use this...

ShipmentCommentResourceInterface

Interface

This interface defines the contract for persistence operations (save, load, delete) on shipment comment resources i...

ShipmentItemResourceInterface

Interface

This interface defines the contract for database operations on shipment item entities in Magento 2. Developers woul...

ShipmentResourceInterface

Interface

This interface defines the contract for database operations on Magento 2 shipment entities. Developers use this whe...

ShipmentTrackResourceInterface

Interface

This interface defines the contract for database operations (CRUD) on shipment tracking information in Magento 2. D...

TransactionResourceInterface

Interface

This interface defines the contract for managing database operations (save, load, delete) for sales transaction rec...

ValidatorInterface

Interface

This interface defines a contract for validators in Magento 2's Sales module. Developers implement this interface t...

ValidatorResultInterface

Interface

This interface defines a contract for validator result objects in Magento 2 Sales module. It provides methods to co...