Customer Data Schema Specifications

Use this specification to format your customer information prior to submitting to Listrak. Submitting your data to Listrak in the right format is important for delivering successful campaigns and insights.

Please also use the following schema specifications for other data objects:

Click here for Customer Data sample file

Attribute
(Column)
Format
Requirements and Suggestions
ATTRIBUTE (COLUMN)
email
FORMAT

Attribute Description
The customer's email address

Example
jmiller@gmail.com

Syntax
String
Max. 100 characters

Requirements and Suggestions
  • This attribute is required as a primary key and must be included for every customer.
ATTRIBUTE (COLUMN)
customernumber
FORMAT

Attribute Description
The customer's unique identifier

Example
18941316

Syntax
String
Max. 20 characters

Requirements and Suggestions
  • If you provide order data from multiple sources (Listrak integrations, REST API, data file feed), the customernumber you supply must be consistent across all sources.
  • customernumber can be used as an alternative method of customer lookup in Listrak CRM.
ATTRIBUTE (COLUMN)
mobilephone
FORMAT

Attribute Description
The customer's mobile phone number

Example
17175559636

Syntax
String
E.164 formatting

Requirements and Suggestions
ATTRIBUTE (COLUMN)
birthday
FORMAT

Attribute Description
The customer's birth date

Example
1989-01-16

Syntax
Date
ISO 8601

Requirements and Suggestions
  • Format date as YYYY-MM-DD
  • Date must be between 1900-01-01 and current date.
ATTRIBUTE (COLUMN)
gender
FORMAT

Attribute Description
The customer's gender

Example
F

Syntax
Single character

Supported Value
M (Male)
F (Female)
N (Neither/Not Applicable)

Requirements and Suggestions
  • If a gender is not supplied for a customer, Listrak will autodetect gender based on first name, when available.
ATTRIBUTE (COLUMN)
firstname
FORMAT

Attribute Description
The customer's first name

Example
Jane

Syntax
String
Max. 50 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
lastname
FORMAT

Attribute Description
The customer's last name

Example
Miller

Syntax
String
Max. 50 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
address1
FORMAT

Attribute Description
The first line of the customer's address

Example
529 Maple Avenue

Syntax
String
Max. 255 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
address2
FORMAT

Attribute Description
The second line of the customer's address

Example
Apartment 39

Syntax
String
Max. 255 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
address3
FORMAT

Attribute Description
The third line of the customer's address

Syntax
String
Max. 255 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
city
FORMAT

Attribute Description
The city of the customer

Example
Philadelphia

Syntax
String
Max. 40 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
state
FORMAT

Attribute Description
The abbreviated state of the customer

Example
PA

Syntax
String
Max. 3 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
zipcode
FORMAT

Attribute Description
The customer's zip code

Example
19103

Syntax
String
Max. 20 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
country
FORMAT

Attribute Description
The abbreviated country of the customer

Example
US

Syntax
String
Max. 2 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
preferredstorenumber
FORMAT

Attribute Description
The customer's preferred store number

Example
54975

Syntax
String
Max. 100 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
registered
FORMAT

Attribute Description
Indicates if the customer has a saved account on your brand's website

Example
true

Syntax
Boolean

Supported Values
true
false
null

Requirements and Suggestions
ATTRIBUTE (COLUMN)
meta1
FORMAT

Attribute Description
Supplemental customer information

Syntax
String
Max. 500 characters

Requirements and Suggestions
  • Supply a custom value describing the customer that can be used for enhanced Listrak CRM reporting or solution functionality.
  • This field can also be a comma delimited list and has operations such as equals, contains, is not blank, etc. associated to it for additional operational level performance in Listrak and Listrak CRM.
  • Though you may add boolean values to this field, it is of string type and will not convert to provide operations such as is true or is false.
ATTRIBUTE (COLUMN)
meta2
FORMAT

Attribute Description
Supplemental customer information

Syntax
String
Max. 500 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
meta3
FORMAT

Attribute Description
Supplemental customer information

Syntax
String
Max. 500 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
meta4
FORMAT

Attribute Description
Supplemental customer information

Syntax
String
Max. 500 characters

Requirements and Suggestions
ATTRIBUTE (COLUMN)
meta5
FORMAT

Attribute Description
Supplemental customer information

Syntax
String
Max. 500 characters

Requirements and Suggestions