ModelShipping module

Shipment

A model in the Shipping module, with 18 members for templates, 15 API properties and 19 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 18

Take no arguments.

# getCreatedBy()
?User
Hidden on the storefront: the admin user who added the shipment is not the customer's business
# getTotalAsMoney()
Money
Gets the total as a Money object. Represents what the parcel cost to send, excluding tax, in the shipment's currency. The cost defaults to the total of the rate the customer chose, which excludes tax (Rate::getTotalAsMoney()), and an admin may enter another. It records what the parcel cost and is not charged to the customer: neither the order's nor the fulfillment's totals include it.
# getSafeTrackingUrl()
?string
The tracking URL when it is a web address, safe to render as a link; null otherwise The shipment service only accepts http and https addresses, but rows written by other paths are not trusted to have gone through it.
# getLatestLog()
?ShipmentLog
The shipment's most recent tracking event
# 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 15

Read-only values on the record.

# totalAsMoney
Money
Gets the total as a Money object. Represents what the parcel cost to send, excluding tax, in the shipment's currency. The cost defaults to the total of the rate the customer chose, which excludes tax (Rate::getTotalAsMoney()), and an admin may enter another. It records what the parcel cost and is not charged to the customer: neither the order's nor the fulfillment's totals include it.
# safeTrackingUrl
?string
The tracking URL when it is a web address, safe to render as a link; null otherwise The shipment service only accepts http and https addresses, but rows written by other paths are not trusted to have gone through it.
# latestLog
?ShipmentLog
The shipment's most recent tracking event
# 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
# createdBy
?User
# 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 19

Take no arguments.

# getTotalAsMoney()
Money
Gets the total as a Money object. Represents what the parcel cost to send, excluding tax, in the shipment's currency. The cost defaults to the total of the rate the customer chose, which excludes tax (Rate::getTotalAsMoney()), and an admin may enter another. It records what the parcel cost and is not charged to the customer: neither the order's nor the fulfillment's totals include it.
# getSafeTrackingUrl()
?string
The tracking URL when it is a web address, safe to render as a link; null otherwise The shipment service only accepts http and https addresses, but rows written by other paths are not trusted to have gone through it.
# getLatestLog()
?ShipmentLog
The shipment's most recent tracking event
# 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>
# getCreatedBy()
?User
# 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
# getLogsNewestFirst() Admin only
array
The tracking events, newest first