Magento_Sales Version Compatibility

Overview

This document tracks verified API surface, deprecations, and compatibility information for the Magento_Sales module in version 2.4.7.

Module Version (2.4.7): 103.0.7 PHP Requirement: ~8.1.0||~8.2.0||~8.3.0

Key Facts

Interface Return Types

Magento 2.4.7 Sales API interfaces use docblock @return annotations only — they do NOT have PHP native return type declarations:

// Actual OrderRepositoryInterface in 2.4.7
// NO PHP return type declarations
public function getList(\Magento\Framework\Api\SearchCriteriaInterface $searchCriteria);
public function get($id);
public function delete(\Magento\Sales\Api\Data\OrderInterface $entity);
public function save(\Magento\Sales\Api\Data\OrderInterface $entity);

Similarly, OrderManagementInterface has NO PHP return type declarations:

public function cancel($id);
public function getCommentsList($id);
public function addComment($id, \Magento\Sales\Api\Data\OrderStatusHistoryInterface $statusHistory);
public function notify($id);
public function getStatus($id);
public function hold($id);
public function unHold($id);
public function place(\Magento\Sales\Api\Data\OrderInterface $order);

Non-Existent Interfaces

The following interfaces do NOT exist in Magento_Sales 2.4.7 — do not reference them:

• BulkOrderManagementInterface — does not exist
• getListWithAdvancedFilters() method — does not exist on OrderRepositoryInterface

Order Grid Sync

The sales order grid is synced via GridSyncInsertObserver on sales_order_save_after, NOT via mview subscriptions.

Composer Dependencies (2.4.7)

API Interfaces

The Sales module has approximately 82 @api-annotated interfaces. Key ones include:

Management Interfaces

• OrderRepositoryInterface (@since 100.0.2)
• OrderManagementInterface (@since 100.0.2)
• InvoiceOrderInterface
• InvoiceManagementInterface
• RefundOrderInterface
• RefundInvoiceInterface
• ShipOrderInterface
• ShipmentManagementInterface
• CreditmemoManagementInterface
• PaymentFailuresInterface

Exception Interfaces

• CouldNotInvoiceExceptionInterface (@since 100.1.2)
• CouldNotShipExceptionInterface (@since 100.1.2)
• DocumentValidationExceptionInterface (@since 100.1.2)
• CouldNotRefundExceptionInterface (@since 100.1.3)

Verified Deprecations (from @deprecated annotations in source)

Deprecated Classes

Deprecated Methods

Deprecated Event Argument

In all email sender classes (OrderSender, InvoiceSender, ShipmentSender, CreditmemoSender, etc.), the event argument transport is deprecated — use transportObject instead.

Deprecated Payment Interface Constants

Upgrade Best Practices

Use Repository Pattern

// Recommended — uses service contract
$searchCriteria = $this->searchCriteriaBuilder
    ->addFilter('status', 'processing')
    ->create();
$orders = $this->orderRepository->getList($searchCriteria);

// Deprecated pattern (still works)
$collection = $this->orderCollectionFactory->create();
$collection->addFieldToFilter('status', 'processing');

Use Interface Type Hints

// Recommended — interface (stable API)
public function __construct(
    private readonly \Magento\Sales\Api\OrderRepositoryInterface $orderRepository
) {}

// Avoid — concrete class (may change)
public function __construct(
    private readonly \Magento\Sales\Model\OrderRepository $orderRepository
) {}

Disclaimer: This document covers the Magento_Sales module as found in magento/product-community-edition:2.4.7. Version-to-version change details could not be verified from source alone and have been removed. For version-specific changelogs, consult the official Adobe Commerce release notes.