Skip to main content

Managing card-based loyalty program data

You can import and export loyalty card data, update card statuses, link cards to customer profiles, and manually add to or deduct points from loyalty cards.

Feature access
Only admins have access to this feature.

Importing loyalty cards into a program

You can import a CSV file containing loyalty cards into a loyalty program at any time.

note

Cards can be imported with or without customer profiles linked to them, depending on whether your import file contains Customer IDs.

  1. On the leftmost menu, click Loyalty.

  2. Click the name of the card-based loyalty program where you want to import cards.

  3. At the top-right of the page, click Manage Loyalty Data > Import Loyalty Cards.

  4. In the pop-up that appears, click Upload a CSV file.

    tip

    To see the required structure of the CSV file, click Download a sample file.

  5. Select a CSV file with the cards you want to import.

  6. Click Import Cards.

Linking customer profiles to a loyalty card

Link one or more customer profiles to a given loyalty card programmatically.

When a customer profile is linked to a card, the card is set as Registered. You can then use the Loyalty card is registered condition to create different rules and restrict the use of cards that are not registered. For example, you can create a referral code or display a given notification only if the loyalty card has customer profiles linked to it.

To link a customer profile to a card, use the Link customer to loyalty card endpoint.

tip

Edit the card user limit in the loyalty program Settings to modify the number of customers that can be linked to the loyalty card.

Once a customer profile is linked to a loyalty card, we start collecting data, such as the card's balances and transaction logs, for that specific profile. You can then share this information with your customer.

note

The card identifier and the card's loyalty balances and transaction logs originally come from the integration layer's requests to the List customer data endpoint.

Importing loyalty points into a card

You can import loyalty points into a loyalty card at any time:

  1. On the leftmost menu, click Loyalty.

  2. Click the name of the loyalty program where you want to import points.

  3. At the top-right of the page, click Manage Loyalty Data > Import Loyalty Points.

  4. In the pop-up that appears, click Upload a CSV file to select a CSV file of loyalty points from your computer.

    tip

    To see the required structure of the CSV file, click Download a sample file.

  5. Click Import Loyalty Points.

Exporting the transaction logs

Obtain a CSV file with the loyalty point transactions made with a given card. This allows you, for example, to import this data in other BI tools to analyze the use of the card.

  1. On the leftmost menu, click Loyalty.

  2. Click the name of the card-based loyalty program containing the card whose transaction logs you want to export.

  3. Find the card you want to export, then click > Export Transaction Logs.

    note

    You can also export the transaction logs from the Logs tab of the loyalty card page.

  4. In Transaction logs after, set the initial date.

  5. (Optional) In Transaction logs before, set the end date. The default end date is the current date.

  6. In Card identifier, type the identifier of the card you want to export.

  7. In Date format, select the date format of your choice.

  8. Click Export Data.

Exporting the loyalty balances

Obtain a CSV file containing the balances of all users of a loyalty program for a given date and time. Use it to get the number of active, pending, expired, and spent points for each customer.

  1. On the leftmost menu, click Loyalty.
  2. Click the name of the program whose balance you want to export.
  3. At the top-right of the dashboard, click Manage Loyalty Data > Export Loyalty Balance.
  4. In Date and time, select the date and time for which you want to export the loyalty balance.
  5. Click Export Loyalty Balance.
note

In the exported file, all timestamp values follow UTC+00:00.

Transferring loyalty data to a new card

In case of a broken, stolen, or lost loyalty card, you can copy the original card data to a newly created card.

The new card has the same linked customers and the same loyalty point balances and transactions as the original one, but its card identifier is different. The new card's status is

Active
.

important

The status of the original card is updated to

Blocked
after the new card is created. The original card cannot be reactivated.

  1. On the leftmost menu, click Loyalty.
  2. Click the name of the loyalty program that contains the card you want to transfer and block.
  3. Find the card you want to transfer and block, then click > Transfer & Block.
  4. Enter a New card identifier and click Transfer & Block.
  5. In the pop-up that appears, click Transfer & Block.
note

You can also transfer data to a new card and block the old card via the button from the loyalty card page or use the Transfer loyalty card data endpoint.

Changing a loyalty card status

You can manually update the status of a loyalty card.

