Skip to main content
object

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

A dynamic collection of customers based on specific criteria.

•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

The Customer Segment.

•query

A list of a shop's segments.


Was this section helpful?

•mutation

Creates a segment.

Arguments

•String!
required

The name of the segment to be created. Segment names must be unique.

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


Fields

•Segment

The newly created segment.

•[UserError!]!
non-null

The list of errors that occurred from executing the mutation.

•mutation

Updates a segment.

Arguments

•ID!
required

Specifies the segment to be updated.

•String

The new name for the segment.

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


Fields

•Segment

The updated segment.

•[UserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

•interface

Was this section helpful?