Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Document Status

Status
colourPurpleGreen
titleDRAFTReviewED

Document Owner(s)

Goncalves, Felipe

Reviewers

Table of Contents

🛠️ Potential Solutions

...

Info

Description of the proposed solution.

A proposed solution we will is to add new fields and mathematical calculates calculations in the system to give this information to the customer user support agent.
Example:

...

This form provides the agent with more detailed information; therefore, we need to modify certain parts of the code.

...

  • Given that the user accesses the Loyalty Transactions, Orders, and Recent Orders screens,

  • When the transactions are loaded,

  • Then the system should display the following information in order:

    • Initial Points

    • Points Earned (regular points and bonus points)

    • Points Used burned (displayed as a negative value, e.g., “-60”)

    • Transaction Points balance (points earned minus points used)

    • User's Final Points in that order.

2 - Display of Orders and Status

  • Given that the support user agent accesses the orders screen and understands the meaning of each status,

  • When the screen is loaded,

  • Then all orders should be displayed, including all relevant statuses:

    • Claimed: Success status where points are credited or debited.

    • Confirmed: Order completed but not finalized (e.g., delivery not completed), where the points do not impact the user's total.

    • Void: Canceled order where the points do not impact the user's total.

...

  • Given that there is new data to be displayed,

  • When the feature flag is activated,

  • Then the new data should be displayed in the user interface.

  • And when the feature flag is deactivated, the new data should be hidden.

    • PS: This flag is temporary

4 - Points Calculation

  • Given that the points received, used, bonus, and final points are derived from the loyalty system,

  • When the transactions are processed,

  • Then no changes should be made to the existing calculations.

  • And we will not be responsible for correcting and/or altering loyalty rules.

...

Expand
titleAdd the “current value points” on GQL to each order

File: src/remote/queries/fragments/intl-loyalty-transaction.ts
In const INTLLoyaltyTransactionFragmentForTimeline add:

Code Block
transactionDetails {
  person {
    currentPoints
  }
}

DOD:

Return the currentPoints for each user order. We can verify if this value is reflected on the src/components/intl-loyalty/points-balance.tsx (Layout Transaction) screen.

Frontend:

We can see the discussion about this in this thread: https://rbidigital.slack.com/archives/C067D4XK9D5/p1724350040702039
The labels are:

...

Expand
titleCreate a Feature Flag

Name suggestion: display-points-balance
Local: Intl Tech - Platform
Type: Temporary

Expand
titleTechnical debt remove a Feature Flag

Name suggestion: display-points-balance
Local: Intl Tech - Platform

The features on the screens can be consolidated into a single component for all screens, though some layout changes will be necessary(Loyalty Transaction and Orders screen). The Details Order screen will be other task.

Expand
titleImprove Loyalty Transactions Screen

File: src/components/intl-loyalty/points-balance.tsx
Changes:

  • Label “Balance“ to “Points Balance“

  • Label “Total“ to “Total transaction points““Transaction balance“

  • Add “ - “ before “Points used”burned”

    • Add “-“ only in numbers greater than 0'

      • points used: 0

      • points used: -123

  • Add field “Initial points balance“

    • Calculate value: totalPoints - pointsEarned - poinstUsed

  • Add field “Final points balance“

  • Add “bonusPoints” on “pointsEarned”

image-20240821-173423.pngImage Removed

image-20240828-191133.pngImage Added

Expand
titleImprove Recent Orders Screen

File: src/components/customer-orders/order-timeline-item.tsx
Changes:

  • Attention - Some labels have changed, but Figma has not been updated:

    • Total Transaction Points → Transaction balance

    • Points Used → Points Burned

  • Change from Line to Collapsible item - Points Balance

  • Label “Points“ to “Points Balance“

  • Label “Awarded“ to “Earned“

  • Label “Redeemed“ to “Used“

  • Add field “Initial points balance“

    • use transaction?.loyaltyTransaction?.pointsBalance

  • Add field “Points earned“

  • Add field “Poinst used““Points burned“

    • Add “-“ only in numbers greater than 0'

      • points used: 0

      • points used: -123

  • Add field “Total transaction Points““Transaction balance“

    • pointsEarned - pointsUsed consider bonusPoints as well

  • Add field “Final points balance“

    • transaction?.loyaltyTransaction?.pointsBalance + (pointsEarned - pointsUsed) consider debits as well

