Order properties

Extra information that was added to the order, typically in the shopping cart. Appears in Shopify admin, in the Additional details section of the Order details page.

The array contains entries with name and value key-pairs.

{{ order.attributes }}

Pickup date: 2024-08-14
Engraving name: Sam

Use the following for loop to return all the titles and descriptions of a specific attribute:

{% for name, value in order.attributes %}
  {% if "date" in name %}
    {{ name }}: {{ value }}
  {% endif %}
{% endfor %}

Pickup date: 2024-08-14

Use the name of the entry as an attribute to return its value.

{{ order.attributes.engraving_name }}

Sam

The mailing address associated with the payment method. This address is an optional field that isn't available on orders that do not require a payment method. Contains the following fields:

• company
• street
• city
• country
• region_code

{{ order.billing_address }}

company=None,
street=42 Oxford Street,
city=London,
country=GB,
region_code=ENG

Use one of the field names as an attribute to return the value of only that field.

{{ order.billing_address.city }}

London

The reason why the order was cancelled. Valid values are:

• customer
• fraud
• inventory
• declined
• other

Returns an empty string if the order is not cancelled.

{{ order.cancel_reason }}

declined

The autogenerated date and time (ISO 8601 format) when the order was cancelled in the store.

{{ order.cancelled_time }}

2024-08-01 13:21:33+00:00

Use the text attribute or the format_date filter to format the date according to the language of your document.

{{ order.cancelled_time.text }}

Aug 1, 2024

A unique value to reference the cart that's associated with the order.

{{ order.cart_token }}

68778783ad298f1c80c3bafcddeea

The date and time (ISO 8601 format) when the order was created in the store.

{{ order.created_time }}

2024-07-25 15:16:50+00:00

Use the text attribute or the format_date filter to format the date according to the language of your document.

{{ order.created_time.text }}

Jul 25, 2024

The three-letter code (ISO 4217 format) of the store currency.

{{ order.currency }}

EUR

The two or three-letter language code (ISO 639-1 or ISO 639-2 format) of the language and locale selected by the customer, optionally followed by a region modifier.

{{ order.customer_locale }}

en_US

The status of payments associated with the order, set when the order is created. Valid values are:

• pending
• authorized
• partially_paid
• paid
• partially_refunded
• refunded
• voided

{{ order.financial_status }}

paid

The order's status in terms of fulfilled line items. Valid values are:

• fulfilled
• partial
• restocked
• null

{{ order.fulfillment_status }}

fulfilled

The date and time (ISO 8601 format) when the order was marked as fulfilled in the store.

{{ order.fulfillment_time }}

2024-07-29 16:30:09+00:00

Use the text attribute or the format_date filter to format the date according to the language of your document.

{{ order.fulfillment_time.text }}

Jul 29, 2024

The unique ID of the order.

{{ order.id }}

6056642773311

If True, the order is a test order.

{{ order.is_test }}

False

The ID of the physical location where the order was processed.

{{ order.location_id }}

654321

The order name, generated by combining the order.number property with an order prefix and suffix that you can edit in the store settings. This is different from the order.id property.

{{ order.name }}

#1026

An optional note that you can attach to the order in the store.

{{ order.note }}

Order is a gift

The order's position in your store's count of orders. The numbers are sequential and start at 1.

{{ order.number }}

26

The integer representation of the order.name property. The numbers are sequential and start at 1001.

For example, for order #1026, order.order_number is 1026.

{{ order.order_number }}

1026

The URL that points to the order status web page.

{{ order.order_status_url }}

https://checkout.shopify.com/112233/checkouts/4207896aad57dfb159/thank_you_token?key=753621327b9e8a64789651bf221dfe35

The three-letter code (ISO 4217 format) of the presentment currency that was used to display prices to the customer.

{{ order.presentment_currency }}

GBP

The date and time (ISO 8601 format) when an order was processed in the store.

{{ order.processed_time }}

2024-07-29 16:30:09+00:00

Use the text attribute or the format_date filter to format the date according to the language of your document.

{{ order.processed_time.text }}

Jul 29, 2024

The mailing address to where the order will be shipped. Contains the following fields:

• company
• street
• city
• country
• region_code

{{ order.shipping_address }}

company=None,
street=62 Trafalgar Square,
city=London,
country=GB,
region_code=ENG

Use one of the field names as an attribute to return the value of only that field.

{{ order.shipping_address.street }}

62 Trafalgar Square

The source of the checkout from the store.

{{ order.source_name }}

shopify_draft_order

The price of the order in the store currency after discounts but before shipping, duties, taxes, and tips.

