Liquid objects

An export template reads from two lists. An order template gets orders; a customer template gets customers. Loop over the list and read each entry’s properties with a dot:

{% for order in orders %}{{ order.shippingAddressSnapshot.postcode }}, {{ order.shippingAddressSnapshot.country }}{% endfor %}

AB12 3CD, United Kingdom

The Preview column on each table below is exactly what Preview Sample writes for that property, and a test in the app checks every row against what an export really contains. A property that does not exist writes nothing and raises no error, so a misspelling shows only as a gap.

Types

Numbers are written as the app holds them, not as money. A whole amount keeps one decimal place (168.0, not 168.00). Add | round: 2 to write money with two decimals; see Liquid filters. Rates are decimals: 0.2, not 20.

{% for order in orders %}{{ order.subtotal }} {{ order.grandTotal }} {{ order.lineItems.0.qty }} {{ order.lineItems.0.tax_rate }}{% endfor %}

168.0 196.32 6 0.2

A position counts from 0. order.lineItems.0 is the first line:

{% for order in orders %}{{ order.lineItems.0.sku }} then {{ order.lineItems.1.sku }}{% endfor %}

WH001 then GN002

Square brackets (lineItems[0]) are not supported, and a position past the end wraps round to the start rather than writing nothing.

orders

A list of the orders in this export. Each is an order.

order

Every figure is a snapshot taken when the order was placed. A later catalogue or price change never rewrites an order that has been taken.

line item

Each entry in order.lineItems. Prices are what this customer was charged, after their price list, any volume break and any sale.

order address

billingAddressSnapshot and shippingAddressSnapshot on an order. Snapshots: changing a customer’s address later never rewrites an order already taken.

customers

A list of the customers created or changed on a tablet that your ERP has not yet seen. Each is a customer.

customer

A customer created on a tablet often has properties with nothing in them at all, where Preview’s sample customer has empty text. Both write nothing, but upcase, downcase and capitalize fail on a missing value; put default: "" before them. See Liquid filters.

These are in every real export but not in Preview Sample, so Preview writes nothing for them (and join on tags is an error there):

customer address

Each entry in customer.shippingAddresses.

Preview’s sample addresses also carry an isLast, but a real export does not, so a separator written on it never appears in the real file. Use forloop.last:

{% for customer in customers %}{% for address in customer.shippingAddresses %}{{ address.line1 }}{% if address.isDefault %} (default){% endif %}{% unless forloop.last %}; {% endunless %}{% endfor %}{% endfor %}

4 Sample Quay (default); Unit 7, Sample Trade Park