Event Date

event_date

date

The date the customer event occurred. Based on the time zone of the shop at the moment of the event.

Event Day

event_date.day

date

The day on which the event occurred. Derived from event_date.

Event Week

event_date.week

date

The Sunday of the week during which the event occurred. Derived from event_date.

Event Month

event_date.month

date

The month during which the event occurred. Derived from event_date.

Event Quarter

event_date.quarter

date

The first month of the quarter during which the event occurred. Derived from event_date.

Event Year

event_date.year

date

The year during which the event occurred. Derived from event_date.

Address Line 1

address1

string

The first line of the customer's default address.

Example value: 764 Lake Sherwood Dr

Address Line 2

address2

string

The second line of the customer's default address.

Example value: Apt 603

Channel

channel

string

The channel or platform where the customer event occurred.

Example values: klaviyo, shopify, gorgias

City

city

string

The city of the customer's default address.

Example value: San Francisco

Coordinates Validated

coordinates_validated

boolean

Indicates whether the customer coordinates were successfully validated.

Possible values: true, false

Country

country

string

The country of the customer's default address.

Example values: United States, Finland, Canada

Country Code

country_code

string

The country code of the customer's default address, according to ISO 3166-1 alpha-2. See list of country codes

Example values: US, FI, CA

Customer Created Date

created_at

timestamp

The time at which the customer record was created. Formatted according to the ISO 8601 international standard.

Example value: 2019-05-22 21:01:29

Customer ID

customer_id

string

The unique identifier for the customer, assigned by the main sales platform.

Example value: 5209503793328

Customer Tags

customer_tags

repeated string

Tags associated with the customer, set in the main sales platform.

Example values: Active Subscriber, PayPal_user, Login with FB

Display Name

display_name

string

The display of the customer.

Example value: John Doe

Email Address

email_address

string

The primary email address associated with the customer’s account.

Example value: [email protected]

Email Marketing Consent Collected From

email_marketing_consent_collected_from

string

The source from which the customer's email marketing consent was collected.

Email Marketing Consent Opt-In Level

email_marketing_consent_opt_in_level

string

The level of consent provided by the customer for email marketing.

Example values: SINGLE_OPT_IN, UNKNOWN

Email Marketing Consent Updated Date

email_marketing_consent_updated_at

timestamp

The time at which the email marketing consent was updated. Formatted according to the ISO 8601 international standard.

Example value: 2019-05-22 21:01:29

external_customer_ids

record repeated

external_customer_ids.external_provider_id

string

external_customer_ids.external_profile_id

string

First Name

first_name

string

The customer's first name.

Example value: John

Last Name

last_name

string

The customer's last name.

Example value: Doe

Latitude

latitude

string

The latitude associated with the customer's location.

Example value: 34.1413713

Locale

locale

string

The locale setting associated with the customer's account.

Example values: en-US, en_GB, de

Longitude

longitude

string

The longitude associated with the customer's location.

Example value: -118.8639169

Note

note

string

Any note attached to the customer profile.

Phone

phone

string

The customer's phone number.

Example value: 18005550199

Product Subscriber Status

product_subscriber_status

string

The customer's subscription status for products.

Example values: ACTIVE, PAUSED, CANCELLED, NEVER_SUBSCRIBED

Provider Last Order ID

provider_last_order_id

string

The ID of the most recent order from the customer, according to the main sales platform.

Example value: 4930225799243

State

state

string

The state or province of the customer's default address.

Example values: Oregon, British Colombia, Michigan

State Code

state_code

string

The state or province code of the customer's default address.

Example values: OR, BC, MI

SMS Marketing Consent Collected From

sms_marketing_consent_collected_from

string

The source from which the customer's SMS marketing consent was collected.

SMS Marketing Consent Opt-In Level

sms_marketing_consent_opt_in_level

string

The level of consent provided by the customer for SMS marketing.

Example values: SINGLE_OPT_IN, CONFIRMED_OPT_IN

SMS Marketing Consent Status

sms_marketing_consent_status

string

The current status of the customer's SMS marketing consent.

SMS Marketing Consent Updated Date

sms_marketing_consent_updated_at

timestamp

The time at which the sms marketing consent was updated. Formatted according to the ISO 8601 international standard.

Example value: 2019-05-22 21:01:29

Predicted Spend Tier

statistic_predicted_spend_tier

string

A predicted tier for how much the customer is likely to spend.

Example values: LOW, MEDIUM, HIGH

Customer Status

status

string

The current status of the customer in the system.

Example values: INVITED, ENABLED, DISABLED, UNSUBSCRIBED, NEVER_SUBSCRIBED, DECLINED

Tax Exempt

tax_exempt

boolean

Whether the customer is exempt from tax.

Possible values: true, false

Customer Updated Date

updated_at

timestamp

The time at which the customer record was updated. Formatted according to the ISO 8601 international standard .

Example value: 2019-05-22 21:01:29

Valid Email Address

valid_email_address

boolean

Whether the email address has passed a validation check.

Possible values: true, false

Verified Email Address

verified_email_address

boolean

Whether the email address has been verified by the platform.

Possible values: true, false

Customer Zip Code

zip

string

The zip or postal code of the customer's defaults address.

Example values: 48104, 18235-2239, CH25 9BH