To activate a loyalty card:

  1. On the leftmost menu, click Loyalty.
  2. Click the name of the loyalty program containing the card you want to activate.
  3. Find the card you want to activate, then click > Activate
tip

You can also activate a loyalty card on the loyalty card page.

To deactivate a loyalty card:

  1. On the leftmost menu, click Loyalty.
  2. Click the name of the loyalty program containing the card you want to deactivate.
  3. Find the card you want to deactivate, then click > Deactivate.
tip

You can also deactivate a loyalty card on the loyalty card page.

Manually adding loyalty points

You can manually add loyalty points to a loyalty card.

  1. On the leftmost menu, click Loyalty.

  2. Click the name of the loyalty program that contains the card you want to manually add points to.

  3. Click the Card identifier of the required card.

  4. Click the Logs tab.

  5. To the right of the Subledgers dropdown, click > Add Points.

  6. In Points, enter the number of points you want to add.

  7. In Reason, enter the reason for adding points.

  8. In Reward start date, select when your rewards become active.

    • With Program default, the rewards become active based on the date set in the loyalty program.

      note

      You can edit the default start date in the loyalty program.

    • With Immediate, the rewards become active immediately.

    • In Custom, you can choose a Relative start date or an Absolute start date.

      Examples: Relative reward start date

      For all the examples mentioned in this table, we assume that the customer session closes on 12 October 2024, 07:20:50.

      Relative reward start datePoints become active on

      10 minute(s) after the session

      12 October 2024, 07:30:50

      1 hour(s) after the session

      12 October 2024, 08:20:50

      5 day(s) after the session

      17 October 2023, 07:20:50

      5 day(s) after the session, start of the day

      17 October 2024, 00:00:00

      5 day(s) after the session, end of the day

      17 October 2024, 23:59:59

      1 week(s) after the session

      19 October 2024, 07:20:50

      1 week(s) after the session, on the last Sunday

      20 October 2024, 23:59:59

      1 month(s) after the session

      12 November 2024, 07:20:50

      1 month(s) after the session, on the last day of the month

      30 November 2024, 23:59:59

  9. In Reward expiration date, select when your rewards expire.

    • With Program default, the rewards expire based on the date set in the loyalty program.

      note

      You can edit the default expiration date in the loyalty program.

    • With Unlimited, the rewards stay active for an unlimited period of time.

    • In Custom, you can choose a Relative expiration date or an Absolute expiration date.

      Examples: Relative reward expiration

      For all the examples mentioned in this table, we assume:

      • The customer session closes on 12 October 2024, 07:20:50.
      • The rewarded loyalty points are active immediately.
      Reward expirationPoints expire on

      10 minute(s) after the session

      12 October 2024, 07:30:50

      1 hour(s) after the session

      12 October 2024, 08:20:50

      5 day(s) after the session

      17 October 2023, 07:20:50

      5 day(s) after the session, start of the day

      17 October 2024, 00:00:00

      5 day(s) after the session, end of the day

      17 October 2024, 23:59:59

      1 week(s) after the session

      19 October 2024, 07:20:50

      1 week(s) after the session, on the last Sunday

      20 October 2024, 23:59:59

      1 month(s) after the session

      12 November 2024, 07:20:50

      1 month(s) after the session, on the last day of the month

      30 November 2024, 23:59:59

  10. Click Add Points.

Manually deducting loyalty points

You can manually deduct loyalty points from a loyalty card.

  1. On the leftmost menu, click Loyalty.
  2. Click the name of the loyalty program that contains the card you want to manually deduct points from.
  3. Click the Card identifier of the required card.
  4. Click the Logs tab.
  5. To the right of the Subledgers dropdown, click > Deduct Points.
  6. In Points, enter the number of points you want to deduct.
  7. In Reason, enter the reason for deducting points.
  8. Click Deduct Points.

Deleting a loyalty card

You can delete a loyalty card at any point. By deleting a loyalty card, you also delete the corresponding loyalty point logs, lists of linked customers, and metadata.

  1. On the leftmost menu, click Loyalty.
  2. Click the name of the card-based loyalty program containing the card you want to delete.
  3. Find the card you want to delete, then click > Delete.
  4. In the pop-up that appears, click Delete Card.
note

You can also delete a loyalty card via the button on the loyalty card page.