ModelInventory module

Stock

A model in the Inventory module, with 13 members for templates, 10 API properties and 13 members for admin templates.

Inventory\Models\Frontend\Stock Inventory\Models\Api\Stock Inventory\Models\Backend\Stock Also in Inventory: Batch Fulfillment FulfillmentItem Transaction Warehouse
View
What Smarty and Twig templates receive. Properties in REST API responses and job payloads. What admin screen templates receive when you override them.

Templates view

Properties 13

Take no arguments.

# getId()
?int
# getProductCode()
?string
# getAvailableQuantity()
?int
# getReservedQuantity()
?int
# getInTransitQuantity()
?int
# getOnHandQuantity()
?int
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getWarehouse()
?Warehouse
# getProduct()
?BaseProduct
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned

API & Jobs view

API & JobsEach property is a key in REST API responses and job payloads. Its name is the template getter without get, is or has. Methods that need arguments are not available here.

Properties 10

Read-only values on the record.

# id
?int
# productCode
?string
# availableQuantity
?int
# reservedQuantity
?int
# inTransitQuantity
?int
# onHandQuantity
?int
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# warehouse
?Warehouse
# product
?BaseProduct

Admin view

AdminAvailable in cdna-admin templates. Copy an admin template into your site repository to change how this record is edited.

Properties 13

Take no arguments.

# getId()
?int
# getProductCode()
?string
# getAvailableQuantity()
?int
# getReservedQuantity()
?int
# getInTransitQuantity()
?int
# getOnHandQuantity()
?int
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getWarehouse()
?Warehouse
# getProduct()
?BaseProduct
# isNewRecord() Not in API & Jobs
bool
Check if the record is a new record
# isHierarchicalModel() Not in API & Jobs
bool
Check whether a model is a hierarchical model, i.e. can have children
# isVersionedModel() Not in API & Jobs
bool
Check whether a model is versioned