{{ order.subtotal_price }}

28.36

The tags attached to the order, formatted as a string of comma-separated values.

{{ order.tags }}

ASAP, B2B, New

Use the split filter to split the string into an array.

{{ order.tags | split(separator=', ') }}

['ASAP', 'B2B', 'New']

If True, the taxes are included in the order subtotal.

{{ order.taxes_included }}

True

A unique value to reference the order.

{{ order.token }}

6fd77ffe63681af1d289c1ded88094c3

The sum of the discounts applied to the price of the order in the shop currency.

{{ order.total_discounts }}

5.00

The sum of all line item prices in the shop currency.

{{ order.total_line_items }}

33.36

The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Cannot be negative.

{{ order.total_price }}

44.61

The sum of all the refunds of the order.

{{ order.total_refunded }}

41.77

The sum of all the taxes applied to the order in the shop currency. Must be positive.

{{ order.total_tax }}

7.44

The sum of all the tips in the order in the shop currency.

{{ order.total_tip }}

0.00

The date and time (ISO 8601 format) when the order was last modified.

{{ order.updated_time }}

2024-07-26 12:10:33+00:00

Use the text attribute or the format_date filter to format the date according to the language of your document.

{{ order.updated_time.text }}

Jul 26, 2024

The sum of all the line item weights in grams. The sum is not adjusted when items are removed from the order.

{{ order.weight }}

810

The date and time (ISO 8601 format) when the customer was created.

{{ order.customer.created_time }}

2013-06-27 08:48:27-04:00

Use the text attribute or the format_date filter to format the date according to the language of your document.

{{ order.customer.created_time.text }}

Jun 27, 2013

The three-letter code (ISO 4217 format) for the currency that the customer used when they paid for their last order. Defaults to the store currency. Returns the store currency for test orders.

{{ order.customer.currency }}

GBP

The unique email address of the customer.

{{ order.customer.email }}

george.smith@smithltd.co.uk

The customer's first name.

{{ order.customer.first_name }}

George

A unique identifier for the customer.

{{ order.customer.id }}

8214991929663

The customer's last name.

{{ order.customer.last_name }}

Smith

The order.name of the customer's last order.

{{ order.customer.last_order_name }}

#1026

Additional information attached to the customer, stored as name-value pairs.

Return all the name-value pairs:

{{ order.customer.metafields }}

birthday: 2001-08-05
tier: silver

Use the following for loop to iterate through the metafields:

{% for name, value in order.customer.metafields %}
  {% if "birthday" in name %}
    {{ name }}: {{ value }}
  {% endif %}
{% endfor %}

birthday: 2001-08-05

Use the name as an attribute to return its value:

{{ order.customer.metafields.tier }}

silver

The unique phone number (E.164 format) of the customer.

{{ order.customer.phone }}

+44789456123

The state of the customer's account in your store. Valid values are:

• disabled: The customer doesn't have an active account. Customer accounts can be disabled from the Shopify admin at any time.
• invited: The customer has received an email invite to create an account.
• enabled: The customer has created an account.
• declined: The customer declined the email invite to create an account.

{{ order.customer.state }}

enabled

Tags that you attached to the customer, formatted as a string of comma-separated values. A customer can have up to 250 tags. Each tag can have up to 255 characters.

{{ order.customer.tags }}

Active subscriber, Monthly payment, Premium plan

Use the split filter to split the string into an array.

{{ order.customer.tags | split(separator=', ') }}

['Active subscriber', 'Monthly payment', 'Premium plan']

If True, taxes won't be applied to an order at checkout.

{{ order.customer.tax_exempt }}

False

Defines whether the customer is exempt from paying specific taxes on their order.

{{ order.customer.tax_exemptions }}

[ "CA_STATUS_CARD_EXEMPTION", "CA_BC_RESELLER_EXEMPTION" ]

The date and time (ISO 8601 format) when the customer information was last updated.

{{ order.customer.updated_time }}

2013-06-27 08:48:27-04:00

Use the text attribute or the format_date filter to format the date according to the language of your document.

{{ order.customer.updated_time.text }}

Jun 27, 2013

Use the {% for line in order.lines %} loop to iterate through all line items of the order.

{% for line in order.lines %}
  {{ line.quantity }}× {{ line.product.title }} for {{ line.price.text }}
{% endfor %}

The currency of the order line.

{{ order.lines[0].currency }}

EUR

The discounts of the order that apply to this line item. This property group contains the same properties as order.discount.applications.

{{ order.line[0].discount_applications[0].value.text }}

15%

The price of the line item in the currency's subunit. This includes any line-level discounts.

