Shopper

Shopper model schema

Attributes

All attributes for the shopper are optional.

Attribute

Type

Example

Description

customer_id

String or Integer

"customer-123"

ID of the customer on your store/site platform.

customer_id_token

String

"lkjsddks034a"

Encrypted token for the customer ID.

If this is specified then you should not specify thecustomer_id attribute.

name

String

"John Doe"

The full name of the shopper

email

String

"john.doe@xample.com"

The email address of the current shopper.

country_code

String

"US", "CA"

ISO Alpha-2 country code. See this page for reference of all country codes.

region_name

String

"California", "Ontario"

This is this the state, province or region name (not abbreviation).

city_name

String

"Orange County", "Waterloo", "Austin"

The is the name of the city.

zip

String

"78730", "N1L 3R9"

Postal code or zip of the shopper's location.

Sample Payload

{
customer_id: "customer-123",
customer_id_token: "SOME_ENCRYPTED_CUSTOMER_ID",
name: "John Doe",
email: "john.doe@example.com",
country_code: "US",
region_name: "California",
city_name: "Orange County",
zip: "78730",
// These are custom attributes:
favorite_color: "red",
shirt_size: "medium"
}

Custom Attributes

The shopper model can take any attributes you want that are not listed in the attributes above and it will automatically save them as custom attributes that you can reference and personalise based no in the future.