Skip to Content

Customer

The customer object describes a customer, including their name, contact information, order history, and preferences.

Usage Example

{%- comment -%} Show customer profile summary {%- endcomment -%} <p> Name: {{ customer.name }}<br> Email: {{ customer.username }}<br> Orders: {{ customer.order_count }}<br> Total Spent: {{ customer.order_total }} {{ customer.currency.symbol }} </p>

Properties

id

Unique identifier for the customer.

customer_number

The customer number assigned to this customer.

name

The full name of the customer.

address

Returns customers address.

tags

The tags associated with the customer.

has_access

Indicates if the customer has access rights to the store.

username

The username of the customer.

first_name

The first name of the customer.

last_name

The last name of the customer.

language

Returns customers language.

currency

Returns customers currency.

accepts_marketing

Indicates if the customer has accepted marketing communications.

orders

Returns customer orders

order_count

The total number of orders placed by the customer.

order_total

The total amount spent by the customer on orders.

refund_count

The total number of refunds issued to the customer.

refund_total

The total amount refunded to the customer.

first_order_date

The date and time of the customer’s first order, in RFC 2822 format.

last_order_date

The date and time of the customer’s most recent order, in RFC 2822 format.

audiences

The names of the audiences or segments the customer belongs to.

loyalty_discount_progress

Returns the progress of the customer towards the next loyalty discount in the following format:

  • title, the title of the loyalty discount
  • description, the description of the loyalty discount
  • total_spent, the total amount spent by the customer
  • is_stackable, whether the loyalty discount is stackable with other discounts
  • is_combinable, whether the loyalty discount is combinable with other discounts
  • is_fixed_discount, whether the loyalty discount is a fixed discount
  • current_level
    • discount, the discount of the current level
    • threshold, the threshold of the current level
    • valid_until, the date until which the current level is valid
  • next_level
    • discount, the discount of the next level
    • threshold, the threshold of the next level