Segmentation

Written By Devin O'Neill ()

Updated at August 21st, 2025

Summary

  • The Segmentation module is used to differentiate members into groups, which are then used in other loyalty modules, such as campaigns or rewards.
  • Grouping customers together by similar interests or common traits allows you to create more relatable campaign material, communications, and rewards.
  • Define segments and conditions and use them to incentivize members.
  • Refer to the Multi-Templates for further information about the Multi-Template module.

In the Annex Cloud LEP, you can locate the Segmentation module under the 'Products' tab in the top left of your screen. On the 'Your Products' page, click Go underneath the Segmentation file. 

Navigation: Products > Segmentation

Capabilities

The Segmentation module enables marketers to create and modify segments for their loyalty program. In the Segments module, they are provided with a tabular view of all available segments present in the system. The screenshot below shows the available actions related to segment management.

  1. Add New Segments: New segments can be configured by clicking Add New Segment. Configuration steps are explained in greater detail below.
  2. Search Box: The search box allows the administrator to search for any keywords related to previously configured segments. The advanced search capability is available by clicking on the drop-down icon in the search box. Here, you can enter your custom search parameters to complete a search. The following 'Search' option screen displays: 
  • Segment Name: Enter the applicable segment name.
  • Segment ID: Enter the applicable segment ID.
  • Members in Segment: Segments can be searched based on the number of members that are qualified for the segment. Use the Greater Than option to search for segments larger than the entered value.


 

You can also search by selecting the ‘Range’ option and entering a lower value and a higher value. For example, you could search for segments with a member population between 25 and 55 members.

 

 

  • Created Within: Select the segment creation period. There are two options here. One is available in the drop-down list with options such as 1 Day, 1 Week, and 1 Month, and the other one is the custom date range. Please note that there is an OR condition, so you can only search using either the calendar range option or the drop-down list.


Once you have entered the search criteria for the Segments, click Search and the applicable records display on the Segments home page.

  1. Export Button: Administrators can export a list of the presently set segments in CSV or Excel format using the Export functionality. 
  2. Status: Within the Status field, a segment can be turned on or off throughout the system. If the status is OFF, then the segment will not be shown against the Site ID and UID. If ON is selected, the segment is available to leverage within the program.

When disabling or deleting a segment, if the segment is not associated with any active campaign or reward, a warning message displays confirming the administrator wants to proceed, shown as follows:

When disabling or deleting a segment, if the segment is associated with any active campaign or reward, the system will prevent the administrator from disabling or deleting the segment. The linked data is shown in the warning message, to ensure the administrator knows where the associated campaign or reward is located. The warning message appears as follows:

Segments cannot be deleted if a campaign has expired but the backdated order flag is on. Typically, segments linked to expired campaigns can be deleted or disabled without prompt. However, if a campaign is both active and expired, then the campaign needs to be manually removed from the segment in order to either disable or delete it.

  1. Action: The Action column provides four functionalities for configured segments:
    • Edit: This function allows the administrator to edit any aspect of a segment.
    • Audit: This tracks and logs various changes that are occurring within segment configuration, such as when a segment is created, what changes have been made to the segment, and which user made the updates.
    • Clone: A copy of the segment information can be created.
    • Delete: A record can be deleted.

Configuring a Segment

Creating a New Segment

When configuring a new segment, click Add New Segment from the Segmentation section. Administrators are presented with a form to capture all the necessary details for the segment.

Field Name Explanation
Segment Name Enter the applicable name for the new segment.
Additional Segment Options
Description Enter the description of the segment.
Tagline Use the text editor to enter a tagline or catchphrase for the segment.
Terms and Conditions Use the text editor to enter the segment terms and conditions.

Segment Conditions: The criteria members must meet to qualify for the segment.

Administrators have the option to use both AND & OR operations within the segmentation conditions.

  • When the AND condition is used, both conditions must be met to qualify for the segment.
  • When the OR condition is used, at least one of the conditions must be met to qualify for the segment.