The value is output in the customer's local (presentment) currency.

{{ order.lines[0].price }}

25.00

A description of the product. Supports HTML formatting.

{{ order.lines[0].product.body_html }}

The perfect coffee for any occasion.

A unique handle (human-friendly string) for the product.

{{ order.lines[0].product.handle }}

uganda-coffee-250g

The unique store ID of the line item's product.

{{ order.lines[0].product.id }}

9653832876351

Additional information attached to the product, stored as name-value pairs.

Return all the name-value pairs:

{{ order.lines[0].product.metafields }}

processing_method: washed
brew_type: filter

Use the following for loop to iterate through the metafields:

{% for name, value in order.lines[0].product.metafields %}
  {% if "processing_method" in name %}
    {{ name }}: {{ value }}
  {% endif %}
{% endfor %}

processing_method: washed

Use the name as an attribute to return its value:

{{ order.lines[0].product.metafields.brew_type }}

filter

The type of the product. A categorization used for filtering and searching products.

{{ order.lines[0].product.product_type }}

Single-origin coffee

The tags associated with the product, in an alphabetical order.

{{ order.lines[0].product.tags }}

Filter coffee, Fruity, Medium cup, Uganda

Use the split filter to split the string into an array.

{{ order.lines[0].product.tags | split(separator=', ') }}

['Filter coffee', 'Fruity', 'Medium cup', 'Uganda']

The name of the product.

{{ order.lines[0].product.title }}

Uganda Coffee 250g

The vendor of the line item product.

{{ order.lines[0].product.vendor }}

Wamala Estate

An array of custom information for an item that has been added to the cart. Often used to provide product customization options.

Use the following for loop to iterate through the properties:

{% for key, value in order.lines.properties %}
	{{ key }}: {{ value }}
{% endfor %}

custom bag label: Roasted for Black Ltd.

Or use the following to return only one key-value pair:

{{ order.lines[0].properties.custom_bag_label }}

Roasted for Black Ltd.

The number of units of one item that were purchased.

{{ order.lines[0].quantity }}

3

An amount for a tax applied to the item.

order.line[0].tax_amount

4.73

The tax rate applied to the order to calculate the tax price.

{{ order.lines[0].tax_rate[0] }}

20.00

The total amount of the discount allocated to the line item in the store currency.

{{ order.lines[0].total_discount }}

0

The barcode, UPC, or ISBN number for the product variant.

{{ order.lines[0].variant.barcode }}

12345_uganda_light

The original price of the item before an adjustment or a sale.

{{ order.lines[0].variant.compare_price }}

15.00

The country code (ISO 3166-1 alpha-2 format) of where the item came from.

{{ order.lines[0].variant.country_code_of_origin }}

UG

An array of country-specific Harmonized System (HS) codes for the item. Used to determine duties when shipping the inventory item to certain countries.

{{ order.lines[0].variant.country_hs_code }}

"harmonized_system_code": "1234562222",
"country_code": "US”

