Skip to main content

Introduction to Liquid in Shipmondo

How to use Liquid, custom tags, filters, and data objects in Shipmondo.

Shipmondo’s design engine is based on the technologies HTML and Liquid. These are the languages used in, for example, the Shipmondo Document Designer.

In this guide, you’ll find a link to the Liquid documentation as well as an overview of Shipmondo’s custom tags, filters, and the available data objects and properties.

What is Liquid?

Liquid is a flexible templating language developed by Shopify, used to structure and generate dynamic content as well as access data objects in Shipmondo.

With a syntax based on tags, filters, and variables, Liquid makes it possible to build logic directly into HTML.

In Shipmondo, we support all functions, tags, and filters described in the Liquid documentation: https://shopify.github.io/liquid/.

Custom Liquid tags

We have developed a number of Shipmondo-specific tags.

1. image

If you want to add an image, you can use the image tag.

The following resources are available:

Optional parameters:

Parameter

Description

height

Specifies the height of the image

width

Specifies the width of the image

Example (without optional parameters):

{% image item_line %}

Example (with optional parameters):

{% image order_integration, height: 35, width: 200 %}

2. barcode

If you want to generate a barcode, you can use the barcode tag.

It can, for example, be used if you want to add a barcode for finding or completing an order when the barcode is scanned.

Optional parameters:

Parameter

Description

height

Specifies the height of the barcode

xdim

Specifies the horizontal thickness (the width of the bars)

margin

Specifies the margin around the barcode

background

Specifies the background color

Example (with optional parameters):

{% barcode "270000000123", height: 35, xdim: 1.6, margin: 1, background "white" %}

3. qr_code

If you want to generate a QR code, you can use the qr_code tag.

It can, for example, be used if you want to create a shortcut to your website or return portal.

Optional parameters:

Parameter

Description

xdim

Specifies the horizontal diameter

margin

Specifies the margin around the QR code

background

Specifies the background color

Example (with optional parameters):

{% qr_code "270000000123", xdim: 2.5, margin: 1, background "white" %}

Custom Liquid filters

We have also developed a number of Shipmondo-specific filters that you can use:

1. translation

With our translation tool, you can use the translation tag to retrieve the correct translation of a key.

The translation is retrieved based on the following:

  1. If you use Shopify, the translation is fetched in the language in which the order was placed.

  2. The recipient country’s language, if the language is enabled under Translations.

  3. The primary language selected and enabled under Translations.

Example:

{{ "order_no" | translate }}

2. format_currency

If you want to specify a specific currency code after the amount. Note that amounts are not converted.

Example:

{{ item_line.unit_price | format_currency: "DKK" }}

Result (example):

200,00 DKK

Data objects and properties

Data objects and access

The following data objects are available in documents and messages:

Data object

Access for resources

document

packing slip, pick list, order

order_integration

packing slip, pick list, and order-related personalized messages

fulfillment

packing slip and certain order-related personalized messages

order

packing slip, pick list and order-related personalized messages

pick_path

pick path list

invoice

invoice and credit note personalized messages

Properties

Overview of properties with data examples.

1. document

Object

Description

document

The current document

source

Example:

"document": {
"format": "a4",
"source": null
}

2. order_integration

Object

Description

order_integration

The associated integration

Example:

"order_integration": {
"id": null
}

3. fulfillment

Object

Description

fulfillment

The specific fulfillment for an order

fulfillment.code

The fulfillment code

fulfillment.box_number

Picking box number

fulfillment.item_count

Number of items

fulfillment.shipment

The shipment created for the fulfillment

fulfillment.item_lines

The item lines for the created fulfillment. They are sorted according to the user’s picking settings

Example:

"fulfillment": {
"code": "1001-1",
"box_number": 1,
"shipment": {
"product_name": "Service point",
"carrier_name": "PostNord",
"carrier_code": "pdk"
},
"item_lines": [
{
"item_line_id": null,
"sku": "TS001-WH",
"name": "T-Shirt",
"quantity": 1,
"shipped_quantity": 1,
"bin": "AB-001",
"unit_price": 200,
"vat_percentage": 25,
"weight": 500,
"unfulfilled_quantity": 1,
"custom_product_data": [
"Large",
"Box fit"
],
"variant_code": "White",
"barcode": null,
"currency_code": "DKK"
}
]
}

4. order

Object

Description

order

The associated order

order.id

The order’s ID

order.number

The order’s number in the webshop system

order.shipment_template

The currently associated shipment template

order.assigned_to

The employee assigned to the order

order.item_count

Number of items

order.unfulfilled_item_count

Number of items that have not been shipped

order.item_lines

The order’s item lines. They are sorted according to the user’s picking settings

order.shipping_lines

Shipping lines

order.discount_lines

The order’s discount lines

order.gift_card_lines

Gift card lines

order.payment_fee_lines

Fee lines

order.duty_lines

Duty lines

order.sender

Sender

order.ship_to

Recipient

order.bill_to

Billing (customer)

order.barcodes

Barcodes used to perform various actions

order.is_returning_customer

Indicates whether the customer was a returning customer when the order was placed (true/false)

order.shipping_method

The name of the order’s shipping method, as sent by the webshop

order.shipping_method_code

The code of the order’s shipping method, as sent by the webshop

order.payment_method

The name of the order’s payment method, as sent by the webshop

order.payment_method_code

The code of the order’s payment method, as sent by the webshop

order.reference

Reference

order.customer_reference

Customer reference

order.note

Note

order.ordered_at

Time of purchase

order.tags

Tags from the webshop system

Example:

