Customer


Describes a customer.

accepts_marketing

Returns true if customer has accepted marketing.

address

Returns customers address.

audiences

Returns the names of the audiences the customer belongs to.

currency

Returns customers currency.

customer_number

first_name

Returns customer first name.

first_order_date

Returns the date of the first order placed by the customer.

has_access

Returns true if user has been granted an access to this store.

id

Unique id for this customer.

language

Returns customers language.

last_name

Returns customer last name.

last_order_date

Returns the date of the last order placed by the customer.

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

name

Full name for this customer

order_count

Returns the total number of orders placed by the customer.

order_total

Returns the total amount spent by the customer.

orders

Returns customer orders

refund_count

Returns the total number of refunds made by the customer.

refund_total

Returns the total amount refunded by the customer.

tags

Returns customer tags

username

Returns customer username