The full name of the country of origin, converted from order.lines[#].variant.country_code_of_origin.

{{ order.lines[0].variant.country_of_origin }}

Uganda

The country-specific or general Harmonized System code for the inventory item.

order.lines[0].variant.hs_code

0901.21.00

The ID of the line item variant.

{{ order.lines[0].variant.id }}

9653832876351

Additional information attached to the customer, stored as name-value pairs.

Return all the name-value pairs:

{{ order.lines[0].variant.metafields }}

packaging: bag
size: 250g

Use the following for loop to iterate through the metafields:

{% for name, value in order.lines[0].variant.metafields %}
  {% if "packaging" in name %}
    {{ name }}: {{ value }}
  {% endif %}
{% endfor %}

packaging: bag

Use the name as an attribute to return its value:

{{ order.lines[#].variant.metafields.size }}

250g

The price of the variant in the currency's subunit. The value is output in the customer's presentment currency.

{{ order.lines[0].variant.price }}

13.00

The province code (ISO 3166-2 alpha-2 format) of where the item came from. The province code is only used if the shipping provider for the inventory item is Canada Post.

{{ order.lines[0].variant.province_code_of_origin }}

QC

The full name of the province of origin, converted from order.lines[#].variant.province_code_of_origin.

{{ order.lines[0].variant.province_of_origin }}

Quebec

The SKU of the variant associated with the line item.

{{ order.lines[0].variant.sku }}

1088-1141

If True, taxes are charged on the variant.

{{ order.lines[0].variant.taxable }}

False

Display name of the line item variant.

{{ order.lines[0].variant.title }}

Light

The weight of the item variant in grams.

order.lines[0].variant.weight

270

The unit for the weight of the variant.

{{ order.lines[0].variant.weight_unit }}

g

Use the {% for shipping_line in order.shipping_lines %} loop to iterate through all shipping lines of the order.

{% for shipping_line in order.shipping_lines %}
    {{ shipping_line.title }}: {{ shipping_line.price.text }}
{% endfor %}

The reference to the shipping method.

{{ order.shipping_lines[0].code }}

INT.TP

The three-letter code (ISO 4217 format) of the shipping line currency.

{{ order.shipping_lines[0].currency }}

EUR

The price of the shipping method in the shop currency, after line-level discounts have been applied. Doesn't reflect cart-level or order-level discounts.

{{ order.shipping_lines[0].discounted_price }}

16.25

Use the .text attribute to render the value formatted as a price.

{{ order.shipping_lines[0].discounted_price.text }}

€16.25

The price of the selected shipping method in the shop currency. Cannot be negative.

{{ order.shipping_lines[0].price }}

16.25

Use the .text attribute to render the value formatted as a price.

{{ order.shipping_lines[0].price.text }}

€16.25

The tax amount of the shipping line in the customer’s presentment (local) currency's subunit.

{{ order.shipping_lines[0].tax_amount }}

2.71

Use the .text attribute to render the value formatted as a price.

{{ order.shipping_lines[0].tax_amount.text }}

€2.71

The decimal value of the tax rate of the shipping.

{{ order.shipping_lines[0].tax_rate }}

0.2

Use the .text attribute to render the value formatted as a percentage.

{{ order.shipping_lines[0].tax_rate.text }}

20%

The title of the shipping method.

{{ order.shipping_lines[0].title }}

Small Packet International Air

Use the {% for tax_line in order.tax_lines %} loop to iterate through all the tax lines of the order.

{% for tax_line in order.tax_lines %}
    {{ tax_line.title }}: {{ tax_line.price.text }}
{% endfor %}

The three-letter code (ISO 4217 format) of the currency of the tax line.

{{ order.tax_lines[0].currency }}

EUR

The tax amount in the currency's subunit. The value is output in the customer's local (presentment) currency.

{{ order.tax_lines[0].price }}

7.44

Use the .text attribute to render the value formatted as a price.

{{ order.tax_lines[0].price.text }}

€7.44

The decimal value of the tax rate.

{{ order.tax_lines[0].rate }}

0.20

Use the .text attribute to render the value formatted as a percentage.

{{ order.tax_lines[0].rate.text }}

20 %

The name of the tax.

{{ order.tax_lines[0].title }}

GB VAT

Use the {% for transaction in order.transaction %} loop to iterate through all transactions of the order.

{% for transaction in order.transactions %} 
    {{ transaction.kind }} transaction: {{ transaction.amount.text }}<br>
{% endfor %}

If you only want to iterate through the sales transactions of the order, you can filter transactions by the value of their kind property using the select filter.

{% for transaction in order.transactions | select(property='kind', value='sale') %} 
    {{ transaction.kind }} transaction: {{ transaction.amount.text }}<br>
{% endfor %}

The amount of the transaction in the customer's local currency.

{{ order.transactions[0].amount }}

44.61

Use the .text attribute to render the value formatted as a price.

{{ order.transactions[0].amount.text }}

£44.61

The authorization code associated with the transaction.

{{ order.transactions[0].authorization }}

ch_1AtJu6CktlpKSclI4zjeQb2t

The autogenerated datetime (ISO 8601 format) when the transaction related to the order was created.

{{ order.transactions[0].created_time }}

2024-8-4 08:48:27+00:00

Use the text attribute or the format_date filter to render the value formatted as a date in a country-specific format.

{{ order.transactions[0].created_time.text }}

Aug. 4, 2024

The name of the company that issued the customer's payment card.

{{ order.transactions[0].credit_card_company }}

Visa

The customer's payment card number, with most of the leading digits redacted.

{{ order.transactions[0].credit_card_number }}

•••• •••• •••• 4242

The three-letter code (ISO 4217 format) of the currency used for the payment.

{{ order.transactions[0].currency }}

GBP

The handleized name of the payment gateway used for the transaction. A list of gateways can be found on Shopify's payment gateways page.

{{ order.transactions[0].gateway }}

shopify_payments

The ID of the transaction.

{{ order.transactions[0].id }}

5432242176065

The type of the transaction. Valid values are:

• authorization: An amount reserved against the cardholder's funding source. Money does not change hands until the authorization is captured.
• sale: An authorization and capture performed together in a single step.
• capture: A transfer of the money that was reserved during the authorization stage.
• void: A cancellation of a pending authorization or capture.
• refund: A partial or full return of captured funds to the cardholder. A refund can happen only after a capture is processed.

{{ order.transactions[0].kind }}

sale

A message generated by the payment gateway with additional information about why the transaction succeeded or failed.

{{ order.transactions[0].message }}

Payment marked as received

A transaction receipt attached to the transaction by the payment gateway, in the form of a dictionary data type. The key-value pairs of this property differ depending on the gateway you used for the processing of the payment.

{{ order.transactions[0].receipt }}

value: 44.61,
status: success

The status of the transaction. Valid values are:

• success
• pending
• failure
• error

{{ order.transactions[0].status }}

success

The calculated amount that was deducted from the order.total_price.

{{ order.discounts[0].amount }}

30.00

Use the .text attribute to render the value formatted as a price.

{{ order.discounts[0].amount.text }}

€30.00

When the associated discount application is of type code, this property returns the discount code that was entered at checkout. Otherwise this property returns the title of the discount that was applied.

{{ order.discounts[0].code }}

SUMMER15

The type of discount. Valid values are:

• fixed_amount: Applies the order.discount[#].amountas a unit of the store's currency. For example, if the amount is 30 and the store's currency is USD, then 30 USD is deducted from the order total when the discount is applied.
• percentage: Applies a discount of the order.discount[#].amount as a percentage of the order total.
• shipping: Applies a free shipping discount on orders that have a shipping rate less than or equal to the order.discount[#].amount. For example, if the amount is 30, then the discount will give the customer free shipping for any shipping rate that is less than or equal to $30.

{{ order.discounts[0].type }}

percentage

The method by which the discount application value has been allocated to entitled lines. Valid values are:

• across: The value is spread across all entitled lines.
• each: The value is applied onto every entitled line.
• one: The value is applied onto a single line.

{{ order.discount_applications[0].allocation_method }}

across

The discount code that was used to apply the discount. Available only for discount code applications.

{{ order.discount_applications[0].code }}

SUMMERSALE

The description of the discount application, as defined by the storeowner or the Shopify Script. Available only for manual and script discount applications.

{{ order.discount_applications[0].description }}

Loyalty

The lines on the order, of the type defined by the order.discount_applications[#].target_type that the discount is allocated over. Valid values are:

• all: The discount is allocated onto all lines.
• entitled: The discount is allocated only onto lines it is entitled for.
• explicit: The discount is allocated onto explicitly selected lines.

{{ order.discount_applications[0].target_selection }}

entitled

The type of line on the order that the discount is applicable on. Valid values are:

• line_item: The discount applies to line items.
• shipping_line: The discount applies to shipping lines.

{{ order.discount_applications[0].target_type }}

line_item

The title of the discount application, as defined by the storeowner. Available only for manual discount applications.

{{ order.discount_applications[0].title }}

Spring sale

The discount application type. Valid values are:

• automatic: The discount was applied automatically, such as by a Buy X Get Y automatic discount.
• discount_code: The discount was applied by a discount code.
• manual: The discount was manually applied by the storeowner (for example, by using an app or creating a draft order).
• script: The discount was applied by a Shopify Script.

{{ order.discount_applications[0].type }}

manual

How this value is interpreted depends on the order.discount_applications[#].value_type.

If the order.discount_applications[#].value_type is percentage and the intent was to apply a 20% discount, then the order.discount_applications.value will be 20.0.

If the order.discount_applications[#].value_type is fixed and the intent was to apply a $15 discount, then the order.discount_applications.value will be 15.0.

{{ order.discount_applications[0].value }}

5.0

Use the .text attribute to render the value formatted as a price or percentage.

{{ order.discount_applications[0].value.text }}

€5.00

The type of the value. Valid values are:

• fixed_amount: A fixed amount discount value in the currency of the order.
• percentage: A percentage discount value.

{{ order.discount_applications[0].value_type }}

fixed_amount

The type of selected payment terms template for the order.

{{ order.payment_terms.payment_terms_type }}

net

The name of the selected payment terms template for the order.

{{ order.payment_terms.payment_terms_name }}

Net 7

The number of days between the invoice date and due date that is defined in the selected payment terms template.

{{ order.payment_terms.due_in_days }}

7

The calculated date and time when the payment is due.

{{ order.payment_terms.due_at }}

2024-08-01T15:16:50Z

Use the text attribute or the format_date filter to render the value formatted as a date in a country-specific format.

{{ order.payment_terms.due_at.text }}

Aug. 01, 2024