This document will review how to configure an action series that applies to members who have purchased a specific number of times within a year or within a specific year using a date range.

Note: This document will review the key configurations needed for this use case. To review the other action series settings, please refer to the Action Series help documentation.

Use Case Configuration

1. Navigate to the Products tab on the Annex Cloud dashboard and select Go within the Action Series tile.
   
2. Once on the Action Series page, select Add New Action Series.
   
3. On the General Information tab, you can set the Duration of the action series using the two drop-down menus to:
   • Calendar, Date Range and specify the specific year that you would like this action series to apply to. For example, you configure this action series in April of 2025, and you want it to apply for the rest of the year. You’d set the Start Date to the present date, and the End Date to December 31, 2025. This action series will then only apply to shoppers who made X number of purchases within that specific date range.
     

• Calendar, Year. This will apply the action series to each calendar year instead of one specific year. Meaning, if you created the action series in 2025, it would apply to that year. Then in 2026, members would be eligible to achieve the action series again and so on for each calendar year.
  

4. On the Series Milestone tab, set the Action Series Type to Based on Count using the drop-down menu.
   
5. Then add the action to the series:
   1. Select the Purchase action from the Choose Action drop-down menu.
   2. In the Count field, enter the number of times a member must make a purchase within the year.
   3. In the Where field, select Only Count from the drop-down menu.
   4. The Criteria field will not be relevant for this action.
   5. Select the ➕ icon to add the action to the series.
      
6. Select Next to head to the Series Benefits tab.
   
7. On the Series Benefits tab select Update Action Series to add the action series to your program.

8. You’ll know the action series has been configured when it appears on your Action Series dashboard. If the Status is set to ON, the action series is Active.

Storing Data: Calendar, Year

Action series data will be collected starting from the date of the member’s first qualifying activity. Members who achieve the action series milestone within a calendar year will be eligible for the action series benefit.

Example:
The action series is configured with the following settings:

• Duration: Calendar, Year
• Milestone: Purchase count of 2
• Benefit: 100 points
• Maximum Achievement Limit: set to the default (1)

The system will review historical data for members who completed this milestone within the calendar year.

This means that even if the action series setup was configured in 2024, a member who achieved the milestone earlier, for instance in 2020, would still qualify and receive the action series benefit.

If the member did not complete the action series milestone in calendar year 2020, then the system will look for the next calendar year and so on. This qualification will also be reflected in the Action Series Report.

For members with an In Progress status, the system will analyze historical data to identify those who have partially completed the action series milestone within the current calendar year. The report will include records for these members, reflecting their current progress toward milestone completion.

Reporting

You can check the status of a member’s action series completion using the Action Series Report or the Action Series API.

Action Series Report

1. Navigate to the Reports tab on the Annex Cloud dashboard and select Go within the Action Series Report tile.
   
2. Once on the Action Series Report dashboard, select the Member icon in the Details column for the action series you’d like to review.
   
3. You will be taken to the Action Series Member Report where you can see the list of members who have taken actions towards completing the action series. The report can be filtered to find data for a specific loyalty member or to identify members who have or have not completed the series.

Within this report you can identify if members have completed the series, their progress towards completion, when their action series eligibility ends, and more. Review the Action Series Report help documentation for a complete overview.

4. Select Export > Make an Excel Request to request the data be sent to an email address in an Excel spreadsheet for further analysis.
   

Action Series API

The POST:/ users/{{email_id}}/actionseries method can be used to retrieve a member’s data for a specific action series.

Much like the Action Series Member Report, the request will return information related to the configuration of the action series, identify what actions the member has taken towards completing the series, and how many actions the member still needs to take to complete the series.

Make sure to include the member’s User ID within the URL path and enter the action series ID within the request body.

URL:

POST https://{{base_url}}/api/3.0/users/{{email_id}}/actionseries

Request Body:

{
    "actionSeriesId": "{{actionSeriesId}}"
}

Example Response Body:

{
    "siteId": "146032020",
    "memberName": "Shae Shopper",
    "id": "shae@gmail.com",
    "pendingActionSeries": {
        "actionSeriesId": "1714",
        "actionSeriesName": "Purchase 3 times in a year",
        "actionSeriesType": "Based On Count",
        "bonusPoints": "0",
        "seriesCompletionDate": "2024-12-30",
        "milestonesDurationType": "Fixed",
        "milestonesDurationStartDate": "2024-10-01T00:00:00+0000",
        "milestonesDurationEndDate": "2024-12-30T23:59:59+0000",
        "actionSeriesStatus": "ACTIVE",
        "memberActionSeriesStatus": "Pending",
        "completedMaxPointBonus": "",
        "pendingMaxPointBonus": "",
        "actionSeriesMaxAchievementCompleted": "0",
        "actionSeriesMaxAchievementPending": "1",
        "maxAchievementLimitDuration": "Lifetime",
        "maxPointLimitDuration": "Lifetime",
        "totalRewardBenefitCount": "",
        "actionData": [
            {
                "actionId": "109",
                "actionName": "Purchase",
                "requiredCredit": "3",
                "completedCredit": 1,
                "basedOn": "Only Count",
                "pendingCredit": 2
            }
        ],
        "actionSeriesRewardBenefit": {
            "rewardId": "",
            "rewardName": ""
        }
    }
}

Retrieve Data for All Action Series

If you would like to retrieve a member’s data related to ALL action series configured in the loyalty program, you will use the GET:/users/{{email_id}}/actionseries method.

URL:

GET https://{{base_url}}/api/3.0/users/{{email_id}}/actionseries

API Documentation Resources

Review the Action Series API documentation for further information.

• Action Series API Methods