Summary
- The order report provides a detailed account of all transactions associated with all members of the loyalty program.
- This report includes loyalty information for a particular order, including earned points by members, coupons or rewards, and other information about the order.
Order Report
Navigation: Reports > Order

By clicking Go within the Order tile on the reports page, you will be redirected to the Order Report as shown in the image below.

The report data can be searched and filtered based on a number of criteria, enabling the user to look for a particular record and associated loyalty information. Additionally, records from this report can be exported for further analysis.

Search: The report's data can be filtered using a number of search options. Any of these search actions can be used individually or collectively to find records of interest.
- Date Range: Using the start and end date ranges, records are filtered for a particular period. If any of the order dates, like the start date or end date, fall under the date range provided, then reports of all those orders will be shown.
- User ID: Provide the user ID for the member who placed the order.
- Order ID: Provide the order ID for a particular order if you want to find the records.
- Extended Attribute: Provide the extended attribute, if any, for a particular order you want to find the records.
- Store: Select the store from the drop-down option for the particular order in which you want to find the records.
- Content Search: Using this search option, users are able to search for the required information using key words.
At the top of the Order Report dashboard, you will see the buttons for Bulk Upload, Bulk Upload Report, Manual Order and Export.

Bulk Upload: Administrators can bulk upload order data using a CSV file. By selecting this option, you can see the mandatory and optional fields that must be included in the file before uploading.
Bulk Upload Report: Select this option to check on the status of a bulk upload of orders. Search using a date range, or by the email of the administrator who uploaded the order data.
Manual Order: Administrators can input an order or update the status of an order manually through the Order Report dashboard. Head to the Manual Order portion of this document to read more about how to input an order manually.
Export: The data from the Order Report can be exported by selecting, "Make an Excel Request", and entering the email address of the user who should receive the data.
- The link is delivered to the entered email address. Click Download Excel to access the spreadsheet with the data.
- Users will get access to the downloaded data for 24 hours after receiving the email message.
- If the data has more than one lakh, for example, two lakhs in a row, then it will split the data into two different files. We will be getting two sets of data with this information, and files get automatically zipped.
Admin users can see the Opt-In Status column in the Order Export Report. This Opt-In Status column helps to validate and identify which orders are created by members, which are created by non-members, and which have the status “NONE“.
If there is a member who has not opted into the loyalty program, they can still place an order. Those user details are shown in Opt-In Status as "NONE"
Admin users can validate unnecessary orders for their calculations and check revenue details that are displayed on the dashboard.


The following are the fields in the exported order report:
- Order Date: The date the order was placed by the member.
- User ID: The unique identifier for the member who placed the order.
- Order ID: The unique identifier for the order.
- Order Total: The total value of the order.
- Order Spend: The actual amount spent on the order after discounts are applied.
- Discount Amount: The total amount of discount applied to the order.
- Coupon Code: The code used for applying a discount to the order.
- Store ID: The unique identifier for the store where the order was placed.
- Points Redeemed: The number of points used by the member during the transaction.
- Points On Hold: The number of points that are temporarily on hold due to the order.
- Points Earned: The number of points earned by the member from the order.
- Points Awarded: The points that were awarded to the member for the order.
- Shipping Points: The number of points awarded based on the shipping method or costs.
- Source: The source through which the order was placed (e.g., online, in-store).
- Opt-In Status: Indicates whether the member has opted into the loyalty program (Yes) or opted out (No).
- Phone Number: The phone number of the member who placed the order. (This field is an example of an Extended Attribute that can be configured under Additional Loyalty Settings).
Order Report Dashboard

The dashboard report consists of a number of fields associated with each order. Order-specific fields show the date and time, user ID, order ID, order total, points type, points redeemed, etc.
Each of the fields is described in the table below:
| Field | Description |
|---|---|
| Order Date | Displays the date-time for the order |
| User ID |
The unique ID of the loyalty member who placed the order. If you click the ID in this field, a window will appear with a history of the member’s activity. |
| Order ID |
The unique ID for the order placed. Click this field to open the Order Detail Report. |
| Order Total |
The total charged for the order. This field is populated using the POST/order API parameter: orderTotal. This is not used in any calculation and therefore cannot be used for things such as tier thresholds. |
| Order Spend | A calculated field that takes returns, cancelations, and discount amounts into account to total the amount spent on the order. |
| Discount Amount | Amount discounted from the order |
| Coupon code | Coupon codes if applied |
| Store ID | Unique ID for the store where the order was placed |
| Points Redeemed | Number of points redeemed when placing the order |
| Points On Hold | Number of points earned and on hold from placing the order |
| Points Earned | Number of points earned by the user after placing an order |
| Points Awarded | Points awarded for the order |
| Shipping Points | Points awarded for shipping costs |
| Source | The source of where the order was placed (web, device, in-store) |
| Extended Attributes | Extended attributes enable administrators to collect data on a unique aspect of an order. Depending on the attribute definition, an administrator/marketer can enter values for the attribute. |
| PromoCode | Displays the promo code, if any |
Manual Order
By selecting Manual Order at the top of the Order Report dashboard, administrators can input and update order details manually.

