Introduction
Order Data
Available variables to print order data in messages.
These variables are available for use only in messages related to orders. To use order data in your messages, you must categorize the message with the Type ORDER. By doing so, our system will read the order data and enable its proper usage.
General Order Data
Name | Variables | Output | Type |
---|---|---|---|
Boleto Due Date | {{ order.billet_expired_at_formatted }} | 12/02/2024 | String |
Boleto Line / Pix Copy and Paste Code | {{ order.billet_line }} | Payment Code | String |
Boleto/Payment Link | {{ order.billet_url }} | payment.link/example | String |
Currancy | {{ order.currency }} | USD | String |
Order Number | {{ order.number }} | 11205 | String |
Subtotal Value | {{ order.subtotal_price }} | 9.90 | Number |
Subtotal Value (Formatted) | {{ order.subtotal_price_formatted }} | USD9,90 | String |
Total Value | {{ order.total_price }} | 210.27 | Number |
Total Value (Formatted) | {{ order.total_price_formatted }} | USD210,27 | String |
Full Address (Formatted) | {{ order.shipping_address_formatted }} | 456 Flores St, C - Dream District, San Francisco, CA, 94107, US | String |
Products (Formatted) | {{ order.line_items_formatted }} | Product 01 - AB | Array |
Products with Variant (Formatted) | {{ order.line_items_formatted_with_variant }} | Product 01 - AB - Variant / C | String |
Order Items | order.line_items - Array
Name | Variable | Output | Type |
---|---|---|---|
Order Items (Full Array) | {{ order.line_items }} | [{"title": "My Robot"}, ...] | Array |
Title | {{ line_item.title }} | My Robot | String |
Variant Name | {{ line_item.variant_title }} | Blue | String |
Quantity | {{ line_item.quantity }} | 1 | Number |
Price | {{ line_item.price }} | 210.27 | Number |
Image URL | {{ line_item.image_url }} | https://….png | String |
Shipping Address (Orders)
| order.shipping_address - Object
Name | Variable | Output | Type |
---|---|---|---|
Shipping Address | {{ order.shipping_address }} | {"zip":"94107", …} | Object |
ZIP Code | {{ order.shipping_address.zip }} | 94107 | Number |
City | {{ order.shipping_address.city }} | San Francisco | String |
State | {{ order.shipping_address.province }} | California | String |
Adress 1 | {{ order.shipping_address.address1 }} | 456 Flores St, Apt 31 | String |
Adress 2 | {{ order.shipping_address.address2 }} | Downtown | String |
Tracking Data
| order.tracking_numbers - Array
Name | Variable | Output | Type |
---|---|---|---|
Tracking Code | {{ order.tracking_numbers.code }} | NL0000000000BR | String |
New Tracking Code | {{ order.tracking_numbers.new_code }} | NL0000000123BR | String |
Full Status | {{ order.tracking_numbers.full_status }} | DELIVERED | String |
Elapsed Time (in days) | {{ order.tracking_numbers.elapsed_time }} | 30 | Number |
Taxed At | {{ order.tracking_numbers.tax_at }} | 2024-11-30 11:46:45 | String |
Delivered At | {{ order.tracking_numbers.delivered_at }} | 2024-12-14 11:46:45 | String |
Returning to Sender At | {{ order.tracking_numbers.returning_to_sender_at }} | 2024-11-30 11:46:45 | String |
Returned to Sender At | {{ order.tracking_numbers.returned_to_sender_at }} | 2024-11-30 11:46:45 | String |
First Update At | {{ order.tracking_numbers.first_update_at }} | 2024-11-14 11:46:45 | String |
Last Update At | {{ order.tracking_numbers.last_update_at }} | 2024-12-14 11:46:45 | String |
Last Request At | {{ order.tracking_numbers.last_request_at }} | 2024-12-14 11:46:45 | String |
Tracking Events | order.tracking_numbers.events | Event Array | Array |
Name | Variable | Output | Type |
---|---|---|---|
Event Type | {{ order.tracking_numbers.events.type }} | CAINIAO | String |
Event Date | {{ order.tracking_numbers.events.date }} | 2024-12-14 11:46:45 | String |
Event Label | {{ order.tracking_numbers.events.label }} | Delivered | String |
Event Location | {{ order.tracking_numbers.events.location }} | New York, NY | String |
Event Description | {{ order.tracking_numbers.events.description }} | Your package was delivered | String |