CatalogInventory Module

Api\Data\StockCollectionInterface

Interface

This interface defines a collection container for Stock objects in Magento 2's inventory system. Developers would use this when working with multiple...

Api\Data\StockInterface

Interface

This interface defines the data structure for inventory stock entities in Magento 2, representing a physical or virtual warehouse location. Developers...

Api\Data\StockItemCollectionInterface

Interface

This interface defines a collection of stock item data objects returned from search operations in Magento's inventory system. Developers use it to wor...

Api\Data\StockItemInterface

Interface

This interface defines the contract for managing product inventory stock items in Magento 2. Developers use it to get and set inventory properties lik...

Api\Data\StockStatusCollectionInterface

Interface

This interface defines a collection of stock status items for products in Magento 2's inventory system. Developers use it to retrieve, set, and filter...

Api\Data\StockStatusInterface

Interface

This interface defines the contract for managing product stock status data in Magento 2, including inventory quantities, stock availability (in/out of...

Api\RegisterProductSaleInterface

Interface

This interface defines a contract for reducing product quantities from stock when products are sold. Developers would implement this interface to hand...

Api\RevertProductSaleInterface

Interface

This interface defines a contract for reverting product sales in inventory, typically used when an order is cancelled or refunded and stock quantities...

Api\StockConfigurationInterface

Interface

This interface defines methods for retrieving and managing catalog inventory configuration settings in Magento 2, such as minimum/maximum sale quantit...

Api\StockCriteriaInterface

Interface

This interface defines the contract for building search criteria when querying stock/inventory data in Magento 2. Developers would use implementations...

Api\StockIndexInterface

Interface

This interface defines a contract for rebuilding the stock index in Magento 2's catalog inventory system. Developers would implement this interface to...

Api\StockItemCriteriaInterface

Interface

This interface defines criteria methods for filtering and querying stock item collections in Magento 2's inventory system. Developers would use this t...

Api\StockManagementInterface

Interface

This interface defines the contract for managing stock quantities in Magento 2's catalog inventory system. Developers would use implementations of thi...

Api\StockRegistryInterface

Interface

This interface defines the contract for managing product inventory stock data in Magento 2. Developers use it to retrieve stock information, check pro...

Api\StockStateInterface

Interface

This interface defines methods for checking and managing product stock availability in Magento 2. Developers use it to verify if products are in stock...

Api\StockStatusCriteriaInterface

Interface

This interface defines criteria methods for filtering and retrieving stock status information in Magento 2's inventory system. Developers would use th...

Model\ResourceModel\QtyCounterInterface

Interface

This interface defines a contract for correcting inventory quantities of products in stock. Developers would implement this interface when they need t...

Model\ResourceModel\StockStatusFilterInterface

Interface

This interface defines a contract for filtering product queries based on stock status. Developers use implementations of this interface to add in-stoc...

Model\Spi\StockRegistryProviderInterface

Interface

This interface defines methods for retrieving inventory-related data in Magento 2, including stock information, stock items, and stock status for prod...

Model\Spi\StockStateProviderInterface

Interface

This interface defines methods for checking and validating product stock availability and quantities in Magento 2. Developers implement this interface...

Model\StockStatusApplierInterface

Interface

This deprecated interface was designed to flag whether a request originated from SearchResultApplier when applying stock status filters to product col...