For the complete documentation index, see llms.txt. This page is also available as Markdown.

Mass Reward Status Change

When managing a large volume of physical or digital reward redemptions, manually updating statuses one by one can be time-consuming. OpenLoyalty allows you to update the status of thousands of issued rewards at once by importing a single CSV file.

Key Benefits

  • Bulk Processing: Update large lists of reward redemptions simultaneously.

  • Safe Importing: If a specific row has an error (e.g., an invalid reward ID), the system will process the valid rows and highlight the failed ones so you can fix them.

  • Audit History: Add optional comments to each status change to track notes or tracking numbers in the reward's history.


Allowed Reward Statuses

When preparing your update file, make sure to use exact lowercase status names:

Status
Description

issued

Default state when a customer claims a reward.

pending

Fulfillment is waiting for verification or approval.

approved

Order is approved and ready for fulfillment.

rejected

Request rejected (e.g., out of stock or ineligible).

canceled

Order or reward redemption has been canceled.

packing

Order is currently being prepared and packed.

awaiting_shipping

Package is packed and awaiting courier pickup.

shipped

Order has been dispatched to the customer.

completed

Reward has been successfully fulfilled or delivered.

returned

Package was returned or delivery failed.


How to Perform a Bulk Status Change

Step 1: Prepare Your CSV File

Create a CSV spreadsheet with the following headers:

  1. issuedRewardId (Required): The unique ID of the issued reward.

  2. status (Required): The new status (in lowercase).

  3. comment (Optional): An internal note, tracking number, or reason (up to 255 characters).

Sample File:

Example:


Step 2: Upload the File

  1. Log in to the Admin Panel.

  2. Navigate to Imports section or Rewards > Redeemed Rewards

  3. Select Import and Issued Reward Status Change as the import type.

  4. Upload your CSV file and submit.


Step 3: Review the Import Results

Once uploaded, the import will process in the background. You can check the import list to review the final status:

  • Overall Status: Shows whether the whole file has finished processing.

  • Row-by-Row Results: Displays which individual rewards were updated successfully and details any rows that failed (for example, if a reward ID was not found or a comment was too long).


Validation & Common Errors

A row in your file will fail to update if:

  • Reward ID Not Found: The issuedRewardId does not match an existing reward in your store.

  • Invalid Status: The status name is capitalized (e.g., COMPLETED instead of completed) or misspelled.

  • Comment Too Long: The comment field exceeds the 255-character limit.

Last updated

Was this helpful?