When certain segment conditions are selected from the ‘Event’ drop-down list, they will not display again as a selectable option when configuring additional conditions in the same segment. Below is the list of single-use segment conditions:

  • Members
  • Zip Code
  • Amount Spend
  • Available Points
  • Lifetime Points
  • Redeemed Points
  • Earned Points
Action
  1. Action Rule: Action Rules are defined actions that you can use to make calculations on action performance or completed actions for your configured campaign. From the ‘Action Rule’ drop-down list, select an Action Rule to be applied. Select an action from the dropdown. Both the action name and action ID are displayed for selection. You can configure certain conditions for the action, such as ‘Action completed’ or ‘Action not completed’ in the ‘Conditions’ drop-down list. The ‘Details’ drop-down list lets you configure a condition you set for the value, such as ‘Greater Than' or ‘Equals’ the value defined.
    The ‘Time Window’ drop-down list lets you configure the time frame for the segment for when the action has or has not been completed by the member. Selecting both the ‘Before’ and ‘After’ options make the ‘Start Date’ calendar date field appear. Selecting the ‘Between’ option makes the ‘Start Date’ and ‘End Date’ fields appear so you can configure a specific date range.
     

  1. Action Series: Use the Action Series condition to run a campaign for members who have completed, not completed, or partially completed predefined actions in the loyalty program. From the Action Series Name drop-down list, select the applicable action series. In the Condition drop-down, select the applicable completion status of the action series. The ‘Time Window’ drop-down list lets you configure the time frame for the segment for when the action series has or has not been completed by the member. Selecting both the ‘Before’ and ‘After’ options makes the ‘Start Date’ calendar date field appear. Selecting the ‘Between’ option makes the ‘Start Date’ and ‘End Date’ fields appear, so you can configure a specific date range.
Members
  1. Members: Select the member group to include in the segment. The members can either come from an uploaded CSV file containing member user IDs or can a member group from an existing segment nested into the new segment.
    Note: Any loyalty program member, regardless of their opt-in status, can be uploaded in the member segment. Non-members can also be uploaded as users within a segment.

    Once you’ve made a selection for how you want to add members (for example, you’ve selected the ‘Upload Members List’ option), selecting the other option prompts a confirmation message to display:

This notification reminds the administrator that the previously defined group of members will be replaced by the new selection. Only one member group option is configurable at any given time.

Note: The Members segment condition is only configurable with the ‘AND’ condition. The ‘OR’ condition does not apply.

  1. Zip Code: Use the Zip Code condition to target members with a specific zip code defined as part of a member’s information given during loyalty program enrollment. In the Zip Code Value field, enter the applicable zip code associated with the member population.
    From the Time Window drop-down list, you must also select a time period (all time, before, after, between) for members with an associated zip code and then choose the applicable calendar start and end dates.
  2. Extended Attribute: Use the Extended Attribute condition to target members with defined user attributes already configured under the Additional Loyalty Settings in the loyalty program. From the Attribute Name drop-down list, select the applicable attribute. In the Attribute Value field, enter an applicable value (such as ‘Yes’ or ‘No’).
Orders
  1. Amount Spend: Use the Amount Spend condition to target members who spend a specific amount on a single order. From the Conditions drop-down list, select the applicable condition such as ‘Equals’, ‘Greater Than’, or ‘Less Than’, and enter an associated value in the Value field. The Spend Details field defaults to the ‘In a single orders’, as it’s the only selectable option. From the Time Window drop-down list, select the time range to apply to members who’ve placed an order of certain value. You can select ‘All Time’, enter a certain date with the ‘Before' and ‘After’ options, or enter a specific date range into calendar fields with the ‘Between’ option.
  2. Product: Use the Product condition to target specific products for a campaign. These products can be purchased by members or can be altogether excluded from earning rewards. To identify the products for the segment, you can manually input Product IDs into the Product ID List field, or you can upload an existing CSV file containing a list of Product IDs with the ‘Upload Product ID List’ option.
  3. Product Category: Use the Product Category condition to target specific product categories for a campaign. These product categories contain a list of products that can be purchased by members or can be altogether excluded from earning rewards. To identify the product categories for the segment, you can manually input Product Category IDs into the Category ID List field, or you can upload an existing CSV file containing a list of Product Category IDs with the ‘Upload Category ID List’ option.

