Interface

StockItemInterface

Magento\CatalogInventory\Api\Data\StockItemInterface

What it does

This interface defines the contract for managing product inventory stock items in Magento 2.

Developers use it to get and set inventory properties like quantity, stock status, minimum/maximum sale quantities, backorder settings, and quantity increments for products.

It's been deprecated in favor of the Multi Source Inventory (MSI) system but is still used in legacy inventory management code.

Public Methods

  • getItemId()
  • setItemId()
  • getProductId()
  • setProductId()
  • getStockId()
  • setStockId()
  • getQty()
  • setQty()
  • getIsInStock()
  • setIsInStock()
  • getIsQtyDecimal()
  • setIsQtyDecimal()
  • getShowDefaultNotificationMessage()
  • getUseConfigMinQty()
  • setUseConfigMinQty()
  • getMinQty()
  • setMinQty()
  • getUseConfigMinSaleQty()
  • setUseConfigMinSaleQty()
  • getMinSaleQty()
  • setMinSaleQty()
  • getUseConfigMaxSaleQty()
  • setUseConfigMaxSaleQty()
  • getMaxSaleQty()
  • setMaxSaleQty()
  • getUseConfigBackorders()
  • setUseConfigBackorders()
  • getBackorders()
  • setBackorders()
  • getUseConfigNotifyStockQty()
  • setUseConfigNotifyStockQty()
  • getNotifyStockQty()
  • setNotifyStockQty()
  • getUseConfigQtyIncrements()
  • setUseConfigQtyIncrements()
  • getQtyIncrements()
  • setQtyIncrements()
  • getUseConfigEnableQtyInc()
  • setUseConfigEnableQtyInc()
  • getEnableQtyIncrements()
  • setEnableQtyIncrements()
  • getUseConfigManageStock()
  • setUseConfigManageStock()
  • getManageStock()
  • setManageStock()
  • getLowStockDate()
  • setLowStockDate()
  • getIsDecimalDivided()
  • setIsDecimalDivided()
  • getStockStatusChangedAuto()
  • setStockStatusChangedAuto()
  • getExtensionAttributes()
  • setExtensionAttributes()