ModelInventory module

Fulfillment

A model in the Inventory module, with 18 members for templates, 17 API properties and 20 members for admin templates.

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

Take no arguments.

# getStatusLabels()
array
Gets all available statuses with their labels
# getStatusDisplay()
string
Gets status display label
# getId()
?int
# getStatus()
?string
# getExternalId()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getDeliveryAddress()
?Address
# getWarehouse()
?Warehouse
# getOrder()
?BaseOrder
# getSelectedShippingRate()
?Rate
# getTransactions()
?Collection<Transaction>
# getShipments()
?Collection<Shipment>
# getShippingRates()
?Collection<Rate>
# getFulfillmentItems()
?Collection<FulfillmentItem>
# 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 17

Read-only values on the record.

# statusLabels
array
Gets all available statuses with their labels
# statusDisplay
string
Gets status display label
# editUrl Not in Templates
?string
Get the url for editing the record.
# id
?int
# status
?string
# externalId
?string
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# deliveryAddress
?Address
# warehouse
?Warehouse
# order
?BaseOrder
# selectedShippingRate
?Rate
# transactions
?Collection<Transaction>
# shipments
?Collection<Shipment>
# shippingRates
?Collection<Rate>
# fulfillmentItems
?Collection<FulfillmentItem>

Admin view

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

Properties 20

Take no arguments.

# getStatusLabels()
array
Gets all available statuses with their labels
# getStatusDisplay()
string
Gets status display label
# getEditUrl() Not in Templates
?string
Get the url for editing the record.
# getId()
?int
# getStatus()
?string
# getExternalId()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getDeliveryAddress()
?Address
# getWarehouse()
?Warehouse
# getOrder()
?BaseOrder
# getSelectedShippingRate()
?Rate
# getTransactions()
?Collection<Transaction>
# getShipments()
?Collection<Shipment>
# getShippingRates()
?Collection<Rate>
# getFulfillmentItems()
?Collection<FulfillmentItem>
# 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