Following is a list describing the many placeholder possibilities, when using our WEL or WTL language. To see a technical description of how WEL/WTL works, please see our documentation. These values are can also be used for when updating attributes.
1. Select placeholder location
Automations
Slip templates
Mail templates
2. Automations: Select trigger resource
3. Reports: Select resource
Shipments
Parcels
Orders
Consolidated customs lines
Order lines consolidated by SKU
ORDER PLACEHOLDERS
NOTE: If you're coming from the shipment placeholders, then prepend the
placeholders with shipment. Ex. {{ shipment.order.status }}
NOTE: If you're coming from Reports - Orders resource, then remove the
"order" selector at the start. Ex. {{ visible_ref }} instead of
{{ order.visible_ref }}
Order - General attributes
Order Channel ID: {{ order.order_channel_id }}
Shipping Rate ID: {{ order.shipping_rate_id }}
Printer Client ID: {{ order.printer_client_id }}
Status: {{ order.status }}
External Reference (Shop Unique ID): {{ order.ext_ref }}
Visible Reference (Shop Order Number): {{ order.visible_ref }}
Currency: {{ order.currency }}
Internal Comment: {{ order.internal_comment }}
External Comment: {{ order.external_comment }}
Error Message: {{ order.error_message }}
Locked: {{ order.lock_state }}
Source: {{ order.source }}
Return: {{ return.order.visible_ref }}
Order - Delivery Address
Address ID: {{ order.delivery_address_id }}
Contact Person: {{ order.delivery_address.att_contact }}
Company Name: {{ order.delivery_address.company_name }}
Address Line 1: {{ order.delivery_address.address_1 }}
Address Line 2: {{ order.delivery_address.address_2 }}
Postal Code: {{ order.delivery_address.zip }}
City: {{ order.delivery_address.city }}
Country Code: {{ order.delivery_address.country_code }}
State: {{ order.delivery_address.state }}
Phone number: {{ order.delivery_address.phone }}
E-mail: {{ order.delivery_address.email }}
Order - Billing Address
Address ID: {{ order.billing_address_id }}
Contact Person: {{ order.billing_address.att_contact }}
Company Name: {{ order.billing_address.company_name }}
Address Line 1: {{ order.billing_address.address_1 }}
Address Line 2: {{ order.billing_address.address_2 }}
Postal Code: {{ order.billing_address.zip }}
City: {{ order.billing_address.city }}
Country Code: {{ order.billing_address.country_code }}
State: {{ order.billing_address.state }}
Phone Number: {{ order.billing_address.phone }}
E-mail: {{ order.billing_address.email }}
Order - Sender Address
Address ID: {{ order.sender_address_id }}
Contact Person: {{ order.sender_address.att_contact }}
Company Name: {{ order.sender_address.company_name }}
Address Line 1: {{ order.sender_address.address_1 }}
Address Line 2: {{ order.sender_address.address_2 }}
Postal Code: {{ order.sender_address.zip }}
City: {{ order.sender_address.city }}
Country Code: {{ order.sender_address.country_code }}
State: {{ order.sender_address.state }}
Phone number: {{ order.sender_address.phone }}
E-mail: {{ order.sender_address.email }}
Order - Sold From Address
Address ID: {{ order.sold_from_address_id }}
Contact Person: {{ order.sold_from_address.att_contact }}
Company Name: {{ order.sold_from_address.company_name }}
Address Line 1: {{ order.sold_from_address.address_1 }}
Address Line 2: {{ order.sold_from_address.address_2 }}
Postal Code: {{ order.sold_from_address.zip }}
City: {{ order.sold_from_address.city }}
Country Code: {{ order.sold_from_address.country_code }}
State: {{ order.sold_from_address.state }}
Phone Number: {{ order.sold_from_address.phone }}
E-mail: {{ order.sold_from_address.email }}
Order - Shipping Rate
ID: {{ order.shipping_rate_id }}
Name: {{ order.shipping_rate.name }}
Service Code: {{ order.shipping_rate.carrier_service_code }}
Carrier Name: {{ order.shipping_rate.carrier.alias }}
Return Shipment: {{ order.shipping_rate.is_return }}
E-mail Notification Enabled: {{ order.shipping_rate.carriers_email }}
SMS Notification Enabled: {{ order.shipping_rate.carriers_sms }}
Dutiable: {{ order.shipping_rate.dutiable }}
Hidden: {{ order.shipping_rate.is_hidden }}
Order - Original Shipping
Shipping Code: {{ order.original_shipping.shipping_code }}
Shipping Name: {{ order.original_shipping.shipping_name }}
Shipping Price: {{ order.original_shipping.price }}
Shipping Vat Percent: {{ order.original_shipping.vat_percent }}
Order - Order Lines
NOTE: When accessing the lines from the "Update order line" automation
action, the selector needs to be "line". Ex. {{ line.description }}
SKU Number: {{ order_line.sku }}
Description: {{ order_line.description }}
Quantity: {{ order_line.quantity }}
Location: {{ order_line.location }}
External Reference (Product ID from Shop): {{ order_line.ext_ref }}
Weight: {{ order_line.weight }}
Weight Unit: {{ order_line.weight_unit }}
Unit Price: {{ order_line.unit_price }}
Discounted Unit Price: {{ order_line.discounted_unit_price }}
Vat Percent: {{ order_line.vat_percent }}
Tariff Number: {{ order_line.tarif_number }}
Country of Origin: {{ order_line.country_of_origin }}
Additional Attributes: {{ order_line.additional_attributes.
((attribute name here)) }}
Order - Order Channel
ID: {{ order.order_channel.id }}
Label (Name of order channel): {{ order.order_channel.channel_label }}
SHIPMENT PLACEHOLDERS
NOTE: If you're coming from Reports - Shipments resource, then remove
the "shipment" selector at the start. Ex. {{ reference }} instead
of {{ shipment.reference }}
Shipment - General attributes
ID: {{ shipment.id }}
Carrier ID: {{ shipment.carrier_id }}
Reference (Ordernumber): {{ shipment.reference }}
Comment: {{ shipment.comment }}
Service Code (Name of Service): {{ shipment.service_code }}
Return: {{ shipment.is_return }}
Order ID: {{ shipment.order_id }}
Printer Client ID: {{ shipment.printer_client_id }}
Mail Template ID: {{ shipment.mail_template_id }}
Waybill ID: {{ shipment.waybill_id }}
Shipping Rate ID: {{ shipment.shipping_rate_id }}
Pickup ID: {{ shipment.pickup_id }}
Dutiable: {{ shipment.dutiable }}
Deleted at: {{ shipment.deleted_at }}
Weight: {{ shipment.packages.weight }}
Weight Unit: {{ shipment.packages.weight_unit }}
Shipment - Delivery Address
ID: {{ shipment.delivery_address_id }}
Contact Person: {{ shipment.delivery_address.att_contact }}
Company Name: {{ shipment.delivery_address.company_name }}
Address Line 1: {{ shipment.delivery_address.address_1 }}
Address Line 2: {{ shipment.delivery_address.address_2 }}
Postal Code: {{ shipment.delivery_address.zip }}
City: {{ shipment.delivery_address.city }}
Country Code: {{ shipment.delivery_address.country_code }}
State: {{ shipment.delivery_address.state }}
Phone number: {{ shipment.delivery_address.phone }}
E-mail: {{ shipment.delivery_address.email }}
Shipment - Billing Address
ID: {{ shipment.billing_address_id }}
Contact Person: {{ shipment.billing_address.att_contact }}
Company Name: {{ shipment.billing_address.company_name }}
Address Line 1: {{ shipment.billing_address.address_1 }}
Address Line 2: {{ shipment.billing_address.address_2 }}
Postal Code: {{ shipment.billing_address.zip }}
City: {{ shipment.billing_address.city }}
Country Code: {{ shipment.billing_address.country_code }}
State: {{ shipment.billing_address.state }}
Phone number: {{ shipment.billing_address.phone }}
E-mail: {{ shipment.billing_address.email }}
Shipment - Sold From Address
ID: {{ shipment.sold_from_address_id }}
Contact Person: {{ shipment.sold_from_address.att_contact }}
Company Name: {{ shipment.sold_from_address.company_name }}
Address Line 1: {{ shipment.sold_from_address.address_1 }}
Address Line 2: {{ shipment.sold_from_address.address_2 }}
Postal Code: {{ shipment.sold_from_address.zip }}
City: {{ shipment.sold_from_address.city }}
Country Code: {{ shipment.sold_from_address.country_code }}
State: {{ shipment.sold_from_address.state }}
Phone number: {{ shipment.sold_from_address.phone }}
E-mail: {{ shipment.sold_from_address.email }}
Shipment - Sender Address
ID: {{ shipment.sender_address_id }}
Contact Person: {{ shipment.sender_address.att_contact }}
Company Name: {{ shipment.sender_address.company_name }}
Address Line 1: {{ shipment.sender_address.address_1 }}
Address Line 2: {{ shipment.sender_address.address_2 }}
Postal Code: {{ shipment.sender_address.zip }}
City: {{ shipment.sender_address.city }}
Country Code: {{ shipment.sender_address.country_code }}
State: {{ shipment.sender_address.state }}
Phone number: {{ shipment.sender_address.phone }}
E-mail: {{ shipment.sender_address.email }}
Shipment - Pickup Address
ID: {{ shipment.pickup_address_id }}
Contact Person: {{ shipment.pickup_address.att_contact }}
Company Name: {{ shipment.pickup_address.company_name }}
Address Line 1: {{ shipment.pickup_address.address_1 }}
Address Line 2: {{ shipment.pickup_address.address_2 }}
Postal Code: {{ shipment.pickup_address.zip }}
City: {{ shipment.pickup_address.city }}
Country Code: {{ shipment.pickup_address.country_code }}
State: {{ shipment.pickup_address.state }}
Phone number: {{ shipment.pickup_address.phone }}
E-mail: {{ shipment.pickup_address.email }}
Shipment - Return Address
ID: {{ shipment.return_address_id }}
Contact Person: {{ shipment.return_address.att_contact }}
Company Name: {{ shipment.return_address.company_name }}
Address Line 1: {{ shipment.return_address.address_1 }}
Address Line 2: {{ shipment.return_address.address_2 }}
Postal Code: {{ shipment.return_address.zip }}
City: {{ shipment.return_address.city }}
Country Code: {{ shipment.return_address.country_code }}
State: {{ shipment.return_address.state }}
Phone number: {{ shipment.return_address.phone }}
E-mail: {{ shipment.return_address.email }}
Shipment - Shipping Rate
ID: {{ shipment.shipping_rate_id }}
Carrier ID: {{ shipment.shipping_rate.carrier_id }}
Name: {{ shipment.shipping_rate.name }}
Service Code: {{ shipment.shipping_rate.carrier_service_code }}
Return Shipment: {{ shipment.shipping_rate.is_return }}
E-mail Notification Enabled: {{ shipment.shipping_rate.carriers_email }}
SMS Notification Enabled: {{ shipment.shipping_rate.carriers_sms }}
Mail Template: {{ shipment.shipping_rate.mail_template_id }}
Dutiable: {{ shipment.shipping_rate.dutiable }}
Hidden: {{ shipment.shipping_rate.is_hidden }}
Shipment - Order
Shipment - Packages
NOTE: To use the package placeholders, you'll first need to loop through the packages, as the shipment can have multiple. If you're accessing the order lines or customs lines in the package, you'll need to make a new loop for these as well.
Check the "Iteration" section under 9 Webshipper Template Language:
https://docs.webshipper.io/#9-webshipper-template-language
Ex. when looping with each package assigned to the package variable. This will print package weight, weight unit and description of each product.
Shipment - Tracking
NOTE: To use the tracking placeholders, you'll first need to loop through the tracking links, as the shipment can have multiple.
Check the "Iteration" section under 9 Webshipper Template Language:
https://docs.webshipper.io/#9-webshipper-template-language
Ex. when looping with each tracking assigned to the tracking variable. This will print the tracking number and url
ORDER LINE PLACEHOLDERS
NOTE: These are only available within a loop through each order line, when using the "Update order line" automation action or from the order line section in slip templates
SKU Number: {{ order_line.sku }}
Description: {{ order_line.description }}
Quantity: {{ order_line.quantity }}
Location: {{ order_line.location }}
External Reference (Product ID from Shop): {{ order_line.ext_ref }}
Weight: {{ order_line.weight }}
Weight Unit: {{ order_line.weight_unit }}
Unit Price: {{ order_line.unit_price }}
Discounted Unit Price: {{ order_line.discounted_unit_price }}
Vat Percent: {{ order_line.vat_percent }}
Tariff Number: {{ order_line.tarif_number }}
Country of Origin: {{ order_line.country_of_origin }}
Additional Attributes: {{ order_line.additional_attributes.((attribute name here)) }}
PACKAGE PLACEHOLDERS
Package - General attributes
Weight: {{ weight }}
Weight unit: {{ weight_unit }}
Height: {{ dimensions.height }}
Width: {{ dimensions.width }}
Length: {{ dimensions.length }}
Dimension unit: {{ dimensions.unit }}
Package - Order Lines
NOTE: To use the order lines placeholders, you'll first need to loop through the order lines, as the package can have multiple.
Check the "Iteration" section under 9 Webshipper Template Language:
https://docs.webshipper.io/#9-webshipper-template-language
Ex. when looping with each package assigned to the package variable. This will print order line sku and quantity of each order line.
Check the Order Line placeholders for a full list
Package - Shipment
Check the Shipment placeholders for a full list
Package - Order
Check the Order placeholders for a full list
"Order lines consolidated by SKU" Placeholders
SKU: {{ sku }}
Description: {{ description }} - This will be the description of first product found by sku
Quantity: {{ quantity }} - This is the summed quantity of the sku's
"Consolidated customs lines" Placeholders
Tariff Number: {{ tarif_number }}
Country of Origin: {{ country_of_origin }}
Unit Price: {{ unit_price }}
Price: {{ price }} - This is the summed price of the consolidated lines
Quantity: {{ quantity }} - This is the summed quantity of the consolidated lines
Description: {{ description }} - This will be the description of first consolidated line found
Weight: {{ weight }} - This is the summed weight of the consolidated lines