image-20240821-173524.pngImage Removedimage-20240829-111852.pngImage Added

Expand
titleImprove Order Details Screen

File: src/components/points-details-card/index.tsx
Changes:

  • Attention - Some labels have changed, but Figma has not been updated:

    • Total Transaction Points → Transaction balance

    • Points Used → Points Burned

  • Add field “Initial points balance“

  • Add “ - “ before “Points used”burned”

    • Add “-“ only in numbers greater than 0'

      • points used: 0

      • points used: -123

  • Add filed “Total transaction points““Transaction balance“

    • pointsEarned - pointsUsed consider bonusPoints as well

  • Label “Balance“ to “Final points balance“

    • pointsBalance + (pointsEarned - pointsUsed) consider debits as well

image-20240821-173549.pngImage Removedimage-20240829-111936.pngImage Added

Expand
titleCreate new utils with functions to calculate transactions values

File Local src/utils/utils.ts

  • function to calculate initial points value

  • function to calculate earn points value (earn + bonus)

  • function to calcutate transaction points value (earn + bonus - used)

  • function to calculate final point value (balancePoints + (pointsEarned - pointsUsed) )

...

Create and enable a new feature flag: display-points-balance, this flag is temporary and we will create a technical debt to remove this flag.

Configuration of Product Loyalty Points Price

...

For existing products, we can change the number of points required to obtain them. For example, in DEV PLK ES, we can utilize the product [LOYALTY] Menú 8 alitas picantes mediano.
We can configure parameters such as the required points to use this product and the number of times it can be used per day.

image-20240816-163214.png

Status Order

The order has ha,s a status to inform if need it needs to add, remove, or ignore the points.

More details here /wiki/spaces/PBP/pages/4856185403

...

Exist Exithe sting the CONFIRMED status as well, and this status is added for the orders that are placed, but not finished, for example, a delivery order is placed, but it's in the delivering progress, not marked as delivered.
In this status the system doesn’t calculate the points.
More details here

Jira Legacy
serverSystem Jira
serverId255417eb-03fa-3e2f-a6ba-05d325fec50d
keyINMS-763


We made some questions to loyalty-team in this thread https://rbidigital.slack.com/archives/C04FZ5HTH35/p1723558227000749

...

Step

Expected Results

If the FF is enable

Show new fields on the screens:

  • Loyalty Transactions

  • Orders

  • Recent Orders

Existing orders with the status CLAIMED

Show the order with earned values, used values, transactions, initial points, and final points.

In this status, the calculation must change the user's final points.

image-20240821-175950.png

Existing orders with the status CONFIRMED

Show the order with earned values, used values, transactions, initial points, and final points.

In this status, the calculation must not change the user's final points.

After complete delivery this status change to CLAIMED or VOID

image-20240821-175634.png

Existing orders with the status VOID

Show the order with earned values, used values, transactions, initial points, and final points.

In this status, the calculation must not change the user's final points.

image-20240821-175734.pngImage Removedimage-20240826-130423.pngImage Added

If the user has 2 or more order with CONFIRMED

Show the order with earned values, used values, transactions, initial points, and final points.

In this status, the calculation must not change the user's final points.

After complete delivery this status change to CLAIMED or VOID

For each order, the initial and final points are the same because confirmed transactions do not accumulate points.

If the user has 2 or more order with CONFIRMED and change to VOID

Show the order with earned values, used values, transactions, initial points, and final points.

In this status, the calculation must not change the user's final points.

The order change to VOID and don’t change the final poins

If the user has 2 or more order with CONFIRMED and change to CLAIMED

Show the order with earned values, used values, transactions, initial points, and final points.

In this status, the calculation must not change the user's final points.

The order change to CLAIMED and change the final poins

If the user has 2 or more order with CONFIRMED and change one to CLAIMED and other to VOID

Show the order with earned values, used values, transactions, initial points, and final points.

In this status, the calculation should adjust the user's final points solely based on the value of the order that has been marked as claimed. The void should be completely disregarded, as its values are outdated.

AttetionAttention:

If the oldest order is successfully completed (CLAIMED) and the most recent one fails (VOID), the value of the CLAIMED order will impact the final points. However, the VOID order will not impact the points and will retain its initial and final values as outdated, since when an order is marked as VOID, it is not considered.

image-20240820-135926.png

image-20240820-140013.png

...