Skip to main content

Loyalty Badges

Badge details​

Unique badge identifier​

Used for badge search, lookup, and reporting purposes within the ESI system.

A new API endpoint returns all badges configured in the system. The badgeID attribute is used as the basis for badge searches and lookups.

The Console API supports auto-completion on the front end for the new Badge(s) earned targetable attribute on the offer configuration page. The API call requires no query parameters or a request body. The response includes badges in Active status (including Expired), but not Deleted or Disabled. For each badge, only the badgeID attribute is returned.

When creating a badge ID in the Console, enter a unique name that meets the following validation parameters: 3-128 alphanumeric characters and underscores only.

API to return list of badgeID -- WIZ-4652

Badge copy and creative​

Badge text and images, including badge headlines, additional text sections, and different versions of the badge image.

Ability to provide information related to the badge in text and image formats, including images showing the badge.

When creating a badge in the Console, the creative elements can be configured in the Copy and Creative section of the page.

Badge scheduling​

Evergreen scheduling​

Enables badges that are available for an indefinite period with no end date.

You must be able to set a start date for a badge without setting an end date, so that the badge remains available to members after the start date.

Ability to set a badge with a defined start date and no end date, making it an evergreen or perpetually available badge for members.

Implemented in the Console on the badge creation page, in the Scheduling section.

Fixed start and end date​

The start and end times that define when member behavior is considered eligible for the badge.

You must be able to set the start and end dates during which the badge is available to eligible members. The badge is not available outside of these dates and times.

Ability to set the date and time for both the start and end of badge availability to members.

Implemented in the Console on the badge creation page, in the Scheduling section.

Badge required behaviors​

Transaction spend amount​

Ability to set up badges that require the member to spend a specific dollar amount.

Ability to set the required behavior to Purchase $ amount and configure the following:

  • Whether the criteria must be met in a single transaction or across multiple transactions.
  • How much must be spent.

This feature can be configured in the Console when creating a new badge, in the Details section.

Transaction spend on product hierarchy (SKU, category, etc.)​

Ability to award badges that require the member to spend a specific dollar amount on items from a specific product category, brand, SKU, or similar.

Ability to set the required behavior to Purchase $ amount and configure the following:

  • Whether the criteria must be met in a single transaction or across multiple transactions.
  • How much must be spent.
  • A query on the specific products or product categories on which the money must be spent.

This feature can be configured in the Console when creating a new badge, in the Details section.

Quantity purchase on product hierarchy (SKU, category, etc.)​

Ability to award badges that require the member to purchase a specific quantity of items from a specific product category, brand, SKU, or similar.

Ability to require the member to purchase a specified quantity of a particular product or set of products to earn their badge.

When creating a badge in the Console, in the Details section, select the Purchase X quantity required behavior and set the other parameters.

Exclusion logic on full product hierarchy (SKU, category, etc.)​

Ability to exclude products that are not eligible to contribute toward the required behavior for earning the badge.

Ability to exclude specific products from badge earning. Parts of a transaction, or full transactions, involving products that are Not In the defined product set cannot contribute to earning the badge.

This feature can be configured in the Console when creating a new badge, in the Details section.

Global exclusions on pre-set product hierarchy (SKU, category, etc.)​

Ability to exclude a universal set of products that are not eligible to contribute toward the required behavior for earning the badge.

Globally excluded items don't contribute to earning badges or meeting the threshold. If a transaction with a cart item is sent via the POS API, cart line items are checked against a list specific to the province in which the store is located. The transaction won't progress badge earning, and an entry is made in the audit object.

The option to apply global exclusions can be selected in the Console when creating a new badge, in the Details section (after selecting the required behavior).

Support for global exclusion in badge evaluation -- WIZ-4659

Behavioral badges (digital, profile, membership) to drive member engagement​

Ability to set up a particular behavior--such as completing a survey--as the criterion for earning a badge.

Ability to set up badges that require the member to perform one of the following types of behavior to earn the badge:

  • Digital -- for example, downloading the mobile app, using app features, or checking in.
  • Profile -- for example, signing up for communications or providing additional profile information.
  • Loyalty membership -- for example, achieving a point earn threshold.

This feature can be configured in the Console, in the Details section, when selecting the required behavior.

Frequency​

Ability to set up badge criteria that require the member to perform a required behavior across multiple transactions or within a timeframe to earn a badge.

Frequency badges allow members to fulfill the badge's required behavior across multiple transactions, sessions, or other points of interaction.

Ability to set up complex required behavior for earning a badge, including:

  • Requiring multiple transactions to earn the badge.
  • Selecting how many dollars must be spent or how many items must be purchased.
  • Setting up a product query to focus on particular products for badge earning.

When creating a badge in the Console, in the Details section, the required behavior can be configured to require multiple transactions and to set the number of transactions required.

Redemption​

Ability to redeem a badge for a specified reward.

Ability to set a redemption activity to earn a badge based on the following:

  • Setting the required behavior to Redeem.
  • A pre-set minimum redemption amount.
  • The option to use a product query to define specific products or departments that must be in the cart during redemption.

When creating a badge in the Console, the Redeem option in the required behavior allows you to set a minimum redemption amount and, optionally, include a product query.

Badge audience targeting​

Audience targeting: mass targeting​

Badge targeted to all loyalty program members.

Ability to make a badge available to all members in the loyalty program.

In the Console, when creating a badge, the default targeting setting makes the badge available to all loyalty program members.

Audience targeting for offers based on earned badges -- WIZ-4602

Last updated on