3PACustomerInformationFields Customer

Fields - Customer

Fields

Field NameData TypeDescription, Example
CmfstringLightspeed Dealer Identifier
DealerIdstringInternal Dealer Identifier (intentionally left blank)
CustomerId (key)bigintInternal ID of customer
storenamestringDisplays the store this customer record belongs to
DateGathereddatetimeDate when customer record was last updated
CustFullNamestringFull name of customer
FirstNamestringFirst name of customer
MiddleNamestringMiddle name of customer
LastNamestringLast name of customer
attentionstringAttention field of the customer record
CompanynamestringCompany Name on record
Address1stringAddress of customer
Address2stringAdditional address of customer
CitystringCity of customer location
StatestringState/Province of customer location
ZipstringZip code of customer
CountystringCounty of customer location
CountrystringCountry of customer location
AlternateAddress1stringAlternate address of customer
Alternate Address2stringAdditional alternate address of customer
AlternateCitystringAlternate city of customer location
AlternateStatestringAlternate State/Province of customer location
AlternateZipstringAlternate Zip code of customer
AlternateCountystringAlternate County of customer location
AlternateCountrystringAlternate Country of customer location
HomePhonestringHome phone of customer
WorkPhonestringWork phone of customer
CellPhonestringCell phone of customer
EMailstringMust match ‘something@something.domain’ or a blank will be returned
BirthdatedateBirthdate of customer
HasDriversLicenseNumbertinyint1 – Yes, 0 - No
LoyaltyCustomertinyint0 – Not on Loyalty 1 – Has Loyalty
CustomerTypestringDealer assigned customer type
optoutmarketingbooleanWhen true the dealership will not market directly to the customer
optoutsharedatabooleanWhen true the dealership will not share customer data with third parties
optoutselldatabooleanWhen true the dealership will not sell customer data to third parties
removepersonalinformationbooleanWhen true the dealership has removed personal information from the customer record
commentsstringDealer entered comments added to customer record
optoutlimitusebooleanWhen true, only limited use of the customer record is allowed.

Notes

Notes:

  1. Use DateGathered to determine changes
  2. If optoutsharedata or removepersonalinformation are true then no data will be returned for the customer other than the CustomerId. All other fields will be blank or null.
  3. The Customer endpoint will display ALL customer records in the Lightspeed instance. To filter out customers that apply to a particular store you must filter by store name.