Requires access scope.
Represents information about a customer of the shop, such as the customer's contact details, their order history, and whether they've agreed to receive marketing material by email.
Caution: Only use this data if it's required for your app's functionality. Shopify will restrict access to scopes for apps that don't have a legitimate use for the associated data.
Fields and connections
A list of addresses associated with the customer.
The addresses associated with the customer.
The total amount that the customer has spent on orders in their lifetime.
Whether the merchant can delete the customer from their store.
A customer can be deleted from a store only if they haven't yet made an order. After a customer makes an order, they can't be deleted from a store.
A list of the customer's company contact profiles.
The date and time when the customer was added to the store.
Whether the customer has opted out of having their data sold.
The default address associated with the customer.
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.
The customer's email address.
The current email marketing state for the customer. If the customer doesn't have an email address, then this property is
null.A list of events associated with the customer.
The customer's first name.
A globally-unique ID.
The image associated with the customer.
The customer's last name.
The customer's last order.
The ID of the corresponding resource in the REST Admin API.
The amount of time since the customer was first added to the store.
Example: 'about 12 years'.
The customer's locale.
The market that includes the customer’s default address.
Whether the customer can be merged with another customer.
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.A list of custom fields that a merchant associates with a Shopify resource.
A unique identifier for the customer that's used with Multipass login.
A note about the customer.
The number of orders that the customer has made at the store in their lifetime.
A list of the customer's orders.
A list of the customer's payment methods.
The customer's phone number.
Possible subscriber states of a customer defined by their subscription contracts.
The current SMS marketing state for the customer's phone number.
If the customer does not have a phone number, then this property is
null.The state of the customer's account with the shop.
Please note that this only meaningful when Classic Customer Accounts is active.
The statistics for a given customer.
Returns a list of store credit accounts that belong to the owner resource.
A list of the customer's subscription contracts.
A comma separated list of tags that have been added to the customer.
Whether the customer is exempt from being charged taxes on their orders.
The list of tax exemptions applied to the customer.
The URL to unsubscribe the customer from the mailing list.
The date and time when the customer was last updated.
Whether the email address is formatted correctly.
Returns
truewhen the email is formatted correctly and belongs to an existing domain. This doesn't guarantee that the email address actually exists.Whether the customer has verified their email address. Defaults to
trueif the customer is created through the Shopify admin or API.
Returns a Customer resource by ID.
Returns a list of customers.
Mutations
Add tax exemptions for the customer.
Create a new customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data requirements.
Update a customer's email marketing information information.
Sends a link to the customer so they can update a specific payment method.
Remove tax exemptions from a customer.
Replace tax exemptions for a customer.
Sends the customer an account invite email.
Update a customer's SMS marketing consent information.
Updates a customer's default address.
Update a customer's attributes. As of API version 2022-10, apps using protected customer data must meet the protected customer data requirements.