Customers
List of customers.
View-Specific Information
Select
The driver uses the Shopify API to process WHERE clause conditions built with the following column and operator. The driver processes other filters client-side within the driver.
- Id supports the '=' comparison.
- Email supports the '=' comparison.
- UpdatedAt supports the '>=,<=,=' comparison.
- AcceptsMarketing supports the '=' comparison.
- OrdersCount supports the '=,>,<,>=,<=' comparison.
- Phone supports the '=' comparison.
- State supports the '=' comparison.
- TotalSpent supports the '=' comparison.
SELECT * FROM Customers
SELECT * FROM Customers WHERE Id = '123'
SELECT * FROM Customers WHERE UpdatedAt = '2017-10-25'
SELECT * FROM Customers WHERE UpdatedAt <= '2017-10-25'
SELECT * FROM Customers WHERE UpdatedAt >= '2017-10-25'
SELECT * FROM Customers WHERE Email = '[email protected]'
SELECT * FROM Customers WHERE OrdersCount = 5
SELECT * FROM Customers WHERE Phone = '999999999'
SELECT * FROM Customers WHERE State = 'State1'
You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any search criteria will be ignored and an unfiltered response will be returned.
Columns
Name | Type | References | Description |
Id [KEY] | String | Globally unique identifier. | |
FirstName | String | The customer's first name. | |
LastName | String | The customer's last name. | |
String | The customer's email address. | ||
DisplayName | String | The full name of the customer, based on the values for first_name and last_name. If the first_name and last_name are not available, then this falls back to the customer's email address, and if that is not available, the customer's phone number. | |
CreatedAt | Datetime | The date and time when the customer was added to the store. | |
UpdatedAt | Datetime | The date and time when the customer was last updated. | |
LastOrderId | String |
Orders.Id | The Id of the customer's last order. |
AcceptsMarketing | Boolean | Whether the customer has agreed to receive marketing materials. | |
AcceptsMarketingUpdatedAt | Datetime | The date and time when the customer consented or objected to receiving marketing material by email. | |
AverageOrderAmount | Decimal | The average amount that the customer spent per order. | |
AverageOrderAmountCurrency | String | The currency of the average amount that the customer spent per order. | |
CanDelete | Boolean | Whether the merchant can delete the customer from their store. A customer can be deleted from a store only if they have not yet made an order. After a customer makes an order, they can't be deleted from a store. | |
DefaultAddress1 | String | The first line of the address. Typically the street address or PO Box number. | |
DefaultAddress2 | String | The second line of the address. Typically the number of the apartment, suite, or unit. | |
DefaultAddressCity | String | The name of the city, district, village, or town. | |
DefaultAddressCompany | String | The name of the customer's company or organization. | |
DefaultAddressCountry | String | The name of the country. | |
DefaultAddressCountryCode | String | The two-letter code for the country of the address. For example, US. | |
DefaultAddressFirstName | String | The first name of the customer. | |
DefaultAddressFormattedArea | String | A comma-separated list of the values for city, province, and country. | |
DefaultAddressId | String | Globally unique identifier. | |
DefaultAddressLastName | String | The last name of the customer. | |
DefaultAddressLatitude | Double | The latitude coordinate of the customer address. | |
DefaultAddressLongitude | Double | The longitude coordinate of the customer address. | |
DefaultAddressName | String | The full name of the customer, based on firstName and lastName. | |
DefaultAddressPhone | String | A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111. | |
DefaultAddressProvince | String | The region of the address, such as the province, state, or district. | |
DefaultAddressProvinceCode | String | The two-letter code for the region. For example, ON. | |
DefaultAddressZip | String | The zip or postal code of the address. | |
HasNote | Boolean | Whether the customer has a note associated with them. | |
HasTimelineComment | Boolean | Whether the merchant has added timeline comments about the customer on the customer's page. | |
LegacyResourceId | Long | The ID of the corresponding resource in the REST Admin API. | |
LifetimeDuration | String | The amount of time since the customer was first added to the store. Example: 'about 12 years'. | |
Locale | String | The customer's locale. | |
MarketingOptInLevel | String | The marketing subscription opt-in level (as described by the M3AAWG best practices guideline) that the customer gave when they consented to receive marketing material by email. If the customer does not accept email marketing, then this property will be null. | |
Note | String | A note about the customer. | |
OrdersCount | Long | The number of orders that the customer has made at the store in their lifetime. | |
Phone | String | The customer's phone number. | |
State | String | The state of the customer's account with the shop.
The allowed values are DECLINED, DISABLED, ENABLED, INVITED. | |
TaxExempt | Boolean | Whether the customer is exempt from being charged taxes on their orders. | |
TotalSpentAmount | Decimal | The total amount that the customer has spent on orders in their lifetime. | |
TotalSpentCurrency | String | The currency of the total amount that the customer has spent on orders in their lifetime. | |
ValidEmailAddress | Boolean | Whether the email address is formatted correctly. This does not guarantee that the email address actually exists. | |
VerifiedEmail | Boolean | Whether the customer has verified their email address. |