There is a TIME WINDOW field that allows you to apply additional Product Category conditions.

  1. Product Attribute: Use the Product Attribute condition to target specific product attributes defined in the Product Catalog Management (PCM) for a campaign. These products attributes are associated to specific products that can be purchased by members, not purchased by members, or can be altogether excluded from earning rewards. From the Attribute Name drop-down list, select the applicable attribute. To identify the product attributes for the segment, you can manually input Attribute Values into the Attribute Value field, or you can upload an existing CSV file containing a list of attribute values with the ‘Upload Attribute Value List’ option.
    Important: As a prerequisite, the attribute values must already exist within the PCM. If the attribute values do not exist within the PCM, you will return an error message when trying to create the new segment.

There is also an Additional Condition field that allows you to apply more attribute value conditions, such as time with the Time Window field.

  1. Order Attribute: Use the Order Attribute condition to target specific order attributes defined on completed orders within a campaign. Order attributes are configured within the Extended Attributes tab under the Additional Loyalty Settings module. From the Attribute Name drop-down list, select the applicable order attribute. To identify the order attributes for the segment, you can manually input order attributes into the Attribute Value field, or you can upload an existing CSV file containing a list of order attribute values with the ‘Upload Attribute Value List’ option. Use the Time Window drop-down to select the time frame for the order attributes in the new segment.
  2. Coupon Code: Use the Coupon Code condition to target specific members who use the specified coupons while placing the order. In the Coupon Code Values field, input the applicable coupon codes. You can also upload an existing list of coupon codes in a CSV file with the Upload Coupon Code Value option. Use the Time Window drop-down list to select the appropriate time range for coupon code eligibility within the segment.
  3. Source: Use the Source condition to target orders generated from a specific source, such as in-store or online, for a loyalty campaign. In the Source Values field, enter the applicable source value for the segment. You can also upload an existing list of source values in a CSV file with the Upload Source Value option. Use the Time Window drop-down list to select the appropriate time range for the segment.
Points

Use the Points condition if you would like the segment to be based on loyalty points. You can select from:

  1. Available Points: Select the Available Points condition to target members with a specific loyalty points balance. From the Condition drop-down list, select the applicable condition and then input a relevant value in the Value field. Use the Time Window drop-down list to select the appropriate time range for the segment.

Here, the segment includes all members who have reached a current points balance of 500 points before December 1, 2023.

  1. Lifetime Points: Select the Lifetime Points condition to target members who’ve reached a designated points threshold over their lifetime. From the Condition drop-down list, select the applicable condition and then input a relevant value in the Value field. Use the Time Window drop-down list to select the appropriate time range for the segment.

Here, the segment includes all members who have earned more than 2500 points over the duration of their enrollment in the loyalty program.

  1. Redeem Points: Select the Redeemed Points condition to target members who’ve redeemed a certain number of points. From the Condition drop-down list, select the applicable condition and then input a relevant value in the Value field. Use the Time Window drop-down list to select the appropriate time range for the segment.

Here, the segment includes all members who have redeemed less than 350 total points after December 31, 2023.

  1. Earned Points: Select the Earned Points condition to target members who have been credited points during a specified date range. From the Condition drop-down list, select the applicable condition and then input a relevant value in the Value field. Use the Time Window drop-down list to select the appropriate time range for the segment.

Here, the segment includes all members who have earned less than 1000 points between the dates of October 1, 2023 and December 31, 2023.
Store

The available options for the store segment condition are Store IDs and Store Attributes.

Create a Store-Based Segment:

 

  1. Store ID: You can select the store ID if you want to set the segment based on the store ID.

