StockStatusInterface Interface Reference

Inheritance diagram for StockStatusInterface:

Public Member Functions
	getProductId ()
	setProductId ($productId)
	getStockId ()
	setStockId ($stockId)
	getQty ()
	setQty ($qty)
	getStockStatus ()
	setStockStatus ($stockStatus)
	getStockItem ()
	getExtensionAttributes ()
	setExtensionAttributes (\Magento\CatalogInventory\Api\Data\StockStatusExtensionInterface $extensionAttributes)

Data Fields
const	STATUS_OUT_OF_STOCK = 0
const	STATUS_IN_STOCK = 1
const	PRODUCT_ID = 'product_id'
const	STOCK_ID = 'stock_id'
const	QTY = 'qty'
const	STOCK_STATUS = 'stock_status'
const	STOCK_ITEM = 'stock_item'
Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'

Detailed Description

Interface StockStatusInterface @api

Since

100.0.2

Deprecated:

2.3.0 Replaced with Multi Source Inventory https://devdocs.magento.com/guides/v2.3/inventory/catalog-inventory-replacements.html

Definition at line 19 of file StockStatusInterface.php.

Member Function Documentation

getExtensionAttributes()

getExtensionAttributes

(

)

Retrieve existing extension attributes object or create a new one.

Returns

\Magento\CatalogInventory\Api\Data\StockStatusExtensionInterface|null

Implemented in Status.

getProductId()

getProductId

(

)

#-

Returns

int

Implemented in Status.

getQty()

getQty

(

)

Returns

int

Implemented in Status.

getStockId()

getStockId

(

)

Returns

int

Implemented in Status.

getStockItem()

getStockItem

(

)

Returns

\Magento\CatalogInventory\Api\Data\StockItemInterface

Implemented in Status.

getStockStatus()

getStockStatus

(

)

Returns

int

Implemented in Status.

setExtensionAttributes()

setExtensionAttributes

(

\Magento\CatalogInventory\Api\Data\StockStatusExtensionInterface

$extensionAttributes

)

Set an extension attributes object.

Parameters

\Magento\CatalogInventory\Api\Data\StockStatusExtensionInterface

$extensionAttributes

Returns

$this

Implemented in Status.

setProductId()

setProductId

(

$productId

)

Parameters

int

$productId

Returns

$this

Implemented in Status.

setQty()

setQty

(

$qty

)

Parameters

int

$qty

Returns

$this

Implemented in Status.

setStockId()

setStockId

(

$stockId

)

Parameters

int

$stockId

Returns

$this

Implemented in Status.

setStockStatus()

setStockStatus

(

$stockStatus

)

Parameters

int

$stockStatus

Returns

$this

Implemented in Status.

Field Documentation

PRODUCT_ID

const PRODUCT_ID = 'product_id'

#- #+ Stock status object data keys

Definition at line 32 of file StockStatusInterface.php.

QTY

const QTY = 'qty'

Definition at line 34 of file StockStatusInterface.php.

STATUS_IN_STOCK

const STATUS_IN_STOCK = 1

Definition at line 26 of file StockStatusInterface.php.

STATUS_OUT_OF_STOCK

const STATUS_OUT_OF_STOCK = 0

#+ Stock Status values.

Definition at line 24 of file StockStatusInterface.php.

STOCK_ID

const STOCK_ID = 'stock_id'

Definition at line 33 of file StockStatusInterface.php.

STOCK_ITEM

const STOCK_ITEM = 'stock_item'

Definition at line 36 of file StockStatusInterface.php.

STOCK_STATUS

const STOCK_STATUS = 'stock_status'

Definition at line 35 of file StockStatusInterface.php.

---

The documentation for this interface was generated from the following file:

• vendor/magento/module-catalog-inventory/Api/Data/StockStatusInterface.php