Customer
Requires access scope. Also: The user must not have restricted access.
The member of a segment.
Anchor to FieldsFields
- Anchor to amountSpentamount•Money
Spent V2 The total amount of money that the member has spent on orders.
- Anchor to defaultAddressdefault•Mailing
Address Address The member's default address.
- Anchor to defaultEmailAddressdefault•Customer
Email Address Email Address The member's default email address.
- Anchor to defaultPhoneNumberdefault•Customer
Phone Number Phone Number The member's default phone number.
- Anchor to displayNamedisplay•String!
Name non-null The full name of the member, which is based on the values of the
andfields. If the member's first name and last name aren't available, then the customer's email address is used. If the customer's email address isn't available, then the customer's phone number is used.- Anchor to firstNamefirst•String
Name The member's first name.
- •ID!non-null
The member’s ID.
- Anchor to lastNamelast•String
Name The member's last name.
- Anchor to lastOrderIdlast•ID
Order Id The ID of the member's most recent order.
- Anchor to mergeablemergeable•Customer
Mergeable! non-null Whether the customer can be merged with another customer.
- Anchor to metafieldmetafield•Metafield
A custom field, including its
namespaceandkey, that's associated with a Shopify resource for the purposes of adding and storing additional information.- Anchor to namespacenamespace•String
The container the metafield belongs to. If omitted, the app-reserved namespace will be used.
- •String!required
The key for the metafield.
Arguments
- Anchor to metafieldsmetafields•Metafield
Connection! non-null A list of custom fields that a merchant associates with a Shopify resource.
- Anchor to namespacenamespace•String
The metafield namespace to filter by. If omitted, the app-reserved namespace will be used.
- Anchor to keyskeys•[String!]
List of keys of metafields in the format
namespace.key, will be returned in the same format.- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to metafieldsByIdentifiersmetafields•[Metafield]!
By Identifiers non-null The metafields associated with the resource matching the supplied list of namespaces and keys.
- Anchor to identifiersidentifiers•[Has
Metafields Identifier!]! required The list of metafields to retrieve by namespace and key.
Arguments
- Anchor to notenote•String
A note about the member.
- Anchor to numberOfOrdersnumber•Unsigned
Of Orders Int64 The total number of orders that the member has made.
Anchor to QueriesQueries
- •query
A paginated list of customers that belong to an individual
Segment. Segments group customers based on criteria defined through ShopifyQL queries. Access segment members with their profile information and purchase summary data. The connection includes statistics for analyzing segment attributes (such as average and sum calculations) and a total count of all members. The maximum page size is 1000.- Anchor to segmentIdsegment•ID
Id The ID of the segment.
- Anchor to queryquery•String
The query that's used to filter the members. The query is composed of a combination of conditions on facts about customers such as
with this syntax.- Anchor to queryIdquery•ID
Id The ID of the segment members query.
- Anchor to timezonetimezone•String
The timezone that's used to interpret relative date arguments. The timezone defaults to UTC if the timezone isn't provided.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the list. The sorting behaviour defaults to ascending order.
- Anchor to sortKeysort•String
Key Sort the list by a given key. Valid values: •
- Sort by customer creation date •- Sort by the date of the customer's first order •- Sort by the date of the customer's last abandoned checkout •- Sort by the date of the customer's most recent order •- Sort by the total number of orders placed by the customer •- Sort by the total amount the customer has spent across all ordersUse with the
reverseparameter to control sort direction (ascending by default, descending when reverse=true).- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
Arguments