You can customize your Packing Slips and other templates. RyderShip uses liquid markup to allow access to some Order variables and logic, along with standard HTML and CSS.

For an overview of templates, see Templates for details.

In this article:

Best practices & important notes
RyderShip Liquid Objects

Adding item images to packing slips
Liquid reference
Output
Tags
For loops
Variable assignment

Best practices & important notes

Templates should be valid HTML documents.
If you make changes to the barcode in the template, ( {{order.barcode}} ), they will be reverted manually. Additionally, the order barcode CSS should not be overridden.
Templates should include CSS directly in the <head> or should link to an externally hosted stylesheet.
Aside from your logo, other images should be hosted externally and reference using absolute links.
It is recommended that all external files are available via both HTTP and HTTPS, and are referenced. For example: //your-external-asset.jpg (i.e. without specifying a protocol).
Custom templates are built with HTML and CSS. If you have that experience available, you can create your own.
Some of our customers with no HTML / CSS experience are having success with AI tools building them.
The RyderShip team cannot assist with template customization, unless you contract with us via a Statement of Work.
If you use externally referenced files in your template and these files become unavailable, they will be silently omitted from the template, allowing orders to continue to flow unimpeded.

A few important notes about custom templates:

If you contract with RyderShip Tech to create custom templates for you, RyderShip will only support a one-time setup of the templates.

RyderShip is not responsible for ongoing maintenance or breaking changes that may be introduced post go-live. Any additional support would need to be quoted in a new SOW.
Templates are only stored in the customer template section of RyderShip. We do not add it to our codebase or source control.

If a customer inadvertently edits or deletes a custom template, it does not exist elsewhere for recovery. If this happens, a new SOW would need to be agreed upon to fix or recreate.

Previewing

As you work, you may want to Preview the results. We'll pick a few recent Orders to choose from. If you want to see a particular Order or Package previewed, paste its unique ID in the URL:

RyderShip Liquid Objects

RyderShip Liquid Objects are referenced:

 {{order.number}}, {{customer.logo}}, {{order_item.sku}}

Specific Wholesale Order and Wholesale Item sections are below.

Order

id - the RyderShip Order id
number - the incoming Order number
barcode - order barcode
status - order status
created_at - when the order was added to RyderShip
updated_at - when the order was last updated in RyderShip
date - short format Order date
shipping_address - you can grab the Shipping Address all at once

ship_method - order full Shipping Method name

using {{ order.ship_method | replace:'Whiplash','' }} will remove the word "Whiplash" from some utility shipping methods.

shipping_carrier - order Shipping Carrier
shipping_service - order Shipping Service
order_items - the individual items in an order (see below for order item methods)
total - total order cost
ship_price - shipping cost
grand_total - order cost + shipping cost
paid - amount paid
balance - remaining balance
notes - any additional order notes
notes? - check if there are order notes
ship_notes - some Shopify orders have the gift notes here instead of notes
ship_notes? - check if there are ship notes
return_url - URL to web-based return/exchange form
domestic? - is this order domestic?
international? - is this order international?
greeting - attempts to return the shipping first name; falls back to "Friend"
tracking_numbers - an array of tracking numbers
tracking_link - the first or only tracking link for an order
tracking_links - a comma separated list of hyperlinked tracking numbers
billing_name
billing_street1
billing_street2
billing_city
billing_state
billing_state_abbr
billing_country
billing_zip
billing_phone
shipping_name
shipping_street1
shipping_street2
shipping_city
shipping_state
shipping_state_abbr
- shipping_country
shipping_zip
shipping_phone

Wholesale Order

* cancel_date - wholesale order cancel date
* carrier_code - wholesale order carrier code
* carrier_service - wholesale order carrier service value
* department - wholesale order department
* department_description - wholesale order department description
* distribution_center - wholesale order distribution center value
* fob_code - wholesale order fob code
* fob_location_description - wholesale order fob location description
* fob_location_qualifier - wholesale order fob location qualifier
* gift_note - wholesale order gift note
* location - wholesale order location value
* merchandise_type_code - wholesale order merchandise type code
* partner - wholesale order partner value
* po_number - wholesale order purchase order ID
* sender - wholesale order sender value
* start_date - wholesale order start date
* vendor - wholesale order vendor value
* vendor_number - wholesale order vendor ID
* store - wholesale order store value
* division - wholesale order division value
* customer_account_number - wholesale order customer account ID
* sort_code - wholesale order sort code
* group - wholesale order group value
* seller_name - wholesale order seller name
* reference - wholesale order reference value

Example:

{{order.wholesale_po_number}}
{{order.wholesale_sender}}
{{order.wholesale_start_date}}

Order Item

sku - item SKU
quantity - how many were ordered
weight - item weight
price - item price
total - quantity x price
description - item description

