context customer event

ecommerce

Type: object

Events made in e-commerce context

Name Type Description Example
client object {...}
store object {...}
user object {...}

client

Type: object

 

Name Type Description Example
userAgent string, null "example"
ip string
format: ipv4
"127.0.0.1"
localization object, null {...}

localization

Type: object,null

 

Name Type Description Example
city string "example"
country string "example"
region string "example"
province string "example"
zip string "example"
geo object {...}

geo

Type: object

The geographic location

Name Type Description Example
lat number Required. The latitude 42.0
lon number Required. The longitude 42.0

store

Type: object

 

Name Type Description Example
id string "example"
name string "example"
type string
one of: "AIRPORT", "ECOMMERCE", "FLAGSHIP", "FREE-STANDING", "MALL", "OUTLET", "RESORT", "SIS", "WAREHOUSE", "NOT-DEFINED"
"AIRPORT"
street string "example"
city string "example"
country string "example"
province string "example"
region string "example"
zip string "example"
geo object The geographic location {...}
website string "example"

user

Type: object

 

Name Type Description Example
id string Required. The identifier of the user "example"
externalId string, null The external identifier of the user "example"
username string, null The username of the user "example"
firstName string, null The first name of the user "example"
lastName string, null The last name of the user "example"
contacts object, null The contact information for the user {...}

contacts

Type: object,null

The contact information for the user

Name Type Description Example
email string, null The email address of the user
format: email
"firstname.lastname@example.com"
mobilePhone string, null The mobile phone number of the user "example"
phone string, null The phone number of the user "example"