Search Customers

Search for customer profiles in Shopify.

Options

Field	Definition	Type	Required
Result Set	Choose whether the search returns First Matching Record or All Matching Records	Dropdown	TRUE

Search results are sorted by dates associated with the Last Order ID field.

Input

Field	Definition	Type	FALSE
Customer
First Name	Customer's first name	String	FALSE
Last Name	Customer's last name	String	FALSE
Email	Customer's email address	String	FALSE
Phone	Customer's phone number	String	FALSE
State	State of the customer's account with the shop; options are: `enabled` `disabled` `invited` `declined`	Dropdown	FALSE
Accepts Marketing?	Indicates whether the customer has consented to receive marketing material via email	Boolean	FALSE
Tag	Tag that has been added to the customer	String	FALSE
Verified Email?	Indicates whether the customer has verified their email address	Boolean	FALSE
Multipass Identifier	Unique identifier for the customer that's used with Multipass login	String	FALSE
Address
First Name	Customer's first name	String	FALSE
Last Name	Customer's last name	String	FALSE
Company	Customer's company name	String	FALSE
Address1	Customer's first address line	String	FALSE
Address2	Customer's second address line	String	FALSE
City	Customer's city	String	FALSE
Province	Customer's province or state	String	FALSE
Country	Customer's country	String	FALSE
Custom Filter
Custom Filter	A custom search filter using query syntax across theShopify platform. The filter can employ connectives, terms, modifiers, and comparators. The filter can also perform a search using terms, field values, Boolean operators, ranges, or exclusions. For example, the query `query=-first_name:Bob AND orders_count:>1 orders_count:<=6` searches for customers with a first name of Bob who have had six or less (but more than one) orders. See Shopify API search syntax.	String	FALSE

A maximum of 250 records per page and a maximum of 550 pages can be returned in the search results.

Output

Field	Definition	Type
ID	Customer's globally unique identifier	Number
Email	Customer's email address	String
Accepts Marketing?	Indicates whether the customer has consented to receive marketing material via email	Boolean
Created At	Date and time when the customer profile was created	Date & Time
Updated At	Date and time when the customer profile was last updated	Date & Time
First Name	Customer's first name	String
Last Name	Customer's last name	String
Orders Count	Number of orders that the customer has made at the store in their lifetime	Number
State	State of the customer's account with the shop; options are: `enabled` `disabled` `invited` `declined`	String
Total Spent	Total amount that the customer has spent on orders in their lifetime	Number
Last Order ID	Globally unique identifier for the customer's last order	Number
Note	A note about the customer	String
Verified Email?	Indicates whether the customer has verified their email address	Boolean
Multipass Identifier	Unique identifier for the customer that's used with Multipass login	String
Tax Exempt?	Indicates whether the customer is exempt from paying taxes on their order	Boolean
Phone	Customer's phone number	String
Tags	Comma separated list of tags that have been added to the customer	String
Last Order Name	Unique identifier for the order that appears on the order. For example, `#1000` or `_Store1001`. This value is not unique across multiple stores.	String
Currency	Currency of the store	String

Addresses
ID	Unique identifier for the address object	Number
Customer ID	Customer's globally unique identifier	Number
First Name	Customer's first name	String
Last Name	Customer's last name	String
Company	Customer's company name	String
Address1	Customer's first address line	String
Address2	Customer's second address line	String
City	Customer's city	String
Province	Customer's province or state	String
Country	Customer's country	String
ZIP	Customer's zip code	String
Phone	Customer's phone number	String
Name	Customer's full name	String
Province Code	Customer's province code or state abbreviation	String
Country Code	Customer's country code	String
Country Name	Customer's normalized country name	String
Default?	Indicates whether the address is the customer's default address	Boolean

Accepts Marketing Updated At	Date and time when the customer consented or objected to receiving marketing material by email; set whenever the customer consents or objects to marketing material.	Date & Time
Marketing Opt in Level	Marketing subscription opt-in level (as described by the M3AAWG best practices guideline) that was enabled when the customer consented to receiving marketing material by email	String
Tax Exemptions	List of tax exemptions to apply to the customer	List of Text
GraphicQL API ID	Customer's unique identifier based on the pattern `//shopify/Customer/{customer_id}`	String

Default Address
ID	Unique identifier for the address object	Number
Customer ID	Customer's globally unique identifier	Number
First Name	Customer's first name	String
Last Name	Customer's last name	String
Company	Customer's company name	String
Address1	Customer's first address line	String
Address2	Customer's second address line	String
City	Customer's city	String
Province	Customer's province or state	String
Country	Customer's country	String
ZIP	Customer's zip code	String
Phone	Customer's phone number	String
Name	Customer's full name	String
Province Code	Customer's province code or state abbreviation	String
Country Code	Customer's country code	String
Country Name	Customer's normalized country name	String
Default?	Indicates whether the address is the customer's default address	Boolean

Search Customers

Options

Input

Output

Related topics