image_originator - item picture
Applies to customers with customized templates and requires an image_originator_url in the item, using image_originator_protocol = HTTPS.

Note: Customers are required to add custom code to their packingslip template.

<td> class="item_row left">
{% if order_item.item.image_originator_url %}
{{order_item.item.image_originator_url}}
{% endif %}

See the Adding image items to packing slips section for more details.

Wholesale Item

line_no - wholesale item line ID
item alias - wholesale item alternate name
item_color - wholesale item color
item_size - wholesale item size
vendor_part_number - wholesale item manufacturer/vendor part number
buyer_part_number - wholesale item customer/buyer part number
consumer_package_code - wholesale item consumer package code
outer_pack_value - wholesale item outer pack's dollar value
inner_pack_value - wholesale item inner pack's dollar value
size_description - wholesale item size description
color_description - wholesale item color description
upc - wholesale item upc value
description - wholesale item description
style - wholesale item style
ean - wholesale item ean value
alternate_item_number - wholesale item alternate item ID
alternate_barcode - wholesale item alternate barcode value
alternate_sku - wholesale item alternate SKU
lot - wholesale item lot number
ih_category - wholesale item ih category

Example:

{{order_item.item.wholesale_item.item_color}}
{{order_item.item.wholesale_item.item_size}}

Customer

name - customer name
logo - customer logo image
logo_url - logo image URL, if you'd like to use your own image tag or CSS
logo? - check if there is a customer logo uploaded

Warehouse

name - the name of the warehouse
shipping_address_1
shipping_address_2
shipping_city
shipping_state
shipping_zip - the postal code of the warehouse
shipping_country - the full name of the country, like "United States"
shipping_country_iso2 - the iso2 code for the country, like "US"

Adding item images to packing slips

This process applies to customers who have customized packingslip templates and requires an image_originator_url in the item. The image_originator_protocol must be HTTPS so the images can display on the packingslip. We cannot guarantee that http protocol will work in the packingslip pdf.

This feature does not apply to the default packingslip template.

You can add images to your packing slips by adding the following code to your custom packingslip template:

<td> class="item_row left">
{% if order_item.item.image_originator_url %}
{{order_item.item.image_originator_url}}
{% endif %}

Example of a packing slip with images:

Liquid reference

There are two types of markup in Liquid: Output and Tag.

Output markup (which may resolve to text) is surrounded by:

{{ matched pairs of curly brackets (ie, braces) }}

Tag markup (which cannot resolve to text) is surrounded by:

{% matched pairs of curly brackets and percent signs %}

Output

Here is a simple example of Output:

Hello {{name}}
Hello {{user.name}}
Hello {{ 'tobi' }}

Advanced Output: Filters

Output markup takes filters. Filters are simple methods. The first parameter is always the output of the left side of the filter. The return value of the filter will be the new left value when the next filter is run. When there are no more filters, the template will receive the resulting string.

Hello {{ 'tobi' | upcase }}
Hello tobi has {{ 'tobi' | size }} letters!
Hello {{ '*tobi*' | textilize | upcase }}
Hello {{ 'now' | date: "%Y %h" }}

Standard Filters

date - reformat a date
capitalize - capitalize words in the input sentence
downcase - convert an input string to lowercase
upcase - convert an input string to uppercase
first - get the first element of the passed in array
last - get the last element of the passed in array
join - join elements of the array with certain character between them
sort - sort elements of the array
map - map/collect an array on a given property
size - return the size of an array or string
escape - escape a string
escape_once - returns an escaped version of html without affecting existing escaped entities
strip_html - strip html from string
strip_newlines - strip all newlines (\n) from string
newline_to_br - replace each newline (\n) with html break
replace - replace each occurrence e.g.
- {{ 'foofoo' | replace:'foo','bar' }} #=> 'barbar'
replace_first - replace the first occurrence e.g.
- {{ 'barbar' | replace_first:'bar','foo' }} #=> 'foobar'
remove - remove each occurrence e.g.
- {{ 'foobarfoobar' | remove:'foo' }} #=> 'barbar'
remove_first - remove the first occurrence e.g.
- {{ 'barbar' | remove_first:'bar' }} #=> 'bar'
truncate - truncate a string down to x characters
truncatewords - truncate a string down to x words
prepend - prepend a string e.g.
- {{ 'bar' | prepend:'foo' }} #=> 'foobar'
append - append a string e.g.
- {{ 'foo' | append:'bar' }} #=> 'foobar'
minus - subtraction e.g.
- {{ 4 | minus:2 }} #=> 2
plus - addition e.g.
- {{ '1' | plus:'1' }} #=> '11',
- {{ 1 | plus:1 }} #=> 2
times - multiplication e.g
- {{ 5 | times:4 }} #=> 20
divided_by - division e.g.
- {{ 10 | divided_by:2 }} #=> 5
split - split a string on a matching pattern e.g.
- {{ "a~b" | split:"~" }} #=> ['a','b']
modulo - remainder, e.g.
- {{ 3 | modulo:2 }} #=> 1

