Sales Module

This interface defines the contract for managing credit memos (refunds) in Magento 2. Developers use this service to perform operations like canceling...

This interface defines the contract for comment data objects in the Magento Sales module. Developers use this interface when working with comments on...

This interface defines the contract for creating comments on credit memos in Magento 2. Developers use this when programmatically adding comments to c...

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

This interface defines the contract for search results when querying credit memo comments in Magento 2. Developers use this when working with reposito...

This interface defines the contract for managing additional arguments when creating a credit memo in Magento 2. Developers use it to specify shipping...

This interface defines the data structure for credit memos in Magento 2. Developers use it to retrieve and manipulate credit memo information when pro...

This interface defines the contract for creating individual credit memo items when issuing refunds in Magento 2. Developers use this interface when pr...

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

This interface defines the contract for search results when querying credit memo items through Magento's API. Developers use this when retrieving coll...

This interface defines the contract for credit memo search result collections returned by repository search operations. Developers use this when retri...

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

This interface defines the contract for creating invoice comments in Magento 2. Developers use this when programmatically adding comments to invoices...

This interface defines the contract for invoice comment data objects in Magento 2. Developers use it to manage comments added to invoices, including t...

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

This interface defines the contract for passing additional arguments when creating an invoice in Magento 2. Developers use this to extend invoice crea...

This interface defines the contract for invoice data objects in Magento 2. Developers use this when working with invoice records that represent paymen...

This interface defines the data structure for creating individual invoice items when generating invoices programmatically through Magento's API. Devel...

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

This interface defines the contract for search results when querying invoice items through Magento's API. Developers use this when implementing reposi...

This interface defines the structure for invoice search results in Magento 2. Developers use it when retrieving collections of invoices through reposi...

This interface defines the contract for line items in Magento 2 sales entities like invoices, shipments, and credit memos. It provides methods to get...

This interface defines the contract for order address data in Magento 2, representing both billing and shipping addresses associated with sales orders...

This interface defines the contract for search results containing order address collections in Magento 2. Developers use this when retrieving multiple...

OrderInterface defines the data contract for orders in Magento 2. Developers use this interface to work with order data through the API, including ord...

This interface defines the contract for order item data objects in Magento 2, representing individual products within a sales order. Developers use th...

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

This interface defines the data structure and methods for managing payment information associated with sales orders in Magento 2. Developers use it to...

This interface defines the contract for search results when querying order payment records in Magento 2. Developers use this when working with reposit...

This interface defines the contract for order search result collections in Magento 2. Developers use this when retrieving multiple orders through repo...

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

This interface defines a contract for search results when querying order status history records in Magento 2. Developers use this interface when retri...

This interface defines the contract for creating shipment comments in Magento 2. Developers use this when programmatically adding comments to shipment...

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

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

This interface defines the contract for passing additional arguments when creating shipments in Magento 2. Developers use this interface to extend shi...

This interface defines the contract for shipment data objects in Magento 2. Developers use it to retrieve and manipulate shipment information includin...

This interface defines the structure for creating shipment items when processing orders in Magento 2. Developers use this interface when building ship...

This interface defines the contract for shipment items in Magento 2, representing individual products included in a delivery package. Developers use t...

This interface defines the contract for search results when querying shipment items in Magento 2. Developers use this when implementing repository met...

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

This interface defines the contract for shipment package data objects in Magento 2. Developers use this when working with order shipments to represent...

This interface defines the contract for search results when querying shipments in Magento 2. Developers use this when retrieving multiple shipment rec...

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

This interface defines the contract for shipment tracking information in Magento 2. Developers use it when working with shipment tracking data, such a...

This interface defines the contract for search results when querying shipment tracking records in Magento 2. Developers use this when implementing rep...

This interface defines the structure for shipping assignments in Magento 2, which group order items together with their shipping information and assoc...

This interface defines the contract for shipping information objects in Magento 2 orders. Developers use this to retrieve or set shipping details incl...

This interface defines the contract for managing shipping-related totals in Magento 2 sales orders, including amounts, taxes, discounts, invoices, ref...

This interface defines the contract for shipment tracking information in Magento 2. Developers use this when creating or managing tracking numbers for...

This interface defines the contract for payment transaction data objects in Magento 2. Developers use it to interact with transaction records that rep...

This interface defines the contract for returning collections of transaction search results in Magento 2. Developers use this when implementing or wor...

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

This interface marks exceptions that occur when a refund operation cannot be completed in Magento's sales system. Developers should implement this int...

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

This is a marker interface used to identify exceptions that occur during sales document validation in Magento 2. Developers should implement this inte...

This interface defines the contract for managing invoice operations in Magento 2. Developers use this to capture payment on invoices, retrieve invoice...

This interface defines the contract for creating invoices from orders in Magento 2. Developers use this to programmatically invoice an order, with opt...

This interface defines a contract for delegating order-related customer operations to the Customer module. Developers would implement this interface t...

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

This interface defines the contract for managing order operations in Magento 2. Developers use this to perform actions like canceling orders, adding c...

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

This interface defines the contract for creating credit memos (refunds) for invoices in Magento 2. Developers use this when implementing refund functi...

