Segment - admin-graphql - OBJECT

Version: 2024-01

Description:

A dynamic collection of customers based on specific criteria.

Access Scopes

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

Fields

• creationDate: DateTime! - The date and time when the segment was added to the store.
• id: ID! - A globally-unique ID.
• lastEditDate: DateTime! - The date and time when the segment was last updated.
• name: String! - The name of the segment.
• query: String! - A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers.

Connections

Related queries

• segment The Customer Segment.
• segments A list of a shop's segments.

Related mutations

• segmentCreate Creates a segment.
• segmentUpdate Updates a segment.

Related Unions

Examples