Meta Fields

You can add arbitrary Meta Key/Meta Value pairs (more information is available here). Call them individually like this:

{{ order.meta_values | where: "key", "notecard_text" | map: "value" }}

Full code to generate the screenshot above:

<html><body>
    order_id:  {{ order.id }}<br />
    
    <h2>All Order MetaValues:</h2>
    {% for meta_value in order.meta_values %}
    {{ meta_value.key }}: {{ meta_value.value }}<br />
    {% endfor %}

    <h3>ShippingVendors: 
        {{ order.meta_values | where: "key", "shipping_vendor" | map: "value" }}<br/>
    </h3>

    <table border="1">
        <tr><th>ITEM SKU</th><th>QTY</th><th>OrderItem MetaValues</th><th>Item MetaValues</th></tr>
        {% for order_item in order.order_items %}
        <tr>
            <td>{{ order_item.sku }}</td>
            <td>{{ order_item.quantity }}</td>
            <td>
                <table>
                    {% tablerow meta_value in order_item.meta_values %}
                    {{ meta_value.key }}: {{ meta_value.value }}
                    {% endtablerow %}
                </table>
            </td>
            <td>
                {% for meta_value in order_item.item.meta_values %}
                <p>{{ meta_value.key }}: {{ meta_value.value }}</p>
                {% endfor %}
            </td>
        </tr>
        {% endfor %}
    </table>
    </body></html>

For loops

Liquid allows for loops over collections:

{% for item in array %}
  {{ item }}
{% endfor %}

When iterating a hash, item[0] contains the key and item[1] contains the value:

{% for item in hash %}
  {{ item[0] }}: {{ item[1] }}
{% endfor %}

During every for loop, the following helper variables are available for extra styling needs:

forloop.length      # => length of the entire for loop
forloop.index       # => index of the current iteration
forloop.index0      # => index of the current iteration (zero based)
forloop.rindex      # => how many items are still left?
forloop.rindex0     # => how many items are still left? (zero based)
forloop.first       # => is this the first iteration?
forloop.last        # => is this the last iteration?

There are several attributes you can use to influence which items you receive in your loop.

A limit:int lets you restrict how many items you get. Whereas, offset:int lets you start the collection with the nth item.

# array = [1,2,3,4,5,6]
{% for item in array limit:2 offset:2 %}
  {{ item }}
{% endfor %}
# results in 3,4

Reversing the loop:

{% for item in collection reversed %} {{item}} {% endfor %}

Instead of looping over an existing collection, you can define a range of numbers to loop through. The range can be defined by both literal and variable numbers:

# if item.quantity is 4...
{% for i in (1..item.quantity) %}
  {{ i }}
{% endfor %}
# results in 1,2,3,4

Variable assignment

You can store data in your own variables, to be used in output or other tags as desired. The simplest way to create a variable is with the "assign" tag, which has a pretty straightforward syntax:

{% assign name = 'freestyle' %}

{% for t in collections.tags %}{% if t == name %}
  <p>Freestyle!</p>
{% endif %}{% endfor %}

Another way of doing this would be to assign true/false values to the variable:

{% assign freestyle = false %}

{% for t in collections.tags %}{% if t == 'freestyle' %}
  {% assign freestyle = true %}
{% endif %}{% endfor %}

{% if freestyle %}
  <p>Freestyle!</p>
{% endif %}

If you want to combine a number of strings into a single string and save it to a variable, you can do this with the "capture" tag. This tag is a block which "captures" whatever is rendered inside it, then assigns the captured value to the given variable instead of rendering it to the screen.

  {% capture attribute_name %}{{ item.title | handleize }}-{{ i }}-color{% endcapture %}

  <label for="{{ attribute_name }}">Color:</label>
  <select name="attributes[{{ attribute_name }}]" id="{{ attribute_name }}">
    <option value="red">Red</option>
    <option value="green">Green</option>
    <option value="blue">Blue</option>
  </select>

Related questions:

How do I customize Packing Slips?

How do I create a custom template?

How do I preview a custom template?

Customizing Templates

Best practices & important notes

Previewing

RyderShip Liquid Objects

Order

Wholesale Order

Order Item

Wholesale Item

Customer

Warehouse

Adding item images to packing slips

Liquid reference

Output

Advanced Output: Filters

Standard Filters

Meta Fields

Tags

Comments

Raw

If / Else

Case Statement

Cycle

For loops

Variable assignment

Was this article helpful?

<%= previousTitle %>

<%= nextTitle %>

Can't find what you're looking for?

Categories

Toggle navigation menu

<%= category.name %>