"order": {
"id": null,
"number": "1001",
"ordered_date": "2025-11-11T11:12:54.000+01:00",
"tags": [],
"note": "This is a note",
"customer_reference": "Please deliver between 9am-5pm",
"item_count": 5,
"is_returning_customer": true,
"shipping_method": "Service point",
"payment_method": "Card payment",
"shipping_method_code": "service_point",
"payment_method_code": "card",
"shipment_template": {
"product_name": "MyPack Home",
"carrier_name": "PostNord (DK)",
"carrier_code": "pdk"
},
"assigned_to": {
"name": "John Doe"
},
"item_lines": [
{
"id": null,
"sku": "TS001-WH",
"name": "T-Shirt",
"quantity": 1,
"shipped_quantity": 0,
"bin": "AB-001",
"image_url": "http://example.com/image",
"unit_price": "200.0",
"vat_percentage": "25.0",
"weight": 500,
"unfulfilled_quantity": 1,
"custom_product_data": [
"Large",
"Box fit"
],
"variant_code": "White",
"barcode": null,
"currency_code": "DKK",
"item_line_id": null
}
],
"discount_lines": [
{
"name": "SUMMER10",
"quantity": 1,
"unit_price": -20.0,
"vat_percentage": 25.0,
"currency_code": "DKK"
}
],
"sender": {
"name": "My Company ApS",
"address1": "Strandvejen 6B",
"address2": null,
"zipcode": "5240",
"city": "Odense NØ",
"email": "info@minvirksomhed.dk",
"mobile": "70400407",
"country": {
"code": "DK",
"name": "Denmark"
}
},
"ship_to": {
"name": "My Company ApS",
"attention": "Lene Hansen",
"address1": "Skibhusvej 52",
"address2": null,
"zipcode": "5000",
"city": "Odense C",
"email": "lene@email.dk",
"mobile": "12345678",
"country": {
"code": "DK",
"name": "Denmark"
}
},
"bill_to": {
"name": "My Company ApS",
"attention": "Lene Hansen",
"address1": "Skibhusvej 52",
"address2": null,
"zipcode": "5000",
"city": "Odense C",
"email": "lene@email.dk",
"mobile": "12345678",
"country": {
"code": "DK",
"name": "Denmark"
}
},
"barcodes": {
"complete_pick": "27100000000000",
"find_order": "27170000000000"
}
}

New and returning customers

With order.is_returning_customer, you can show different content depending on whether the customer is ordering for the first time or has ordered before. For example, you can welcome new customers or thank returning customers.

Example:

{% if order.is_returning_customer %}Welcome back!{% else %}Thank you for your first order!{% endif %}

Please note:

  • The value shows whether the customer was a returning customer when the order was placed. If you reprint a packing slip for a customer's first order, it will still show them as a new customer.

  • Orders without an associated customer always count as not returning.

  • The variable is not available on the pick path list (pick_path), as it does not contain order information.

  • The preview in the Document Designer always shows the returning customer version.

Discounts

With order.discount_lines, you can show the discounts the customer received, for example on the packing slip. Each discount line has a name, quantity, amount excl. VAT, VAT rate, and currency.

Please note:

  • The name is what the webshop sends with the order, for example the discount code "SUMMER10". If the line has no name, "Rabat" or "Discount" is shown, depending on the language.

  • Discount lines are not added to existing templates automatically. You need to add them yourself.

  • In the Document Designer preview, the sample data includes a discount line, so you can test your template.

5. pick_path

Object

Description

pick_path

The associated pick path

pick_path.item_lines

The item lines for all orders. They are sorted according to the user’s picking settings

pick_path.created_by_user_name

The name of the person who created the pick path

Example:

"pick_path": {
"id": null,
"created_by_user_name": "",
"item_lines": [
{
"sku": "TS001-WH",
"name": "T-Shirt",
"quantity": 1,
"shipped_quantity": 0,
"bin": "AB-001",
"image_url": "http://example.com/image",
"unit_price": "0.0",
"vat_percentage": "25.0",
"weight": 500,
"unfulfilled_quantity": 1,
"custom_product_data": [
"Large",
"Box fit"
],
"variant_code": "White",
"barcode": null,
"order_number": "1001",
"box_number": 1
}
]
}

6. invoice

Object

Description

invoice

The associated invoice or credit note

invoice.id

The ID of the invoice or credit note

invoice.number

The invoice number

invoice.invoiced_date

Invoice date

invoice.bill_to

Billing address

invoice.sender

Sender

invoice.payment_method

The name of the payment method, as sent by the webshop

invoice.payment_method_code

The code of the payment method, as sent by the webshop

Example:

"invoice": {
"bill_to": {
"address1": "Skibhusvej 52",
"address2": null,
"attention": "Lene Hansen",
"city": "Odense C",
"country": {
"code": "DK",
"name": "Denmark"
},
"email": "lene@email.dk",
"mobile": "12345678",
"name": "My Company ApS",
"zipcode": "5000"
},
"invoiced_date": "2025-11-11T11:12:54.000+01:00",
"item_lines": [
{
"barcode": "1234567890123",
"bin": "AB-001",
"currency_code": "DKK",
"custom_product_data": ["Large", "Box fit"],
"image_url": "http://example.com/image",
"item_line_id": -1,
"name": "T-Shirt",
"quantity": 1,
"shipped_quantity": 0,
"sku": "TS001-WH",
"unfulfilled_quantity": 1,
"unit_price": "200.0",
"variant_code": "White",
"vat_percentage": "25.0",
"weight": 500
}
],
"number": "8001",
"payment_method": "Card payment",
"payment_method_code": "card",
"sender": {
"address1": "Strandvejen 6B",
"address2": null,
"city": "Odense NØ",
"country": {
"code": "DK",
"name": "Denmark"
},
"email": "info@minvirksomhed.dk",
"mobile": "70400407",
"name": "My Company ApS",
"zipcode": "5240"
}
}
Did this answer your question?