Magento_Reward (Hyvä Checkout)

Magento Modules:

• Magento_Reward

Adobe Commerce Packages

• magento/module-reward

Repository

Note: this repo is only accessible with a Hyvä Enterprise license or as a contributor.

For more details, see: https://www.hyva.io/hyva-enterprise.html.

https://gitlab.hyva.io/hyva-enterprise/commerce/magento2-ee-hyva-enterprise-checkout

Features

All points are rated according to priority as P1 (critical), P2 (important), P3 (minor).

• basic - does not break layout/design
• All built-in checkout layouts supported (default, one page, mobile)

Note: this issue is for features related to the checkout only. See #57 for details on Hyvä Theme compatibility.

Note: all features assume reward points are enabled (magento_reward/general/is_enabled), set to be displayed on the storefront (magento_reward/general/is_enabled_on_front), and points<->currency conversion rates have been configured. It is also recommended that 'Zero Subtotal Checkout' payment method is enabled in order for the full order amount to be covered by reward points (solely or alongside other discounts). It also assumes the customer is checking out as a logged in user and has a positive reward points balance.

Order Summary Panel

• [P1] A reward points section should sit under/alongside the existing coupon code section (if enabled)
  • This should be collapsed/unfolded on page load (like coupons) with the heading 'Apply Reward Points' (this is slightly different to Luma, but adds better consistency with other features like coupon codes and gift cards)
• [P2] Add a 'Stores > Configuration' setting within the Hyvä Checkout section to hide/show the reward points section
  • Again, see coupon code functionality for replication
• [P1] The customers' current reward points balance should be displayed
  • Both the number of points and the currency amount
• [P1] The available points can be applied by clicking/tapping the 'Use Reward points' button
• [P1] Once applied the reward points display as a discount row in the totals along with a success message
  • This displays the amount, along with a 'Remove' link (note this is a button in Luma, either is fine so long as consistent with other removable totals - gift cards/store credit)
  • Success message: 'Your reward point was successfully applied'
  • The original reward points section (with balance/use button) is hidden
• [P1] If the reward points balance is less than the remaining order total, then the full balance is applied
  • This rounds to the nearest full unit of currency
• [P1] If the reward points balance is more than the remaining order total, then the value of the remaining order is applied
  • This rounds to the nearest full unit of currency (in points)
• [P1] Reward points can be removed by clicking the 'Remove' link alongside the total and displays a success message
  • The original reward points section (with balance/use button) is re-instated (no longer hidden)
  • Success message: 'You removed the reward points from this order.'

Future enhancement / UX consideration: don't hide the reward points section when applied, but persist and update the button so reward points can removed from the same place. This means the 'remove' link could be removed from the totals.

Reward Points Section (unapplied)

Reward Points Applied (with message & totals)

Reward Points Message (removed)

Reward Point Conditions

• [P1] The reward points section and the ability to apply them should be removed/disabled if the customers' points balance is below the minimum threshold to redeem

This is configured in 'Stores > Configuration': (magento_reward/general/min_points_balance).

Payment Method Section

Note: it is not expected any customisations are needed here, but is rather included for testing/thoroughness.

• [P1] If the reward points total (with or without other discounts) covers the cost of the entire order then the 'Zero Subtotal Checkout' method should replace all other methods

Order Placement

Note: it is not expected any customisations are needed here, but is rather included for testing/thoroughness.

• [P1] The order is placed with the applied reward points and the amount is correctly applied to the grand total
• [P1] The customers' reward points balance is updated correctly
• [P1] If points are earned for purchases then the relevant points based on the order total should be added to the customers' reward points balance
  • This setting is managed in 'Stores > Configuration' (magento_reward/points/order)

Voting

Use 👍 to cast your vote.