customer

Properties

Anchor to

accepts_marketing

boolean

Returns true if the customer accepts marketing. Returns false if not.

Anchor to

addresses

array of address

All of the addresses associated with the customer.

Tip

Use the paginate tag to choose how many addresses to show at once, up to a limit of 20.

Anchor to

addresses_count

number

The number of addresses associated with the customer.

Anchor to

b2b?

boolean

Returns true if the customer is a B2B customer. Returns false if not.

To learn about B2B in themes, refer to Support B2B customers in your theme.

Anchor to

company_available_locations

array of company_location

The company locations that the customer has access to, or can interact with.

To learn about B2B in themes, refer to Support B2B customers in your theme.

Tip

Use the paginate tag to choose how many company locations to show at once, up to a limit of 100.

Anchor to

company_available_locations_count

number

The number of company locations associated with the customer.

Anchor to

current_company

company

The company that the customer is purchasing for.

To learn about B2B in themes, refer to Support B2B customers in your theme.

Anchor to

current_location

company_location

The currently selected company location.

To learn about B2B in themes, refer to Support B2B customers in your theme.

Anchor to

default_address

address

The default address of the customer.

Anchor to

email

string

The email of the customer.

Anchor to

first_name

string

The first name of the customer.

Anchor to

has_account

boolean

Returns true if the email associated with the customer is tied to a customer account. Returns false if not.

A customer can complete a checkout without making an account with the store. If the customer doesn't have an account with the store, then customer.has_account is false at checkout.

During the checkout process, if the customer has an account with the store and enters an email associated with an account, then customer.has_account is true. The email is associated with the account regardless of whether the customer has logged into their account.

Anchor to

has_avatar?

boolean

Returns true if an avatar is associated with a customer. Returns false if not.

A customer may have an avatar associated with their account, which can be displayed in the storefront.

Tip

Use with the avatar filter to render the customer's avatar.

Anchor to

id

number

The ID of the customer.

Anchor to

last_name

string

The last name of the customer.

Anchor to

last_order

order

The last order placed by the customer, not including test orders.

Anchor to

name

string

The full name of the customer.

Anchor to

orders

array of order

All of the orders placed by the customer.

Tip

Use the paginate tag to choose how many orders to show at once, up to a limit of 20.

Anchor to

orders_count

number

The total number of orders that the customer has placed.

Anchor to

payment_methods

array of customer_payment_method

The customer's saved payment methods.

Anchor to

phone

string

The phone number of the customer.

This phone number is only populated if the customer checks out using a phone number during checkout, opts in to SMS notifications, or if the merchant has manually entered it.

Anchor to

store_credit_account

store_credit_account

The store credit account associated with the customer.

The account shown will be in the currency associated with the customer’s current context. For example, if a customer is browsing the storefront in the US market, their USD store credit account will be returned. If they do not have a USD store credit account nil will be returned.

Anchor to

tags

array of string

The tags associated with the customer.

Anchor to

tax_exempt

boolean

Returns true if the customer is exempt from taxes. Returns false if not.

Anchor to

total_spent

number

The total amount that the customer has spent on all orders in the currency's subunit.

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

For currencies without subunits, such as JPY and KRW, tenths and hundredths of a unit are appended. For example, 1000 Japanese yen is output as 100000.

Tip

Use money filters to output a formatted amount.