Shipup

Notification variables

Overview


You can include many variables in your email and SMS notifications that will be replaced by your store information when the notification is generated. This store information can be data about your company, the customer or the shipping carrier.

Those variables can be included in your notifications 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 available in all notifications.

VARIABLE NAME

DESCRIPTION

order.email

Customer's email

order.order_number

Order number

order.order_date

Order date, formatted depending on the destination country

order.first_name

Customer's first name

order.last_name

Customer's last name

order.full_name

Customer's full name. Will consist of only last name or first name if the other one is missing

order.phone

Customer's phone number

order.fulfillment_count

Count of fulfillments for this order

order.tracker_count

Count of trackers for this order

order.language_code

Customer's order language code

shipping_address.name

Shipping address full name

shipping_address.first_name

Shipping address first name

shipping_address.last_name

Shipping address last name

shipping_address.company_title

Shipping address company name

shipping_address.address1
shipping_address.address2

Shipping address street

shipping_address.city

Shipping address city

shipping_address.zip

Shipping address zip code

shipping_address.country_code

Shipping address country code (2 letters ISO code)

shipping_address.country

Shipping address country

shipping_address.state_code

Shipping address state code for countries with states like the US

shipping_address.state

Shipping address state for countries with states like the US

shipping_address.display_address

All shipping address information. Newlines are marked with <br> tags

shipping_address.can_be_displayed

Boolean value indicating if shipping address' names, address1, city and zip are all present

company.name

Name of your company (needs to be added in the settings)

company.phone

Support phone of your company (needs to be added in the settings)

company.website_url

Url of your website (needs to be added in settings)

Those variables can only be used in notifications related to a shipment. Do not use them in Pre Shipment notifications.

VARIABLE NAME

DESCRIPTION

carrier.name

Name of the shipping carrier

carrier.code

Code of the carrier. List of carrier codes are available here

tracker.tracking_number

Tracking number of the shipped package

tracker.expedition_date

Expedition date of the package

tracker.expected_delivery_date

Expected delivery date of the package

tracker.tracking_link

Link to the package tracking on the carrier's website.

If you're using Shipup's tracking page, this should only be used when you want to bypass the tracking page and redirect your customer directly on the carrier's website.

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

tracker.pickup_changed

Boolean value set to true if pickup point has changed during the life of the tracker

Those variables can only be used in SMS notifications

VARIABLE NAME

DESCRIPTION

short_tracking_url

SMS Only
Shortened URL of the tracking link. The customer will be redirected to the tracking page on the shipping carrier website upon clicking.
Looks like https://shp.ai/xxxxxxx (22 characters)

short_survey_url

SMS only
Shortened URL of the delivery survey.

Looks like https://shp.ai/xxxxxxx (22 characters)

Those variables can be used to handle time. They are expressed in UNIX timestamps (seconds since 1970) and can thus be used to do comparisons.

VARIABLE NAME

DESCRIPTION

tracker.expedition_datetime

Expedition date of the package in timestamp format

tracker.expected_delivery_datetime

Expected delivery date of the package in timestamp format

order.order_datetime

Order date of the package in timestamp format

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...)

Those are special variables that can be used for specific behaviors using customized logic with the liquid syntax.

VARIABLE NAME

DESCRIPTION

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)

notification.cancel_sending

If this variable is rendered in the notification, the notification will not be sent

notification.tracking_link

Link to the package tracking on Shipup tracking page. If the tracking page is hosted in our website the link will redirect to the tracking page on your website.

Custom variables


In addition to the variable list, Shipup allows "custom" fields to be used. Those fields allow you to add order-based information in your notifications, such as unique promo codes or product references.

To use those fields, you must first send them to Shipup when you import your orders into Shipup, using the "custom_variables" field. Please note that this will only be possible if you're using our API or FTP integration.

The syntax to include them in your notifications is:

{{ entity.custom_variables.custom_attribute }}

Where entity can be either order, fulfillment, line_item or tracker and custom_attribute is the name of your attribute.

Example: {{ order.custom_variables.is_gift }}

Updated about a month ago


Notification variables


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.