You have the option to include or exclude the store ID. Under the condition's drop-down, you need to either select "Applicable storeIds" or "Excluded storeIds."

  • Applicable storeIds: In this case, all the store IDs which you provide in the STORE ID LIST or upload via UPLOAD STORE ID LIST will be eligible for the segment and campaign.
  • Excluded storeIds: In this case, all the store IDs which you provide in the STORE ID LIST or upload via UPLOAD STORE ID LIST will be considered as excluded and hence all the other store IDs will be eligible for the segment and campaign.

Note: There are two options for uploading Store IDs to a segment.

  1. Select the Upload Store ID List radio button and click Upload CSV File. Upload the CSV file containing the Store IDs. The Data Upload screen displays as follows:

Select the applicable CSV file and ensure the Store IDs are configured as follows:

Please note that the maximum file size for a single file is 5MB. Once the file is correctly formatted and selected, click Upload.

 

  1. In the Store ID List field, you can also add multiple Store IDs by separating them with a comma.

To create a segment based on the Store ID provided by the Issuance API, we need to enhance the current store ID selection process. Currently, the selection allows inputting values in a text area and also supports multiple values separated by commas.

To improve this, we should implement a Multi-Selection Drop-Down feature. This enhancement will enable users to input the Store ID or Name, with the results dynamically populating. users will have the flexibility to add multiple stores to the segment. The display format for each store should include both the Store ID and Name, as illustrated below:

In the above screen, USA and Canada are the Store Name, 41 and 100 are the Store ID respectively.

The existing prerequisite and logic behind this should stay as is: The Store Ids must be existed in the Manage Store.

 

  1. Store Attributes: You can choose the store attributes and attribute name to set the segment based on the store attribute.

You have the option to include or exclude the store attribute. In the condition's drop-down, you need to select either "Applicable values" or "Excluded values."

  • Applicable values: In this case, all the store attributes which you provide in the ATTRIBUTE VALUES or upload via Upload Attribute Values List will be included in the segment. When a store ID is received through the Order API or Issuance API, the system checks the store's metadata to determine whether the store ID is associated with the listed segment attribute. If it is, the store becomes eligible for the segment and the associated campaign.
  • Excluded values: In this case, all the store attributes which you provide in the ATTRIBUTE VALUES or upload via Upload Attribute Values List will be excluded in the segment. When a store ID is received through the Order API or Issuance API, the system checks the store metadata to determine if that store ID is associated with the excluded attribute in the segment. If it is not associated, the order is eligible for the segment and campaign. If it is associated, the order does not qualify for the segment and campaign.

Before creating a new segment, ensure that the store attribute values already exist in the Manage Stores under the Options tab. If the store attribute values are not found in the store metadata, you will receive an error message when attempting to create the new segment.

 
Tiers

Use the Tiers condition to target members who have attained or been dropped from a specific tier within the loyalty program. From the Tier Name drop-down list, select the applicable tier. From the Condition drop-down list, choose to include members who have earned the selected tier or have been dropped from the selected tier with either the Members earned current Tier or Members dropped from Tier options, respectively. The Time Window drop-down allows you to configure the appropriate time range for the segment.

Here, the segment includes any members who’ve ever lost their Gold Tier status in the loyalty program.
Transaction Type

The Transaction Type option in Segment Conditions allows administrators to create segments based on conditions in a single order, such as method of payment. This can then be used in campaigns to differentiate campaign ratios accordingly. For example, customers making payments with debit transactions earn a 2x point ratio while customers making payments with credit transactions earn a 3x point ratio.

In segmentation, there is a condition called Advanced Transaction Type. This condition is available only if the site has Advanced Transaction Type is turned ON from the Advanced Settings tab under the Action Rule configuration.

This condition includes the following options:

  • Transaction Types: Pass the Comma Separated Values (Textbox)
  • Has Purchased/Has Not Purchased (Selection)

1. If the Has purchased option is selected, then you will select from the following conditions:

  • Single / Multiple Orders
  • Amount / Quantity
  • Greater than / Equal to / Less than / Range / Does not Equal
  • Comparison value from the above step
  • Dates - all time, before, after, between

2. If the Has not purchased option is selected, then you will select from the following conditions:

  • Dates - all time, before, after, between

