CustomerAddresses
List addresses associated with customers.
Table-Specific Information
Select
The server uses the Shopify API to process WHERE clause conditions built with the following column and operators. The server processes other filters client-side within the server.
- CustomerId supports the '=, IN' comparison operators.
For example, the following query is processed server-side:
SELECT * FROM CustomerAddresses WHERE CustomerId = 'Val1'
Insert
The following columns can be used to create a new record:
CustomerId, CustomerFirstName, CustomerLastName, Phone, Address1, Address2, CountryCode, ProvinceCode, City, Company, Zip
The following pseudo-column can be used to create a new record:
SetAsDefault
Update
The following columns can be updated:
CustomerId, CustomerFirstName, CustomerLastName, Phone, Address1, Address2, CountryCode, ProvinceCode, City, Company, Zip
The following pseudo-column can be used to update a record:
SetAsDefault
Delete
You can delete entries by specifying the following columns:
Id, CustomerId
Columns
| Name | Type | ReadOnly | References | Description |
| Id [KEY] | String | True |
A globally-unique ID. | |
| CustomerId | String | False |
A globally-unique ID. | |
| CustomerFirstName | String | False |
The first name of the customer. | |
| CustomerLastName | String | False |
The last name of the customer. | |
| CustomerName | String | True |
The full name of the customer, based on firstName and lastName. | |
| Phone | String | False |
A unique phone number for the customer. | |
| Address1 | String | False |
The first line of the address. Typically the street address or PO Box number. | |
| Address2 | String | False |
The second line of the address. Typically the number of the apartment, suite, or unit. | |
| CountryCode | String | False |
The two-letter code for the country of the address. For example, US. | |
| Country | String | True |
The name of the country. | |
| ProvinceCode | String | False |
The alphanumeric code for the region. For example, ON. | |
| Province | String | True |
The region of the address, such as the province, state, or district. | |
| City | String | False |
The name of the city, district, village, or town. | |
| Company | String | False |
The name of the customer's company or organization. | |
| FormattedArea | String | True |
A comma-separated list of the values for city, province, and country. | |
| Zip | String | False |
The zip or postal code of the address. | |
| Latitude | Double | True |
The latitude coordinate of the customer address. | |
| Longitude | Double | True |
The longitude coordinate of the customer address. | |
| TimeZone | String | True |
The time zone of the address. | |
| CoordinatesValidated | Bool | True |
Whether the address corresponds to recognized latitude and longitude values. | |
| ValidationResultSummary | String | True |
The validation status that is leveraged by the address validation feature in the Shopify Admin. |
Pseudo-Columns
Pseudo-columns are fields that can only be used in the types of statements under which they are explicitly listed. They are not standard columns but instead provide additional functionality for specific operations.
| Name | Type | Description |
| SetAsDefault | Bool |
Whether to set the address as the customer's default address. |