You will be taken to the Order Details page to manually input a new order or update the status of an existing order.

Order Status: Use the drop-down menu in the first field to select the status of the order. The options are Order, Cancel, Partial Cancel, Ship, Partial Ship, Return, and Partial Return.
The fields and configuration will change based on the selection of the order status. Each selection type is explained below:
Order Status: Order
Order ID: Enter the unique ID for the order
User ID: Enter the user ID for the member that placed the order
Select Add Product + to add the product details for each item purchased in the order. The product ID, quantity and sale amount are required, all other details are optional.
Product Id: Enter the unique ID for the product
Product Quantity: Enter the quantity purchased
Product Sale Amount: Enter the cost of the product
Category ID: Enter the unique ID for the product category
Product Description: Enter the description of the product
Product Auto Delivery: Select the option Yes or No
Product Category: Enter the name of the product category
Product URL: Enter the product page URL
Product Image URL: Enter the product image URL
Product Estimate Ship Date: Select the estimated delivery date using the calendar
After entering the above information for each product in the order, you will scroll down to the Additional Details (optional fields) and provide user details, other order details, and reward details in the fields described below.
| Field | Description |
| User Details | |
| Email Id | The customer’s email address |
| First Name | First name of the customer |
| Last Name | Last name of the customer |
| Other Details | |
| Discount Amount | The discount amount applied to the order, if any |
| Order Total | The total cost of the order |
| Source | The source of where the order was placed (web, device, in-store) |
| Shipping Amount | The cost of shipping the order |
| Store Id | The unique ID for the store where the order was placed |
| Reward Details | |
| Event Id | The unique ID for the purchase event. |
| Reward ID | The unique ID for the reward applied to the order |
| Reward Name | The name of the reward applied to the order |
| Order Attributes | |
| Extended Attribute | Extended order attributes configured will appear for the additional data to be captured. |
Order Status: Partial Cancel, Partial Ship or Partial Return
Order ID: Enter the unique ID for the order
User ID: Once the order ID is entered this field will auto-populate with the ID of the member who placed the order.
The products purchased in the order will then appear in a table below.

If products have already been shipped, they will not appear in the table if the order status is Partial Ship or Partial Cancel.
In the Action column you can:
- Edit the product quantity
- Delete the entire product row from the order
Click Save to complete the update to the order.
Order Status: Cancel, Ship or Return
Order ID: Enter the unique ID for the order
User ID: Once the order ID is entered, this field will autopopulate with the ID of the member who placed the order.
Click Save to complete the update to the order.
If the order has already shipped, it cannot be canceled.
Order Detail Report
By clicking on the order ID for an order included in the Order Report, you will be directed to the Order Detail Report for that specific order.

Navigation: Reports > Order > Order ID > Order Detail Report

Search: The report's data can be filtered using a number of search options. Any of these search actions can be used individually or collectively to find records of interest.
- Product ID: Provide the unique ID of the product from the order.
- User ID: Provide the user ID for the member who placed the order.
- Purchase Date: Provide a date range to identify products added to the order on a particular date.
- Last Update Date: Provide a date that the last update was made to the order.
Export: The data from the Order Detail Report can be exported by selecting, "Make an Excel Request", and entering the email address of the user who should receive the data.
- The link is delivered to the entered email address. Click Download Excel to access the spreadsheet with the data.
In the Order Detail Report, you have the following data columns:
| Field | Description |
|---|---|
| Purchased Date | It displays the date on which the order was placed. |
| Shipped Date | It shows the date on which the product has been shipped. |
| Member ID | Displays the members unique ID. |
| Order Id | Displays the unique ID for the order. |
| Product Id | Displays the unique ID of the product included in the order. |
| Product Name | Displays the name of the product. |
| Product Coupon | Displays the product-specific coupon used on the order. |
| Category Id | It displays the unique ID for the product category. |
| Category Name | Displays the name of the product category. |
| Quantity | Displays the number of products that have been purchased. |
| Unit Price | Displays the unit price of the product. |
| Product Discount | Displays the discount given on a product. |
|
Total Points Ratio (Available in the exported report) |
Displays the Total Points Ratio applied to the product purchase. For example, if an order has a campaign ratio of 2x and a tier ratio of 3x, the total points ratio will be 6x. |
|
Total Flat Points (Available in the exported report) |
Displays the Total Flat Points awarded per product. For example, there is an order for 2 of Product P1 and the Flat Points for Product P1 are set to 10. Total Flat Points will be (Flat points of product ID * product quantity) = 20. |
| Campaign Id | Displays the unique ID for the campaign, if the product purchase qualified for a campaign benefit. |
| Campaign Name | Displays the campaign name, if the product purchase qualified for a campaign benefit. |
| Campaign Points | Displays the number of campaign points earned for purchasing the product. |
| Shipped | Displays the number of products shipped. |
| Returned | Displays the number of products returned. |
| Cancelled | Displays the number of products canceled. |
| Hold | Displays the number of points on hold. |
| Last Update Date | It shows the date on which the last update was made to the order. |