ModelShipping module

Shipment

A model in the Shipping module, with 14 members for templates, 11 API properties and 14 members for admin templates.

Shipping\Models\Frontend\Shipment Shipping\Models\Api\Shipment Shipping\Models\Backend\Shipment Also in Shipping: BaseMethod Category Group Location MethodZoneRule Rate ShipmentLog TemplateMethod Zone
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 14

Take no arguments.

# getId()
?int
# getTotal()
?string
# getTrackingCode()
?string
# getTrackingUrl()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getCurrency()
?Currency
# getFulfillment()
?Fulfillment
# getMethod()
?BaseMethod
# getLogs()
?Collection<ShipmentLog>
# getExternalId()
?string
# 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 11

Read-only values on the record.

# id
?int
# total
?string
# trackingCode
?string
# trackingUrl
?string
# created
?DateTime
Date the record was created.
# modified
?DateTime
Last modification date for the record.
# currency
?Currency
# fulfillment
?Fulfillment
# method
?BaseMethod
# externalId
?string

Admin view

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

Properties 14

Take no arguments.

# getId()
?int
# getTotal()
?string
# getTrackingCode()
?string
# getTrackingUrl()
?string
# getCreated()
?DateTime
Date the record was created.
# getModified()
?DateTime
Last modification date for the record.
# getCurrency()
?Currency
# getFulfillment()
?Fulfillment
# getMethod()
?BaseMethod
# getLogs()
?Collection<ShipmentLog>
# getExternalId()
?string
# 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