This interface defines the contract for creating offline refunds (credit memos) for orders in Magento 2. Developers use this when they need to program...

This interface defines the contract for creating shipments for orders in Magento 2. Developers use this when they need to programmatically ship orders...

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

This interface defines the contract for accessing sales-related configuration in Magento 2. Developers use it to retrieve total renderers for displayi...

This interface defines a contract for sales entities (orders, invoices, shipments, credit memos) that have increment IDs - the human-readable identifi...

This interface defines a locking mechanism to prevent race conditions when multiple processes try to update the same order simultaneously. Developers...

This interface defines a contract for validating credit memos in Magento 2 before they are saved or processed. Developers use this when implementing c...

This interface defines the contract for validating credit memo items during creation. Developers implement this interface to create custom validators...

This interface defines the contract for sending credit memo notifications to customers. Developers would implement or use this interface when they nee...

This interface defines the contract for sending credit memo notification emails to customers in Magento 2. Developers implement this interface when cr...

This interface defines a contract for classes that handle invoice statistics registration. Developers implement this interface to update order statist...

This interface defines the contract for validating invoices in Magento 2. Developers implement this interface to create validators that check if an in...

This interface defines the contract for notifying customers when an invoice is created in Magento 2. Developers use this to send invoice notification...

This interface defines the contract for sending invoice notification emails to customers in Magento 2. Developers use this when implementing custom in...

This interface defines a contract for resolving the appropriate state of an order based on its current properties and additional arguments. Developers...

This interface defines a contract for validating Magento order entities. Developers implement this interface to create custom order validators that ru...

This interface defines a contract for processing payment operations on orders during invoice creation. Developers use this to implement custom payment...

This interface defines a contract for processing refund operations in Magento 2. Developers implement this interface to create custom refund adapters...

This interface defines a contract for checking if a previously ordered product with its selected options is still available in the catalog for reorder...

This interface defines a contract for notifying customers about shipment updates in Magento 2. Developers implement this interface to create custom sh...

This interface defines a contract for updating order data when a shipment is created. Developers implement this interface to calculate and register sh...

This interface defines the contract for sending shipment notification emails to customers in Magento 2. Developers implement this interface to customi...

This interface defines a contract for validators that check if order items can be shipped before creating a shipment. Developers implement this interf...

This interface defines a contract for validating shipment entities in Magento 2. Developers implement this interface to create validators that check i...

This interface defines a contract for validating invoice creation in Magento 2. Developers implement this interface to add custom validation logic tha...

This interface defines the contract for validating refund operations on invoices in Magento 2. Developers implement this interface to create validatio...

This interface defines the contract for validating refund operations (credit memos) in Magento 2. Developers use this to ensure that an order meets al...

This interface defines the contract for validating shipment creation in Magento 2. Developers implement this interface to add custom validation logic...

This interface defines the contract for managing Magento sales grid tables (orders, invoices, shipments, credit memos). Developers implement this inte...

This interface defines a contract for sales resource helper classes that support database operations related to sales reports. Developers use implemen...

This factory interface defines a contract for creating Order Collection instances in Magento 2. Developers use this to generate collections of orders,...

This interface defines a contract for providers that identify sales entities (orders, invoices, shipments, etc.) that are out of sync between main tab...

This interface defines the contract for resource models that handle database operations for credit memo comments in Magento 2. Developers use this whe...

This interface defines the contract for resource models that handle database operations for credit memo items in Magento 2. Developers implement this...

This interface defines the contract for credit memo resource operations in Magento 2, specifically handling database persistence operations. Developer...

This interface defines the contract for database operations (save, load, delete) on invoice comment entities in Magento 2. Developers use this when im...

This interface defines the contract for persisting invoice item data to the database in Magento 2. Developers use this when implementing custom resour...

This interface defines the contract for invoice resource operations in Magento 2's Service Provider Interface (SPI) layer. Developers implement this i...

This interface defines the contract for persisting order address data in Magento 2. Developers would implement this interface when creating custom res...

This interface defines the contract for order item resource operations in Magento 2. Developers use this when implementing custom persistence logic fo...

This interface defines the contract for managing persistence operations (save, load, delete) of order payment data in Magento 2. Developers would impl...

This interface defines the contract for Order resource models that handle database operations for order entities in Magento 2. Developers implement th...

This interface defines the contract for persisting order status history records in Magento 2. Developers use this when implementing custom resource mo...

This interface defines the contract for persisting shipment comment data to the database in Magento 2. It provides standard CRUD operations (save, loa...

This interface defines the contract for resource models that handle database operations for shipment items in Magento 2. Developers use this when impl...

This interface defines the contract for shipment resource operations in Magento 2, specifying standard CRUD methods (save, load, delete) for managing...

This interface defines the contract for resource models that handle database operations for shipment tracking records in Magento 2. Developers use thi...

This interface defines the contract for resource models that handle database operations for sales transactions in Magento 2. Developers implement this...

This interface defines a contract for validators in Magento 2's Sales module. Developers implement this interface to create custom validation logic fo...

This interface defines a contract for validator result objects in Magento's Sales module. Developers use this to collect and retrieve validation error...