Choose a version:

Segment

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.

Anchor to FieldsFields

Anchor to creationDatecreationDate •DateTime! non-null: The date and time when the segment was added to the store.
Anchor to idid •ID! non-null: A globally-unique ID.
Anchor to lastEditDatelastEditDate •DateTime! non-null: The date and time when the segment was last updated.
Anchor to namename •String! non-null: The name of the segment.
Anchor to queryquery •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?

Anchor to QueriesQueries

Anchor to segment segment

•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.

Anchor to idid •ID! required: Find a segment by ID.

Anchor to segments segments

•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.

Arguments

Anchor to firstfirst

•Int

The first n elements from the paginated list.

Anchor to afterafter

•String

The elements that come after the specified cursor.

Anchor to lastlast

•Int

The last n elements from the paginated list.

Anchor to beforebefore

•String

The elements that come before the specified cursor.

Anchor to reversereverse

•Boolean

Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey

•SegmentSortKeys

Default:CREATION_DATE

Sort the underlying list by the given key.

Anchor to queryquery

•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to id •id: Filter by id range.
Anchor to name •string

Was this section helpful?

Anchor to MutationsMutations

Anchor to segmentCreate segmentCreate

•mutation

Creates a segment.

Anchor to namename •String! required: The name of the segment to be created. Segment names must be unique.
Anchor to queryquery •String! required: A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers such as email_subscription_status = 'SUBSCRIBED' with this syntax.

Anchor to segmentUpdate segmentUpdate

•mutation

Updates a segment.

Anchor to idid •ID! required: Specifies the segment to be updated.
Anchor to namename •String: The new name for the segment.
Anchor to queryquery •String: A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers such as email_subscription_status = 'SUBSCRIBED' with this syntax.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node •interface

Was this section helpful?