InventoryMovementInterface

Type

Interface

Namespace

craft\commerce\base

Implemented by

craft\commerce\base\InventoryMovement, craft\commerce\models\inventory\InventoryCommittedMovement, craft\commerce\models\inventory\InventoryFulfillMovement, craft\commerce\models\inventory\InventoryLocationDeactivatedMovement, craft\commerce\models\inventory\InventoryManualMovement, craft\commerce\models\inventory\InventoryRestockMovement, craft\commerce\models\inventory\InventoryTransferMovement

Since

5.0.0

Interface for the execution of inventory movement transactions to be executed.

View source

Public Methods

Method	Description
getFromInventoryLocation()
getFromInventoryTransactionType()
getInventoryItem()
getInventoryMovementHash()
getLineItemId()
getNote()
getQuantity()
getToInventoryLocation()
getToInventoryTransactionType()
getTransferId()
getUserId()
isValid()

getFromInventoryLocation()

View source

Returns

craft\commerce\models\InventoryLocation

getFromInventoryTransactionType()

View source

Returns

\craft\commerce\enums\InventoryTransactionType

getInventoryItem()

View source

Returns

craft\commerce\models\InventoryItem

getInventoryMovementHash()

View source

Returns

string

getLineItemId()

View source

Returns

integer, null

getNote()

View source

Returns

string, null

getQuantity()

View source

Returns

integer

getToInventoryLocation()

View source

Returns

craft\commerce\models\InventoryLocation

getToInventoryTransactionType()

View source

Returns

\craft\commerce\enums\InventoryTransactionType

getTransferId()

View source

Returns

integer, null

getUserId()

View source

Returns

integer, null

isValid()

View source

Returns

boolean