Skip to main content

Choose a version:

Segment

object

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

A dynamic collection of customers based on specific criteria.

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: The Customer Segment.
Anchor to segments segments •query: A list of a shop's segments.

Was this section helpful?

Anchor to MutationsMutations

•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 segmentsegment •Segment: The newly created segment.
Anchor to userErrorsuserErrors •[UserError!]!non-null: The list of errors that occurred from executing the mutation.

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

Anchor to segmentsegment •Segment: The updated segment.
Anchor to userErrorsuserErrors •[UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node •interface

Was this section helpful?