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 those contents 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
Order
VARIABLE NAME | DESCRIPTION | NOTIFICATIONS | TRACKING PAGE |
---|---|---|---|
order.email | Customer's email | All | Yes |
order.order_number | Order Number | All | Yes |
order.ordered_at | Order date, formatted depending on the destination country | All | Yes |
order.first_name | Customer's first name | All | Yes |
order.last_name | Customer's last name | All | Yes |
order.full_name | Customer's full name | All | Yes |
order.phone | Customer's phone number | All | Yes |
order.fulfillment_count | Number of fulfillments for this order | All | Yes |
order.tracker_count | Number of trackers for this order | All | Yes |
order.language_code | Customer's order language code | All | Yes |
order.order_datetime | Order date of the package in timestamp format | All | Yes |
order.current_datetime | Current 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...) | All | Yes |
order.custom_variables | Custom variables for order | All | Yes |
Shipping address
VARIABLE NAME | DESCRIPTION | NOTIFICATIONS | TRACKING PAGE |
---|---|---|---|
shipping_address.name | Shipping address full name | All | Yes |
shipping_address.first_name | Shipping address first name | All | Yes |
shipping_address.last_name | Shipping address last name | All | Yes |
shipping_address.company_title | Shipping address company name | All | Yes |
shipping_address.address1 | Shipping address street first line | All | Yes |
shipping_address.address2 | Shipping address street second line | All | Yes |
shipping_address.city | Shipping address city | All | Yes |
shipping_address.zip | Shipping address ZIP code | All | Yes |
shipping_address.country_code | Shipping address country code (2 letters ISO code) | All | Yes |
shipping_address.country | Shipping address full country name | All | Yes |
shipping_address.state_code | Shipping address state code (for countries with states, like the US) | All | Yes |
shipping_address.state | Shipping address full state name (for countries with states, like the US) | All | Yes |
shipping_address.display_address | All shipping address information. Newlines are marked with | All | Yes |
shipping_address.can_be_displayed | Boolean value indicating if shipping address' names, address1, city and zip are all present | All | Yes |
Shop
VARIABLE NAME | DESCRIPTION | NOTIFICATIONS | TRACKING PAGE |
---|---|---|---|
shop.name | Name of your shop (needs to be added in the settings) | All | Yes |
shop.phone | Support phone of your shop (needs to be added in the settings) | All | Yes |
shop.website_url | URL of your website (needs to be added in the settings) | All | Yes |
Carrier
VARIABLE NAME | DESCRIPTION | NOTIFICATIONS | TRACKING PAGE |
---|---|---|---|
carrier.name | Name of the shipping carrier | Not pre-shipment | Yes |
carrier.code | Code of the carrier. See full list | Not pre-shiment | Yes |
Carrier service
VARIABLE NAME | DESCRIPTION | NOTIFICATIONS | TRACKING PAGE |
---|---|---|---|
carrier_service.name | Name of the shipping carrier's service | Not pre-shipment | Yes |
carrier_service.code | Code of the carrier's service. See full list | Not pre-shipment | Yes |
Fulfillment
VARIABLE NAME | DESCRIPTION | NOTIFICATIONS | TRACKING PAGE |
---|---|---|---|
fulfillment.fulfillment_number | Fulfillment number | All | Yes |
fulfillment.warehouse_id | Identifier of the warehouse | All | Yes |
fulfillment.custom_variables | Fulfillment custom variables | All | Yes |
fulfillment.canceled_line_item? | Boolean value set to true if at least one of the item of the fulfillment is canceled | All | Yes |
Tracker
VARIABLE NAME | DESCRIPTION | NOTIFICATIONS | TRACKING PAGE |
---|---|---|---|
tracker.tracking_number | Tracking number of the shipped package | Not pre-shipment | Yes |
tracker.expedition_date | Expedition date of the package | Not pre-shipment | Yes |
tracker.expected_delivery_date | Expected delivery date of the package | Not pre-shipment | Yes |
tracker.order_shipment_rank | Shipment 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 yet | Not pre-shipment | Yes |
tracker.order_delivery_rank | Delivery 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 yet | Not pre-shipment | Yes |
tracker.pickup_changed | Boolean value set to true if pickup point has changed during the life of the tracker | Not pre-shipment | Yes |
tracker.untracked_carrier_name | Carrier 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. | Not pre-shipment | Yes |
tracker.tracking_link | Link 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. | Not pre-shipment | Yes |
tracker.expedition_datetime | Expedition date of the package in timestamp format | Not pre-shipment | Yes |
tracker.expected_delivery_datetime | Expected delivery date of the package in timestamp format | Not pre-shipment | Yes |
tracker.custom_variables | Tracker custom variables | Not pre-shipment | Yes |
Notifications
VARIABLE NAME | DESCRIPTION | NOTIFICATIONS | TRACKING PAGE |
---|---|---|---|
notification.same_notification_count | Counts the number of occurrences of this same notification for the source of the notification (will be 0 for the first occurrence) | All | No |
notification.tracking_link | 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 | All | No |
notification.cancel_sending | If this variable is rendered in the notification, the notification will not be sent | All | No |
SMS
VARIABLE NAME | DESCRIPTION | NOTIFICATIONS | TRACKING PAGE |
---|---|---|---|
short_tracking_url | Shortened 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 | No |
short_survey_url | Shortened URL of the delivery survey. Looks like https://shp.ai/xxxxxxx (22 characters) | SMS only | No |
Feedback
VARIABLE NAME | DESCRIPTION | NOTIFICATIONS | TRACKING PAGE |
---|---|---|---|
feedback.cancel_sending | If this variable is rendered in the notification, the notification will not be sent | Feedback | No |
feedback.satisfied | Boolean value saying if the user clicked on the satisfied logo or not | Feedback | No |
feedback.score | NPS filled up by the customer | Feedback | No |
feedback.scenario | Scenario chosen by the customer if any | Feedback | No |
feedback.sub_scenario | Sub-Scenario chosen by the customer if any | Feedback | No |
feedback.dissatisfied_reason | Concatenation of the scenario and the sub-scenario | Feedback | No |
feedback.city | Shipping address city | Feedback | No |
feedback.properties | Hash value with all feedback properties | Feedback | No |
feedback.free_text | Answer to the last question of the feedback | Feedback | No |
Updated about 1 month ago