Customers

Returns customer records, including contact, group, and account details.

Table Specific Information

Select

The driver uses the BigCommerce API to process WHERE clause conditions built with the following columns and operators:

Id supports the = and IN comparisons.
Company supports the = and IN comparisons.
Email supports the = and IN comparisons.
DateCreated supports the =, <, >, <=, and >= comparisons.
DateModified supports the =, <, >, <=, and >= comparisons.
CustomerGroup supports the = and IN comparisons.
RegistrationIpAddress supports the = and IN comparisons.

The rest of the filter is executed client-side within the driver.

For example, the following queries are processed server-side:

SELECT * FROM Customers WHERE Id = 1 

SELECT * FROM Customers WHERE Company = 'DemoFirst'

SELECT * FROM Customers WHERE Email = '[email protected]'

SELECT * FROM Customers WHERE DateCreated > '2021-09-01 11:25:37.0' 

SELECT * FROM Customers WHERE DateModified <= '2023-10-12 02:05:43.0'

Insert

To insert a customer, specify at least the following columns: FirstName, LastName, and Email.

INSERT INTO Customers (FirstName, LastName, Email) VALUES ('Testing4321', 'Test', '[email protected]')

Update

UPDATE Customers SET FirstName = 'testing345' WHERE Id = 5075

Delete

DELETE FROM Customers WHERE Id = 16

Columns


Name	Type	ReadOnly	Description
Id [KEY]	Integer	True	The unique numeric Id of this customer.
Company	String	False	The name of the company for which the customer works.
FirstName	String	False	The first name of the customer.
LastName	String	False	The last name of the customer.
Email	String	False	The email address of the customer.
Phone	String	False	The phone number of the customer.
DateCreated	Datetime	True	The date on which the customer registered from the storefront or was created in the control panel.
DateModified	Datetime	True	The date on which the customer was modified.
CustomerGroup	Integer	False	The group to which the customer belongs.
Notes	String	False	The store owner notes for the customer.
TaxExemptCategory	String	False	The tax-exempt category used to identify customers who fall into special sales-tax categories.
StoreCreditAmounts	Decimal	False	The amount of store credit associated with this customer.
RegistrationIpAddress	String	False	The IP address from which this customer was registered.
AcceptsProductReviewAbandonedCartEmails	Boolean	False	Indicates whether the customer has opted in to receive product review emails, abandoned cart emails, or both.
ForcePasswordReset	Boolean	True	Indicates whether the customer is required to change their password on the next login.
ChannelIds	String	False	The array of channel Ids the customer has access to.
FullName	String	True	The full name of the customer, combining the first and last names.
AddressCount	Integer	True	The total number of addresses associated with this customer.
AttributeCount	Integer	True	The total number of attributes associated with this customer.
OriginChannelId	Integer	False	The Id of the channel through which this customer account was created.