ModelInventory module

Warehouse

A model in the Inventory module, with 15 members for templates, 12 API properties and 19 members for admin templates.

Inventory\Models\Frontend\Warehouse Inventory\Models\Api\Warehouse Inventory\Models\Backend\Warehouse Also in Inventory: Batch Fulfillment FulfillmentItem Stock Transaction
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 15

Take no arguments.

# getId()
?int
# getName()
?string
# getCode()
?string
# getExternalId()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getActive()
?DateTime
# isActive()
bool
Returns if the warehouse is active. Returns if the active date of the warehouse is set and arrived.
# getAddress()
?Address
# getSite()
?Site
# getDefaultPage()
?Page
# getStocks()
?Collection<Stock>
# 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 12

Read-only values on the record.

# id
?int
# name
?string
# code
?string
# externalId
?string
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# active
?DateTime
# active
bool
Returns if the warehouse is active. Returns if the active date of the warehouse is set and arrived.
# address
?Address
# site
?Site
# defaultPage
?Page
# stocks
?Collection<Stock>

Admin view

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

Properties 19

Take no arguments.

# getId()
?int
# getName()
?string
# getCode()
?string
# getExternalId()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getActive()
?DateTime
# isActive()
bool
Returns if the warehouse is active. Returns if the active date of the warehouse is set and arrived.
# getAddress()
Address
# getSite()
?Site
# getDefaultPage()
?Page
# getStocks()
?Collection<Stock>
# 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
# getEditUrl() Admin only
?string
Get the url for editing the record.
# getDeleteUrl() Admin only
?string
Get the url for deleting the record.
# getManageUrl() Admin only
?string
Get the url for managing records.