View Source

List of customers. Represents information about a customers of the shop, such as the customer's contact details, their order history, and whether they've agreed to receive marketing material by email.

Field	Description
Can delete	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.
Created at	The date and time when the customer was added to the store.
Display name	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.
Email	The customer's email address.
First name	The customer's first name.
Has timeline comment	Whether the merchant has added timeline comments about the customer on the customer's page.
ID	Globally unique ID.
Last name	The customer's last name.
Legacy resource ID	The ID of the corresponding resource in the REST Admin API.
Lifetime duration	The amount of time since the customer was first added to the store. Example: 'about 12 years'.
Locale	The customer's locale.
Note	A note about the customer.
Number of orders	The number of orders that the customer has made at the store in their lifetime.
Phone	The customer's phone number.
State	The state of the customer's account with the shop.
Tags	A comma separated list of tags that have been added to the customer.
Tax exempt	Whether the customer is exempt from being charged taxes on their orders.
Tax exemptions	The list of tax exemptions applied to the customer.
Updated at	The date and time when the customer was last updated.
Valid email address	Whether the email address is formatted correctly. This does not guarantee that the email address actually exists.
Verified email	Whether the customer has verified their email address. Defaults to true if the customer is created through the Shopify admin or API.

A list of addresses associated with the customer.

Field	Description
City	The name of the city, district, village, or town.
Company	The name of the customer's company or organization.
Country	The name of the country.
Country code	The two-letter code for the country of the address. For example, US.
First line	The first line of the address. Typically the street address or PO Box number.
First name	The first name of the customer.
Formatted	A formatted version of the address, customized by the provided arguments.
Formatted area	A comma-separated list of the values for city, province, and country.
ID	Globally unique ID.
Last name	The last name of the customer.
Latitude	The latitude coordinate of the customer address.
Longitude	The longitude coordinate of the customer address.
Name	The full name of the customer, based on firstName and lastName.
Phone	A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.
Province	The region of the address, such as the province, state, or district.
Province code	The two-letter code for the region. For example, ON.
Second line	The second line of the address. Typically the number of the apartment, suite, or unit.
Zip	The zip or postal code of the address.

The total amount that the customer has spent on orders in their lifetime.

Field	Description
Amount	Decimal money amount.
Currency code	Currency of the money.

The default address associated with the customer.

Field	Description
City	The name of the city, district, village, or town.
Company	The name of the customer's company or organization.
Country	The name of the country.
Country code	The two-letter code for the country of the address. For example, US.
First line	The first line of the address. Typically the street address or PO Box number.
First name	The first name of the customer.
Formatted	A formatted version of the address, customized by the provided arguments.
Formatted area	A comma-separated list of the values for city, province, and country.
ID	Globally unique ID.
Last name	The last name of the customer.
Latitude	The latitude coordinate of the customer address.
Longitude	The longitude coordinate of the customer address.
Name	The full name of the customer, based on firstName and lastName.
Phone	A unique phone number for the customer. Formatted using E.164 standard. For example, +16135551111.
Province	The region of the address, such as the province, state, or district.
Province code	The two-letter code for the region. For example, ON.
Second line	The second line of the address. Typically the number of the apartment, suite, or unit.
Zip	The zip or postal code of the address.

The current email marketing state for the customer.

Field	Description
Consent updated at	The date and time at which the customer consented to receive marketing material by email.
Marketing opt-in level	The marketing subscription opt-in level, as described by the M3AAWG best practices guidelines, that the customer gave when they consented to receive marketing material by email.
Marketing state	The current email marketing state for the customer.

The image associated with the customer.

Field	Description
Alt text	A word or phrase to share the nature or contents of an image.
ID	Globally unique ID.
Original src	The location of the original image as a URL.
Transformed src	The location of the transformed image as a URL.

The customer's last order.

Field	Description
Order ID	Globally unique ID.

A list of metafields that belong to the resource.

Field	Description
Description	The description of a metafield.
Key	The key name for a metafield.
Legacy resource ID	The ID of the corresponding resource in the REST Admin API.
Metafield ID	Globally unique ID.
Namespace	The namespace for a metafield.
Owner type	Owner type of a metafield visible to the Storefront API.
Type	The type of data that the metafield stores in the value field.
Value	The value of a metafield.

A list of the customer's orders.

Field	Description
Order ID	Globally unique ID.

The current SMS marketing state for the customer's phone number.

Field	Description
Consent collected from	The source from which the SMS marketing information for the customer was collected.
Consent updated at	The date and time when the customer consented to receive marketing material by SMS. If no date is provided, then the date and time when the consent information was sent is used.
Marketing opt-in level	The marketing subscription opt-in level that was set when the customer consented to receive marketing information.
Marketing state	The current SMS marketing state for the customer.