Liquid variables

Overview

You can include dynamic variables in customizable contents across Shipup:

  • in your notification content and email templates
  • in the tracking page's promotional banners
  • in the link to your tracking page that will be included in your notifications

Those variables will be replaced by your store information when any of the above assets are generated. This store information can be data about your company, customers, or orders, including their delivery data.

Those variables can be included using the {{ variable_name }} syntax. If you want to dig deeper, the syntax used is the Liquid Markup Language.

Variable list

Here's a list of variables and their availability. For variable availability in notifications, please note that Shipup notifications have a source. The source represents the resource the notification was generated for. It can be an order, fulfillment, tracker or feedback.
For instance, the order placed notification source is an order, the delay in fulfillment production notification source is a fulfillment, and all shipping event notifications sources are trackers.

πŸ“˜

A good way to know if a variable is available when editing an asset is to rely on the auto-complete liquid suggestions displayed in the text field for this asset

Order

VARIABLE NAMEDESCRIPTIONNOTIFICATIONSTRACKING PAGE
order.emailCustomer's emailAllYes
order.order_numberOrder NumberAllYes
order.ordered_atOrder date, formatted depending on the destination countryAllYes
order.first_nameCustomer's first nameAllYes
order.last_nameCustomer's last nameAllYes
order.full_nameCustomer's full nameAllYes
order.phoneCustomer's phone numberAllYes
order.fulfillment_countNumber of fulfillments for this orderAllYes
order.tracker_countNumber of trackers for this orderAllYes
order.language_codeCustomer's order language codeAllYes
order.order_datetimeOrder date of the package in timestamp formatAllYes
order.current_datetimeCurrent timestamp (for notifications, this will be the time at which the notification is generated. For a tracking page link, the time at which it is accessed, etc...)AllYes
order.custom_variablesCustom variables for orderAllYes

Shipping address

VARIABLE NAMEDESCRIPTIONNOTIFICATIONSTRACKING PAGE
shipping_address.nameShipping address full nameAllYes
shipping_address.first_nameShipping address first nameAllYes
shipping_address.last_nameShipping address last nameAllYes
shipping_address.company_titleShipping address company nameAllYes
shipping_address.address1Shipping address street first lineAllYes
shipping_address.address2Shipping address street second lineAllYes
shipping_address.cityShipping address cityAllYes
shipping_address.zipShipping address ZIP codeAllYes
shipping_address.country_codeShipping address country code (2 letters ISO code)AllYes
shipping_address.countryShipping address full country nameAllYes
shipping_address.state_codeShipping address state code (for countries with states, like the US)AllYes
shipping_address.stateShipping address full state name (for countries with states, like the US)AllYes
shipping_address.display_addressAll shipping address information. Newlines are marked with
tags
AllYes
shipping_address.can_be_displayedBoolean value indicating if shipping address' names, address1, city and zip are all presentAllYes

Shop

VARIABLE NAMEDESCRIPTIONNOTIFICATIONSTRACKING PAGE
shop.nameName of your shop (needs to be added in the settings)AllYes
shop.phoneSupport phone of your shop (needs to be added in the settings)AllYes
shop.website_urlURL of your website (needs to be added in the settings)AllYes

Carrier

VARIABLE NAMEDESCRIPTIONNOTIFICATIONSTRACKING PAGE
carrier.nameName of the shipping carrierTracker onlyYes
carrier.codeCode of the carrier. See full listTracker onlyYes

Carrier service

VARIABLE NAMEDESCRIPTIONNOTIFICATIONSTRACKING PAGE
carrier_service.nameName of the shipping carrier's serviceTracker onlyYes
carrier_service.codeCode of the carrier's service. See full listTracker onlyYes

Fulfillment

VARIABLE NAMEDESCRIPTIONNOTIFICATIONSTRACKING PAGE
fulfillment.fulfillment_numberFulfillment numberTracker and fulfillmentYes
fulfillment.warehouse_idIdentifier of the warehouseTracker and fulfillmentYes
fulfillment.custom_variablesFulfillment custom variablesTracker and fulfillmentYes
fulfillment.canceled_line_item?Boolean value set to true if at least one of the item of the fulfillment is canceledTracker and fulfillmentYes

