Order¶
The order variable represents a customer’s order. It is available on the following pages:
- delivery
id
¶
Unique ID for this order.
coupons
¶
All of the coupons applied to this order.
Note
Only one coupon can be applied to the cart at a time. It is an array to allow for future expansion.
customer
¶
The customer who made the order. Instance of a Customer object.
<p>Thanks for your order, {{ order.customer.first_name }}!</p>
Note
customer first_name
and last_name
are not available for some
free checkouts and for free downloads sent from the admin site. email
should be available for all checkouts.
custom_field_responses
¶
All of the custom field responses. Each item is an instance of a CustomFieldResponse.
total_price
¶
The order total. Includes taxes, shipping, and discounts.
subtotal_price
¶
The subtotal. Does not include taxes, shipping, or discounts.
tax_price
¶
Amount collected for taxes.
shipping_price
¶
Amount collected for shipping.
total_discount
¶
Total discounts.
currency
¶
Order currency. Three letter code (USD, GBP, etc).
ip_address
¶
IP address for the customer. Recorded at checkout.
created_at
¶
UNIX timestamp of when the order was created. Use the date
filter to format the date.
activated_at
¶
UNIX timestamp of when the order was paid. Use the date
filter to formate the date.
requires_shipping
¶
true
if this order requires product to be shipped to the customer.
has_files
¶
true
if one or more items
is delivered as a file.
has_keycodes
¶
true
if one or more items
is delivered as a keycode.
billing_firstname
¶
Billing first name.
billing_lastname
¶
Billing last name.
billing_street
¶
Billing street address line 1.
billing_street2
¶
Billing street address line 2.
billing_city
¶
Billing city.
billing_state
¶
Billing state or territory.
billing_postal_code
¶
Billing ZIP or postal code.
billing_country_code
¶
Billing country code. US
, GB
, CA
, etc.
billing_card_type
¶
Billing card type (if a card was used). Visa
, MasterCard
, etc.
billing_card_number
¶
Billing card number with the first 12 digits replaced by asterisks. ************1234
shipping_firstname
¶
Shipping first name.
shipping_lastname
¶
Shipping last name or surname.
shipping_street
¶
Shipping street address line 1.
shipping_street2
¶
Shipping street address line 2.
shipping_city
¶
Shipping city.
shipping_state
¶
Shipping state or territory.
shipping_postal_code
¶
Shipping ZIP or postal code.
shipping_country_code
¶
Shipping country code. US
, GB
, CA
, etc.
shipping_country
¶
Shipping country (long name). United States
, Great Britain
, Canada
, etc.
shipping_carrier
¶
Shipping carrier. UPS
, DHL
, USPS
, etc.
shipping_phone
¶
Shipping phone number.
shipping_business_name
¶
Shipping business name.
shipping_vatin
¶
Shipping VAT identification number.
tracking_number
¶
Tracking number for the shipping_carrier used.
next_billing_at
¶
UNIX timestamp of when the subscriber will be billed next was created. Use the date
filter to format the date. Only applies to subscription invoices.
next_billing_amount
¶
The amount your subscriber will be billed the next time they are billed. Only applies to subscription invoices.
marketing_optin
¶
true
if the customer opted to receive marketing communications.