Difference between revisions of "Liquid Template Variables - address"

From Spiffy Stores Knowledge Base

(New page: Address objects are found in order confirmation emails and the ''Additional Content & Scripts'' section of the Checkout. Example usage: Format an address object for displaying in a confi...)
 
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
Address objects are found in order confirmation emails and the ''Additional Content & Scripts'' section of the Checkout.
 
Address objects are found in order confirmation emails and the ''Additional Content & Scripts'' section of the Checkout.
 +
 +
Customers will also have one or more address objects.
  
 
Example usage:
 
Example usage:
Line 15: Line 17:
  
 
= Reference =
 
= Reference =
 +
 +
== <code>address.id</code> ==
 +
 +
A unique identifier for the Address.
  
 
== <code>address.name</code> ==
 
== <code>address.name</code> ==
  
Name of the addressee. You can also use address.first_name and address.last_name to access the individual parts if you want to display the customer name with special formatting.
+
Name of the addressee.
 +
 
 +
You can also use address.first_name and address.last_name to access the individual parts if you want to display the customer name with special formatting.
 +
 
 +
Example usage:
 +
 
 +
<pre>{{ billing_address.last_name }}, {{ billing_address.first_name }} => Bloggs, Fred</pre>
 +
 
 +
== <code>address.title</code> ==
 +
The title of the addressee.
 +
== <code>address.title_supplied</code> ==
 +
The customer has provided an honorific to be used as a title in the address.
 +
 
 +
== <code>address.first_name</code> ==
 +
 
 +
The first name of the addressee.
  
Example:
+
== <code>address.last_name</code> ==
  
{{ billing_address.last_name }}, {{ billing_address.first_name }} => Luetke, Tobias
+
The last name of the addressee.
  
 
== <code>address.street</code> ==
 
== <code>address.street</code> ==
  
Street address ( this is combined from address1 and address2 and can be used instead of those two seperate fields. )
+
The street address of the addressee.
 +
 
 +
This is a combined address, made up of both address1 and address2.
  
 
== <code>address.address1</code> ==
 
== <code>address.address1</code> ==
  
First line if the address
+
The first line of the address.
  
 
== <code>address.address2</code> ==
 
== <code>address.address2</code> ==
  
Second line if the address
+
The second line of the address. Nil is returned if a second address line does not exist.
  
 
== <code>address.company</code> ==
 
== <code>address.company</code> ==
  
Company if given
+
The company name, if supplied. Nil is returned if a company name does not exist.
  
 
== <code>address.city</code> ==
 
== <code>address.city</code> ==
  
City
+
The city of the addressee.
  
 
== <code>address.province</code> ==
 
== <code>address.province</code> ==
  
Province. Written out ( e.g. Oregon, British Columbia)
+
The full name of the province, state or region. This is not an abbreviated value. Nil is returned if a province, state or region does not exist.
 +
 
 +
== <code>address.province_code</code> ==
 +
 
 +
The standard ISO abbreviation for the province, state or region. Nil is returned if a province, state or region does not exist.
  
 
== <code>address.zip</code> ==
 
== <code>address.zip</code> ==
  
Zip or Postal code
+
The Zip or Postal code.
 +
 
 +
<pre>
 +
1234
 +
</pre>
  
 
== <code>address.country</code> ==
 
== <code>address.country</code> ==
  
Country. Written out ( e.g. United States, Canada)
+
The full name of the country. This is not an abbreviated value.
 +
 
 +
<pre>
 +
Australia
 +
</pre>
 +
 
 +
== <code>address.country_upper</code> ==
 +
 
 +
The full name of the country in upper case. This is not an abbreviated value.
 +
 
 +
<pre>
 +
AUSTRALIA
 +
</pre>
 +
 
 +
== <code>address.country_code</code> ==
 +
 
 +
The standard ISO abbreviation of the country.
 +
 
 +
<pre>
 +
AU
 +
</pre>
  
 
== <code>address.phone</code> ==
 
== <code>address.phone</code> ==
  
Phone number if supplied
+
The phone number, if supplied.
 +
 
 +
== <code>address.summary</code> ==
 +
 
 +
Returns a summary of the store's address:
 +
 
 +
<pre>
 +
123 Main Street, Sydney, New South Wales, Australia
 +
</pre>
 +
 
 +
The summary takes the form '''street, city, state/province, country'''.

Latest revision as of 15:17, 27 April 2022

Address objects are found in order confirmation emails and the Additional Content & Scripts section of the Checkout.

Customers will also have one or more address objects.

Example usage:

Format an address object for displaying in a confirmation email:

Shipping address:
  {{ shipping_address.name }}
  {{ shipping_address.street }}
  {{ shipping_address.city }}, {{ shipping_address.province }}  {{ shipping_address.zip }}
  {{ shipping_address.country }}
  {{ shipping_address.phone }}

Reference

address.id

A unique identifier for the Address.

address.name

Name of the addressee.

You can also use address.first_name and address.last_name to access the individual parts if you want to display the customer name with special formatting.

Example usage:

{{ billing_address.last_name }}, {{ billing_address.first_name }} => Bloggs, Fred

address.title

The title of the addressee.

address.title_supplied

The customer has provided an honorific to be used as a title in the address.

address.first_name

The first name of the addressee.

address.last_name

The last name of the addressee.

address.street

The street address of the addressee.

This is a combined address, made up of both address1 and address2.

address.address1

The first line of the address.

address.address2

The second line of the address. Nil is returned if a second address line does not exist.

address.company

The company name, if supplied. Nil is returned if a company name does not exist.

address.city

The city of the addressee.

address.province

The full name of the province, state or region. This is not an abbreviated value. Nil is returned if a province, state or region does not exist.

address.province_code

The standard ISO abbreviation for the province, state or region. Nil is returned if a province, state or region does not exist.

address.zip

The Zip or Postal code.

1234

address.country

The full name of the country. This is not an abbreviated value.

Australia

address.country_upper

The full name of the country in upper case. This is not an abbreviated value.

AUSTRALIA

address.country_code

The standard ISO abbreviation of the country.

AU

address.phone

The phone number, if supplied.

address.summary

Returns a summary of the store's address:

123 Main Street, Sydney, New South Wales, Australia

The summary takes the form street, city, state/province, country.