Skip to main content
object

Requires read_customers access scope. Also: The user must not have restricted access.

A group of customers that meet specific criteria defined through ShopifyQL query conditions. Common use cases for segments include customer analytics, targeted marketing campaigns, and automated discount eligibility.

The segment's query field contains ShopifyQL conditions that determine membership, such as purchase history, location, or engagement patterns. Tracks when the segment was created with creationDate and when it was last modified with lastEditDate.

DateTime!
non-null

The date and time when the segment was added to the store.

ID!
non-null

A globally-unique ID.

DateTime!
non-null

The date and time when the segment was last updated.

String!
non-null

The name of the segment.

String!
non-null

A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers.


Was this section helpful?

query

Retrieves a customer Segment by ID. Segments are dynamic groups of customers that meet specific criteria defined through ShopifyQL queries.

Use segments for targeted marketing campaigns, analyzing customer behavior, or creating personalized experiences. Each segment includes its name, creation date, and the query that defines which Customer objects belong to it.

query

Returns a paginated list of Segment objects for the shop. Segments are dynamic groups of customers that meet specific criteria defined through ShopifyQL queries. You can filter segments by search query and sort them by creation date or other criteria.

The query supports standard pagination arguments and returns a SegmentConnection containing segment details including names, creation dates, and the query definitions that determine segment membership.


Was this section helpful?

mutation

Creates a segment.

mutation

Updates a segment.


Was this section helpful?

interface

Was this section helpful?