Setting Up a Customer Segment

A segment is a customer group defined by a rule expression. Once created, you can assign it as a condition on any promotion or rule to control who it applies to.

A segment belongs to one shop and one country. To target the same audience in several markets, create the segment in each.

For example: target customers who belong to the "GOLD" group and above the age of 38.

Segment Criteria

Segment criteria are written as rule expressions that evaluate against customer attributes. You can reference customer groups, customData fields, and customer IDs. customData fields are tenant-defined — check your shop's configuration for what is available. Combine or negate conditions using the operators below

Examples:

Target VIP customers in Germany with a high lifetime value:

typescript

Copy

Target any premium tier, excluding staff accounts:

typescript

Copy

Target loyal customers who have not yet reached VIP status:

typescript

Copy

Target customers from a specific market who registered recently:

typescript

Copy

Setting Up a Segment via the SCAYLE Panel

In the SCAYLE Panel, go to Customers ➜ Customer Segments. Here you can view all existing segments and create new ones.

Create a New Segment

• Select + New Segment (top right). If no segments exist yet, you can also select Create a Customer Segment.
• In the Segment name field, enter a unique name for the segment. This label is shown across the SCAYLE Panel wherever the segment is referenced.
• In the Reference key field, enter a stable identifier for use in API integrations.
• The Segment is active toggle is on by default. Turn it off to save the segment as a draft without making it available for use in promotions.
• Under Segment definition, choose how to build your rule:
  • Visual (default) – build conditions using attribute, operator, and value dropdowns.
  • Advanced – write the rule directly as a CEL (Common Expression Language) expression.

With the visual builder you have two options to define the audience: an AI prompt or manually selecting the conditions.

Build Conditions Manually

• Choose from the available customer attributes:

• Then select an operator (e.g., equals) and enter the value (e.g., True or False).

• To add more conditions to the same group, select + Add sub-condition. To add an independent group of conditions, select + Add rule group. Use the And / Or toggle at the top right of each group to control how its conditions are combined.

• When ready, select Save changes to save the new customer segment.

AI Prompt

• Type a plain-language description of your audience in the prompt field (for example, "not guests and newsletter subscribers") and submit.
• The SCAYLE Panel generates the matching conditions and populates them in Visual mode. A confirmation banner shows what was interpreted.
• You can then review and adjust the conditions as needed.

Edit a Segment

• Open the segment you want to update.
• Modify the name, reference key, or criteria as needed.
• Select Save changes. The updated rule takes effect immediately for all future evaluations.

Delete a Segment

• Open the segment you want to remove.
• Select Delete.
• If any promotions or rules reference this segment, the SCAYLE Panel lists them. Update or remove those references before confirming the deletion.

Setting Up a Segment via the Admin API

Customer segments are managed per shop and country via the Admin API at /shops/{shopKey}/countries/{countryCode}/customer-segments.

You can list segments (with optional filters and pagination), create new ones, fetch a single segment by its guid, update existing segments, or delete them. Each segment has a system guid, a business referenceKey, a human-readable name, a criteriaDsl rule string, and an active flag.

Customer segment endpoints in the Admin API:

All five are scoped to a shop and country. Single-segment operations use the segment's guid as {segmentGuid}.