Choose a version:

customerSegmentMembers

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 Arguments

CustomerSegmentMemberConnection arguments

•CustomerSegmentMemberConnection!

Anchor to afterafter •String: The elements that come after the specified cursor.
Anchor to beforebefore •String: The elements that come before the specified cursor.
Anchor to firstfirst •Int: The first n elements from the paginated list.
Anchor to lastlast •Int: The last n elements from the paginated list.
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 email_subscription_status = 'SUBSCRIBED' with this syntax.
Anchor to queryIdqueryId •ID: The ID of the segment members query.
Anchor to reversereverse •Boolean Default:false: Reverse the order of the list. The sorting behaviour defaults to ascending order.
Anchor to segmentIdsegmentId •ID: The ID of the segment.
Anchor to sortKeysortKey •String: Sort the list by a given key. Valid values: • created_at - Sort by customer creation date • first_order_date - Sort by the date of the customer's first order • last_abandoned_order_date - Sort by the date of the customer's last abandoned checkout • last_order_date - Sort by the date of the customer's most recent order • number_of_orders - Sort by the total number of orders placed by the customer • amount_spent - Sort by the total amount the customer has spent across all orders

Use with the reverse parameter to control sort direction (ascending by default, descending when reverse=true).
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.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges •[CustomerSegmentMemberEdge!]! non-null: A list of edges.
Anchor to pageInfopageInfo •PageInfo! non-null: An object that’s used to retrieve cursor information about the current page.
Anchor to statisticsstatistics •SegmentStatistics! non-null: The statistics for a given segment.
Anchor to totalCounttotalCount •Int! non-null: The total number of members in a given segment.

Was this section helpful?