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	Required
Customer
First Name	Customer's first name.	Text	FALSE
Last Name	Customer's last name.	Text	FALSE
Email	Customer's email address.	Text	FALSE
Phone	Customer's phone number.	Text	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.	True/False	FALSE
Tag	Tag that has been added to the customer.	Text	FALSE
Verified Email?	Indicates whether the customer has verified their email address.	True/False	FALSE
Multipass Identifier	Unique identifier for the customer that's used with Multipass login.	Text	FALSE
Address
First Name	Customer's first name.	Text	FALSE
Last Name	Customer's last name.	Text	FALSE
Company	Customer's company name.	Text	FALSE
Address1	Customer's first address line.	Text	FALSE
Address2	Customer's second address line.	Text	FALSE
City	Customer's city.	Text	FALSE
Province	Customer's province or state.	Text	FALSE
Country	Customer's country.	Text	FALSE
Custom Filter
Custom Filter	A custom search filter using query syntax across the Shopify 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.	Text	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.	Text
Created At	Date and time when the object was created.	Date & Time
Updated At	Date and time when the customer profile was last updated.	Date & Time
First Name	Customer's first name.	Text
Last Name	Customer's last name.	Text
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	Text
Total Spent	Total amount that the customer has spent on orders in their lifetime.	Text
Last Order ID	Globally unique identifier for the customer's last order.	Number
Note	A note about the customer.	Text
Verified Email?	Indicates whether the customer has verified their email address.	True/False
Multipass Identifier	Unique identifier for the customer that's used with Multipass login.	Text
Tax Exempt?	Indicates whether the customer is exempt from paying taxes on their order.	True/False
Phone	Customer's phone number.	Text
Tags	Comma separated list of tags that have been added to the customer.	Text
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.	Text
Currency	Currency of the store.	Text
Addresses
ID	Unique identifier for the address object.	Number
Customer ID	Customer's globally unique identifier.	Number
First Name	Customer's first name.	Text
Last Name	Customer's last name.	Text
Company	Customer's company name.	Text
Address1	Customer's first address line.	Text
Address2	Customer's second address line.	Text
City	Customer's city.	Text
Province	Customer's province or state.	Text
Country	Customer's country.	Text
ZIP	Customer's zip code.	Text
Phone	Customer's phone number.	Text
Name	Customer's full name.	Text
Province Code	Customer's province code or state abbreviation.	Text
Country Code	Customer's country code.	Text
Country Name	Customer's normalized country name.	Text
Default?	Indicates whether the address is the customer's default address.	True/False
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}.	Text
Default Address
ID	Unique identifier for the address object.	Number
Customer ID	Customer's globally unique identifier.	Number
First Name	Customer's first name.	Text
Last Name	Customer's last name.	Text
Company	Customer's company name.	Text
Address1	Customer's first address line.	Text
Address2	Customer's second address line.	Text
City	Customer's city.	Text
Province	Customer's province or state.	Text
Country	Customer's country.	Text
ZIP	Customer's zip code.	Text
Phone	Customer's phone number.	Text
Name	Customer's full name.	Text
Province Code	Customer's province code or state abbreviation.	Text
Country Code	Customer's country code.	Text
Country Name	Customer's normalized country name.	Text
Default?	Indicates whether the address is the customer's default address.	True/False
Email Marketing Consent
State	The current email marketing state for the customer.	Text
Opt In Level	The marketing subscription opt-in level, as described in the M3AAWG Sender Best Common Practices, that the customer gave when they consented to receive marketing material by email.	Text
Updated At	Date and time when the customer consented to receive marketing material by email. If no value is provided, then the date and time when the consent information was sent is used.	Date & Time
SMS Marketing Consent
State	The current SMS marketing state for the customer.	Text
Opt In Level	The marketing subscription opt-in level, as described in the M3AAWG Sender Best Common Practices, that was set when the customer consented to receive marketing information.	Text
Updated At	Date and time when the customer consented to receive marketing material by SMS. If no value is provided, then the date and time when the consent information was sent is used.	Date & Time
Collected From	The source from which the SMS marketing information for the customer was collected.	Text

Search Customers

Options

Input

Output

Related topics