Skip to content

Customers Object



id
string

The unique identifier for customer

first_name
string

The first name of customer

last_name
string

The last name of customer

name
string

The full name of customer

company_name
string

The company name of customer

status
string

The status of customer. If no clear mapping exists, then raw value is returned.

All possible enum values:
  • active
  • inactive
currency
string

The currency associated to customer

emails
object[]

The emails of customer

email
string
REQUIRED · 

The email of the customer

type
string

The type of email

is_primary
boolean

The status of email

phones
object[]

The phone numbers of customer

number
string
REQUIRED · 

The number of phone

extension
string

The extension of the phone number

type
string

The type of phone

addresses
object[]

The addresses of a customer

type
string

The type of an address of a customer

id
string

The unique identifier of an address of a customer

street_1
string

The first line of address of a customer

street_2
string

The second line of address of a customer

city
string

The city of the address of a customer

state
string

The state/province of the address of a customer

postal_code
string

The postal code of the address of a customer

country
string

The country of the address of a customer

orders
object[]

The orders of customer

id
string

The id of orders of the customer

total
string

The total amount of orders of email

status
string

The status of orders of the customer

created_at
string · date-time

The date and time when customer was created

updated_at
string · date-time

The date and time when customer was updated

remote_data
object

Raw data returned from the remote API call.