Appearance
Variable reference
WISMOlabs uses Liquid templating to enable dynamic content in notifications and tracking pages. The platform provides a range of case-sensitive variables (tokens or parameters) to personalize communication.
Note: WISMOlabs variables are in camelCase, while many third-party API submissions, including shopping platform parameters, are available in UPPERCASE for ease of use and visual differentiation, making it simpler for developers to distinguish between the two.
Below is a detailed overview of the available variables categorized by the data they represent.
Metadata Variables
Metadata refers to general information about the retailer and the tracking page.
| Variable | Description |
|---|---|
{{metadata.slug}} | The unique identifier for the retailer's tracking page. |
{{metadata.retailerCompanyName}} | The name of the retailer. |
{{metadata.retailerWebsite}} | The website URL of the retailer. |
{{metadata.trackingPage}} | The URL of the tracking page, including all of the query parameters,structured with key-value pairs appended after a question mark (?) and separated by an ampersand (&). |
{{metadata.shortLink}} | A shortened version of the tracking page link. |
Customer Variables
These variables provide details about the customer.
| Variable | Description |
|---|---|
{{customer.firstName}} | The customer's first name. |
{{customer.email}} | The customer's email address. |
{{customer.phone}} | The customer's phone number. |
{{customer.address.postalCode}} | The postal code for the customer's address. |
{{customer.address.countryCode}} | The ISO 3166 country codes for the customer's address. |
Order Details Variables
These represent specific order-related data.
| Variable | Description |
|---|---|
{{orderDetails.orderNumber}} | The order number associated with the shipment. |
{{orderDetails.PID}} | A unique product identifier(s). |
{{orderDetails.CID}} | A unique customer identifier(s). |
{{orderDetails.TAG}} | An optional tag(s) associated with the shipment. |
note: PID, CID and TAG in orderDetails can be represented as a single value ("PID": "one") or multiple values ("PID": ["one", "two", "three"]).
Shipment Variables
Shipment-related data, including tracking numbers and carrier information.
| Variable | Description |
|---|---|
{{shipment.trackingNumber}} | The tracking number for the shipment. |
{{shipment.carrierId}} | The identifier for the shipping carrier. |
{{shipment.carrierName}} | The name of the carrier responsible for the shipment. |
{{shipment.carrierTrackingPage}} | The carrier's tracking page URL. |
Nested inside of shipment node, there is a dates, shippedFrom, and shippedTo branches.
dates
Key dates related to the shipment, including when it was ordered, shipped, and delivered.
| Variable | Description |
|---|---|
{{shipment.dates.orderDate}} | The date when the order was placed in ISO 8601 format YYYY/MM/DD HH:MM:SS. |
{{shipment.dates.shippedDate}} | The date when the order was shipped in ISO 8601 format YYYY/MM/DD HH:MM:SS. |
{{shipment.dates.deliveredDate}} | The delivery date of the shipment in ISO 8601 format YYYY/MM/DD HH:MM:SS. |
{{shipment.dates.eta}} | Estimated time of arrival in ISO 8601 format YYYY/MM/DD HH:MM:SS. |
{{shipment.dates.etaSource}} | The source of the ETA data abbreviation (TRK - Tracking API, TIT - Time in Transit, etc) |
shippedFrom
| Variable | Description |
|---|---|
{{shipment.shippedFrom.address1}}, , {{shipment.shippedFrom.address2}} | Shipping from address lines. |
{{shipment.shippedFrom.city}} | City. |
{{shipment.shippedFrom.countryCode}} | The country code of shipment origin. See list of ISO 3166 country codes here. |
{{shipment.shippedFrom.postalCode}} | ZIP or postal code. |
shippedTo
| Variable | Description |
|---|---|
{{shipment.shippedTo.postalCode}} | Shipping from address lines |
{{shipment.shippedTo.countryCode}} | The ISO 3166 country codes. |
Location Variables
These are used to display the shipment's location updates.
| Variable | Description |
|---|---|
{{location.id}} | A unique identifier for the location. |
{{location.type}} | The type of location (e.g., "origin", "destination"). |
{{location.long}}, {{location.lat}} | Longitude and latitude coordinates. |
Tracking and Tracking Activity Variables
Nested inside tracking the shipmentStatus branch these variables provide details shipment current status and on each update in the shipment's tracking history.
tracking
The tracking branch contains information about the most recent status of the shipment.
| Variable | Description |
|---|---|
{{tracking.shipmentStatus.status}} | Single letter status code of the shipment. |
{{tracking.shipmentStatus.statusName}} | Short status name, e.g. shipped, out for delivery, etc.. |
{{tracking.shipmentStatus.statusDescription}} | Status description as provided by carrier. |
{{tracking.shipmentStatus.statusSummary}} | Optional status summary as provided by selected carriers. |
{{tracking.shipmentStatus.lastStatusDate}} | The date of the last event retrieved from the carrier. |
Nested inside tracking the activity branch contains event history.
activity
The activity section is an array of objects, where each object represents a tracking event, with details for each event serving as a snapshot of the shipment's progress. The events are sorted from the most recent (index 0) to the least recent, showing the chronological order of the shipment's activity.
| Variable | Description |
|---|---|
{{tracking.activity.id}} | A unique identifier for the activity event. |
{{tracking.activity.status}} | The single letter status code of the shipment. |
{{tracking.activity.statusName}} | Short status name, e.g. shipped, out for delivery, etc.. |
{{tracking.activity.statusDescription}} | The date the activity occurred. |
{{tracking.activity.city}} | The city where the activity took place. |
{{tracking.activity.state}} | The state or province where the activity took place. |
{{tracking.activity.countryCode}} | The country code where the activity took place. |
{{tracking.activity.zip}} | The zip or postal code where the activity took place. |