When it's sent
Sent when a shopper asks for a code on the Track order page with the order number and the email address or phone number on the order. It goes only to that contact. The code works for 10 minutes; an order gets at most 3 codes an hour. Not sent when the Track order page is turned off. For a test order it goes out only when the order's email address belongs to someone on your team.
At a glance
Category: Authentication. Codes the customer asks for to sign in, to confirm their phone number or email address, or to view an order on the Track order page.
Channels: Email, SMS, WhatsApp
Can be switched off: No, it is always sent
What it also needs
Email needs the customer's email address. A text needs the customer's phone number and a ready SMS or WhatsApp provider. Always sent; it can't be switched off.
Related settings
Transactional messages
Message templates
Transactional emails
Service providers
Values it can read
Its template can print these values. Write a value's path between double braces, such as {{ shop.name }}. [] marks one entry of a list, read inside a loop: order.items[].title is item.title in {% for item in order.items %}. A value the event has no data for prints nothing.
SMS and WhatsApp texts read the same values, except the email values.
Customer#
Value |
Path |
|---|---|
First name |
|
Last name |
|
Email address |
|
Has an account |
|
Order#
Value |
Path |
|---|---|
Customer tax ID |
|
Customer tax ID type |
|
Tax exemption reason |
|
Order ID |
|
Order number |
|
Order date |
|
Order status page |
|
Order status page path |
|
Save information link |
|
Payment |
|
Payment › Payment method key |
|
Payment › Payment method |
|
Payment › Cash on delivery |
|
Payment › Payment status |
|
Totals |
|
Totals › Has a discount |
|
Totals › Has a shipping line |
|
Totals › Free shipping |
|
Totals › Has a cash on delivery fee |
|
Totals › Has checkout fees |
|
Totals › Has duties |
|
Totals › Has tax |
|
Totals › Has a refund |
|
Totals › Has store credit |
|
Totals › Has a gift card payment |
|
Totals › Has a payment |
|
Totals › Has an amount due |
|
Totals › Subtotal |
|
Totals › Total discount |
|
Totals › Shipping |
|
Totals › Shipping taxes |
|
Totals › Shipping taxes › Included in the price |
|
Totals › Shipping taxes › Tax name |
|
Totals › Shipping taxes › Tax rate |
|
Totals › Shipping taxes › Tax amount |
|
Totals › Tax |
|
Totals › Cash on delivery fee |
|
Totals › Cash on delivery fee taxes |
|
Totals › Cash on delivery fee taxes › Included in the price |
|
Totals › Cash on delivery fee taxes › Tax name |
|
Totals › Cash on delivery fee taxes › Tax rate |
|
Totals › Cash on delivery fee taxes › Tax amount |
|
Totals › Checkout Fees |
|
Totals › Checkout fees, one by one |
|
Totals › Checkout fees, one by one › Fee name |
|
Totals › Checkout fees, one by one › Fee amount |
|
Totals › Checkout fees, one by one › How the fee was calculated |
|
Totals › Checkout fees, one by one › How the fee was calculated › Calculation kind (per_item or percent) |
|
Totals › Checkout fees, one by one › How the fee was calculated › Fee per item |
|
Totals › Checkout fees, one by one › How the fee was calculated › Number of items |
|
Totals › Checkout fees, one by one › How the fee was calculated › Percentage |
|
Totals › Checkout fees, one by one › How the fee was calculated › Amount the percentage was taken of |
|
Totals › Checkout fees, one by one › How the fee was calculated › Calculation line |
|
Totals › Checkout fees, one by one › Customer's text |
|
Totals › Checkout fees, one by one › Text prompt |
|
Totals › Checkout fees, one by one › Fee taxes |
|
Totals › Checkout fees, one by one › Fee taxes › Included in the price |
|
Totals › Checkout fees, one by one › Fee taxes › Tax name |
|
Totals › Checkout fees, one by one › Fee taxes › Tax rate |
|
Totals › Checkout fees, one by one › Fee taxes › Tax amount |
|
Totals › Duties |
|
Totals › Grand total |
|
Totals › Refunded |
|
Totals › Store credit |
|
Totals › Gift Card |
|
Totals › Amount paid |
|
Totals › Amount due |
|
Totals › Due on delivery |
|
Totals › Due at pickup |
|
Totals › Tax included |
|
Totals › Taxes by rate |
|
Totals › Taxes by rate › Included in the price |
|
Totals › Taxes by rate › Tax name |
|
Totals › Taxes by rate › Tax rate |
|
Totals › Taxes by rate › Tax amount |
|
Totals › Number of tax lines |
|
Totals › Tax list shortened |
|
Totals › Other taxes |
|
Import duties |
|
Import duties › Who pays import duties |
|
Import duties › Estimated duties and taxes due on delivery |
|
Import duties › Import duties note |
|
Items |
|
Items › Line ID |
|
Items › Product name |
|
Items › Variant name |
|
Items › SKU |
|
Items › Product image |
|
Items › Product link |
|
Items › Quantity |
|
Items › Unit price |
|
Items › Compare-at price |
|
Items › Line discount |
|
Items › Line total |
|
Items › Line taxes |
|
Items › Line taxes › Included in the price |
|
Items › Line taxes › Tax name |
|
Items › Line taxes › Tax rate |
|
Items › Line taxes › Tax amount |
|
Items › Line properties |
|
Items › Line properties › Property name |
|
Items › Line properties › Property value |
|
Items › Line details |
|
Items › Line details › Detail name |
|
Items › Line details › Detail text |
|
Items › Line details › Detail link |
|
Number of items |
|
Number of lines |
|
Item list shortened |
|
Discounts |
|
Discounts › Discount code |
|
Discounts › Discount name |
|
Discounts › Discount type |
|
Discounts › Discount amount |
|
Shipping address |
|
Shipping address › First name |
|
Shipping address › Last name |
|
Shipping address › Company name |
|
Shipping address › Address line 1 |
|
Shipping address › Address line 2 |
|
Shipping address › District |
|
Shipping address › City |
|
Shipping address › State or region code |
|
Shipping address › State or region |
|
Shipping address › Postal code |
|
Shipping address › Country code |
|
Shipping address › Country |
|
Shipping address › Phone number |
|
Shipping address › Full address |
|
Billing address |
|
Billing address › First name |
|
Billing address › Last name |
|
Billing address › Company name |
|
Billing address › Address line 1 |
|
Billing address › Address line 2 |
|
Billing address › District |
|
Billing address › City |
|
Billing address › State or region code |
|
Billing address › State or region |
|
Billing address › Postal code |
|
Billing address › Country code |
|
Billing address › Country |
|
Billing address › Phone number |
|
Billing address › Full address |
|
Shipping method |
|
Pickup location |
|
Pickup location › Location name |
|
Pickup location › Location address |
|
Pickup location › Location phone |
|
Pickup location › Usually ready in |
|
Pickup location › Pickup instructions |
|
Pickup location › Opening hours |
|
Needs shipping |
|
Customer note |
|
Checkout answers |
|
Checkout answers › Question |
|
Checkout answers › Answer |
|
Cancellation reason |
|
Access code#
Value |
Path |
|---|---|
Code |
|
Code valid for (minutes) |
|
Store#
Value |
Path |
|---|---|
Store name |
|
Store link |
|
Store logo |
|
Support email |
|
Store address |
|
Store address › First name |
|
Store address › Last name |
|
Store address › Company name |
|
Store address › Address line 1 |
|
Store address › Address line 2 |
|
Store address › District |
|
Store address › City |
|
Store address › State or region code |
|
Store address › State or region |
|
Store address › Postal code |
|
Store address › Country code |
|
Store address › Country |
|
Store address › Phone number |
|
Store address › Full address |
|
Social links |
|
Social links › Network |
|
Social links › Profile link |
|
This email (emails only)#
Value |
Path |
|---|---|
Preview text |
|
Email parts it can use
Its email code can add these parts of the email library with {% render %}. An email offers only the parts it has data for.
{% render 'access_code' %}: The one-time code of a sign-in or confirmation email, large and easy to copy, with how long it is valid.{% render 'button' %}: A button in your accent colour that works in every email program.{% render 'eyebrow' %}: A small line in capitals above a heading, such as the order number and date.{% render 'footer' %}: The store's name and its support address.{% render 'header' %}: The store's logo (from Email design), or its name when there is no logo, linking to the store.{% render 'items' %}: The email's items with their photo, variant, quantity and price, then the totals: subtotal, discount, shipping, fees, duties, tax and total. Only the lines the order has are shown. In a refund email these are the refunded items; in a cart or checkout reminder, the cart's items without prices.{% render 'order_details' %}: The order's shipping and billing address, shipping method or pickup location, payment and the customer's note, each under its heading, in two columns (one on phones). A part the order has no value for is left out.{% render 'progress' %}: The order's progress bar: Ordered, Shipped, Out for delivery, Delivered, or the pickup steps for a pickup order. Orders with nothing to ship or pick up show no bar.