Tracker

VARIABLE NAMEDESCRIPTIONNOTIFICATIONSTRACKING PAGE
tracker.tracking_numberTracking number of the shipped packageTracker and fulfillmentYes
tracker.expedition_dateExpedition date of the packageTracker and fulfillmentYes
tracker.expected_delivery_dateExpected delivery date of the packageTracker and fulfillmentYes
tracker.order_shipment_rankShipment rank of the current tracker for its order. e.g., if one package is already shipped, this rank will be 2 for the 2nd package when shipped. Value is null if the package is not shipped yetTracker and fulfillmentYes
tracker.order_delivery_rankDelivery rank of the current tracker for its order. e.g., if one package is already delivered, this rank will be 2 for the 2nd package when delivered. Value is null if the package is not delivered yetTracker and fulfillmentYes
tracker.pickup_changedBoolean value set to true if pickup point has changed during the life of the trackerTracker and fulfillmentYes
tracker.untracked_carrier_nameCarrier name to be displayed as a fallback if Shipup can't find a matching carrier. This name is the carrier title raw value of your shop transmitted to Shipup.Tracker and fulfillmentYes
tracker.untracked_carrier_urlRaw link to the carrier's tracking page as received from your shop. Should only be used in very specific situations where Shipup doesn't know the package's carrier, e.g. for untracked packagesTracker and fulfillmentYes
tracker.tracking_linkLink to the package tracking on the carrier's website. If you're using Shipup's tracking page, this link should only be used when you want to bypass the Shipup tracking page and redirect your customer directly to the carrier's website. Not to be mistaken with notification.tracking_link which redirects either to the Shipup tracking page or the carrier's website.Tracker and fulfillmentYes
tracker.expedition_datetimeExpedition date of the package in timestamp formatTracker and fulfillmentYes
tracker.expected_delivery_datetimeExpected delivery date of the package in timestamp formatTracker and fulfillmentYes
tracker.custom_variablesTracker custom variablesTracker and fulfillmentYes

Notifications

VARIABLE NAMEDESCRIPTIONNOTIFICATIONSTRACKING PAGE
notification.same_notification_countCounts the number of occurrences of this same notification for the source of the notification (will be 0 for the first occurrence)Tracker and fulfillmentNo
notification.tracking_linkRedirects to either the Shipup tracking page or to the tracking page on the shipping carrier's website, depending on the option selected in your tracking page settingsTracker and fulfillmentNo
notification.cancel_sendingIf this variable is rendered in the notification, the notification will not be sentTracker and fulfillmentNo

SMS

VARIABLE NAMEDESCRIPTIONNOTIFICATIONSTRACKING PAGE
short_tracking_urlShortened URL version for the notification.tracking_link variable. Redirects to either the Shipup tracking page or to the tracking page on the shipping carrier's website, depending on the option selected in your tracking page settings. Looks like https://shp.ai/xxxxxxx (22 characters)SMS only, all sourcesNo
short_survey_urlShortened URL of the delivery survey. Looks like https://shp.ai/xxxxxxx (22 characters)SMS only, all sourcesNo

Feedback

VARIABLE NAMEDESCRIPTIONNOTIFICATIONSTRACKING PAGE
feedback.cancel_sendingIf this variable is rendered in the notification, the notification will not be sentFeedbackNo
feedback.satisfiedBoolean value saying if the user clicked on the satisfied logo or notFeedbackNo
feedback.scoreNPS filled up by the customerFeedbackNo
feedback.scenarioScenario chosen by the customer if anyFeedbackNo
feedback.sub_scenarioSub-Scenario chosen by the customer if anyFeedbackNo
feedback.dissatisfied_reasonConcatenation of the scenario and the sub-scenarioFeedbackNo
feedback.cityShipping address cityFeedbackNo
feedback.propertiesHash value with all feedback propertiesFeedbackNo
feedback.free_textAnswer to the last question of the feedbackFeedbackNo