Refer to the Advanced Transaction Type functionality for additional details.

Important: As a prerequisite, the Transaction Types must already exist within the Purchase Action module. If the transaction type values do not exist under the Purchase Action configuration, you will return an error message when trying to create the new segment.

Once all the details are captured, click Save to create a new segment in the system.

Editing an Existing Segment

When editing a pre-configured segment, click Edit from the Action column and update the fields which need to be edited. Administrators are presented with a pre-filled form to update all the necessary details for the segment.

 The fields presented during the creation of the segment are the same for the update.

Segments and Campaigns

  • If the administrator did not add members when creating the segment, the message “Uploaded Member: 0 No member is eligible for the Segment yet” appears. If a segment with no members is added to a campaign, loyalty program members do not become eligible for the campaign until they are added to the segment.
  • If there is an additional Segment condition along with an empty User List, no one becomes eligible for the campaign until some members are added to the segment. Once members are added into the segment, you can execute AND between the member and the additional conditions to ensure the qualified members get the relevant campaign benefit.
  • If there is a segment nested inside another segment (which can be configured using the Users from Segment field), and there are no members in either segment,  then no members are eligible for the campaign.

Override and Append buttons also appear if previously members were uploaded via API or Upload Member list.

  • If you want to add members to the segment, click Append. This is the default selection.
  • If you want to replace existing members with different members, click Override. 
  • Apart from the members event, the Override and Append options are available in lieu of Upload while editing the below segment conditions:
    • Product
    • Product Attribute
    • Product Category
    • Order Attribute
    • Store
    • Source
    • Coupon Code
    • Transaction Type
  • As an example, this document explains the working of append and override of Product IDs in Product. The same rule applies for all the other above mentioned events.

Append:

  • If the user adds the Product IDs file to the Product Segment condition, all the new Product IDs are added to the existing Product IDs in the segment.
  • The administrators get an alert before uploading the file: “The previously added data will be retained and the new data will be added along with it.”
  • Append is selected by default.
  • The maximum size of the file to upload is 5MB.

Override:

  • Select Override to replace the existing Segment Product IDs with the new Segment Product IDs.
  • The administrators get an alert before uploading the file: “Uploading a new file will replace the previously uploaded data for this condition!”
  • Click Yes or No accordingly.
  • The maximum size of the file to upload is 5MB.
  • In the file, ensure that multiple values are separated by a comma.

Exporting Uploaded Values

If the administrator wants to export all the uploaded values such as Product category IDs, Product Category, etc., then click on the Uploaded Category IDs hyperlink count as shown below:

  • When an administrator clicks on the total count, a pop-up screen named Make An Excel Request appears, showing the 100 most recently uploaded values out of the total uploaded values.
The 100 most recently uploaded values displayed on the screen are for viewing only and cannot be edited.
 
  • The image below displays 100 out of 60000 recently added product category Ids.
  • All the Product IDs are sent to the provided Email ID.

Once all the details are updated, click Update to update the segment.

Uploading Segment Files via Batch Job

When uploading files while adding conditions to a new segment or editing the conditions of an existing segment, there is a session combined maximum size limit of 5MB. A session is defined as the user taking a single action in the LEP. For example, a session would be the creation of a new segment. During that session, there is a combined maximum size of 5MB. You could reach the 5MB limit through uploading a single file or four files. Once the limit is reached, no more files can be added during the session. The file limit automatically adjusts to show the remaining available file size, as shown below:

If you are uploading any file to the new segment, the file gets executed by a batch job that runs in five-minute intervals. When adding the segment, you will receive the following notification:

When the file is successfully uploaded, the email address specified in the notification receives an email alert confirming the segment request was processed.

The email you receive contains the Site ID and the name of the site the segment information was uploaded to. The Segment ID and Segment Name are also included, as well as clickable link that shows an Excel file with two tabs: one for the successfully uploaded segment values and one for values that failed to upload (if any). An example of the email alert is shown below:

Related Articles

Issuance API - Segmentation

Overview In the Annex Cloud loyalty system, segmentation functionality works usin...