Magento_Reward

Magento Modules:

• Magento_Reward
• Magento_RewardGraphQl
• Magento_RewardStaging

Adobe Commerce Packages

• magento/module-reward
• magento/module-reward-graph-ql
• magento/module-reward-staging

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-magento-reward

Features

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

• basic - does not break layout/design

Note: many features are related to the checkout, which all work using the fallback Luma checkout. See #121 for details on Hyvä Checkout 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.

Cart (/checkout/cart/)

Feature complete (click to expand items checklist)

• [P1] Display logged-out message

• [P1] Display logged-in message

• [P3] Show applied reward points in summary totals
  • Only displays if points are applied at checkout then you return to the cart page

Customer Account

Customer Account Create (/customer/account/create/) && Invitation Account Create (/invitation/customer_account/create/invitation/{hash}/)

Feature complete (click to expand items checklist)

• [P1] Display message to inform on the number of points earned for creating an account
  • [P1] Amount set should match the value set in config (magento_reward/points/register)
  • [P1] Only displays if a positive value is set in config (magento_reward/points/register)
• [P1] Display message to inform on the number of points earned for signing up for the newsletter
  • [P1] Amount set should match the value set in config (magento_reward/points/newsletter)
  • [P1] Only displays if a positive value is set in config (magento_reward/points/newsletter)

All Customer Account Pages (/customer/account/)

Feature complete (click to expand items checklist)

• [P1] Show 'Reward Points' link in account navigation menu
  • [P2] Displays only if 'Customers May See Reward Points History' (magento_reward/general/publish_history) configuration setting is enabled

Reward Points Balance History (/reward/customer/info/)

Feature complete (click to expand items checklist)

• [P2] Page only accessible if 'Customers May See Reward Points History' (magento_reward/general/publish_history) configuration setting is enabled
• [P1] Display page title
• [P1] Display information heading with link to CMS page
• [P1] Display current balance amount (in points and currency)
• [P1] Display points balance limit (if set in config - magento_reward/general/max_points_balance)
  • 0 value should disable output
• [P1] Display minimum points balance for redemption (if set in config - magento_reward/general/min_points_balance)
  • 0 value should disable output
• [P1] Display points expiry date (if set in config - magento_reward/general/expiration_days)
  • 0 value should disable output
• [P1] Display balance history list/table
  • Balance, amount, points, reason, date
• [P1] Email notification section: heading, checkbox options and button
• [P1] Email notification form submits/saves/updates settings

Newsletter Subscription (/newsletter/manage/)

Functionality (and template) the same as account create page

Feature complete (click to expand items checklist)

• [P1] Display message to inform on the number of points earned for signing up for the newsletter
  • [P1] Amount set should match the value set in config (magento_reward/points/newsletter)
  • [P1] Only displays if a value is set in config (magento_reward/points/newsletter)

Orders

Order / Invoice / Credit Memo Detail View (/sales/order/view/order_id/{id}/ / /sales/order/invoice/order_id/{id}/ / /sales/order/creditmemo/order_id/{id}/)

Feature complete (click to expand items checklist)

• [P1] Display number of points spent (points and currency amount) in order totals
• [P1] Display number of points spent (points and currency amount) in invoice totals
• [P1] Display number of points refunded (points and currency amount) in credit memo (refund) totals

Order / Invoice / Credit Memo Print View (/sales/order/print/order_id/{id}/ / /sales/order/printinvoice/invoice_id/{id}/ / /sales/order/printCreditmemo/creditmemo_id/{id}/)

Feature complete (click to expand items checklist)

• [P1] Display number of points spent (points and currency amount) in order totals
• [P1] Display number of points spent (points and currency amount) in invoice totals
• [P1] Display number of points refunded (points and currency amount) in credit memo (refund) totals

Purchase Order Detail View (/purchaseorder/purchaseorder/view/request_id/{id}/)

Feature complete (click to expand items checklist)

• [P2] Display number of points spent (points and currency amount) in totals

Invitations

My Invitations (/invitation/index/) & Send Invitations (/invitation/index/send/)

Feature complete (click to expand items checklist)

• [P2] Display message to inform how many points are earned (and equivalent in currency) when inviting customers

  • [P2] Amount set should match the value set in config (magento_reward/points/invitation_customer)
  • [P2] Only displays if a value is set in config (magento_reward/points/invitation_customer)
  • [P2] Displays the limit (number) of customers that can be invited (magento_reward/points/invitation_customer_limit)
    • Non positive value disables this output

• [P2] Display message to inform how many points are earned (and equivalent in currency) when invited customers place an order

  • [P2] Amount set should match the value set in config (magento_reward/points/invitation_order)
  • [P2] Display current points balance
  • [P2] Only displays if a value is set in config (magento_reward/points/invitation_order)
  • [P2] Displays the limit (number) of customers that can be invited (magento_reward/points/invitation_order_limit)
    • Non positive value disables this output

Reviews

Product Reviews List (/review/product/list/id/{product_id})

Feature complete (click to expand items checklist)

• [P2] Display message to inform on the number of points earned (and equivalent in currency) for submitting a review
  • [P2] Amount set should match the value set in config (magento_reward/points/review)
  • [P2] Only displays if a positive value is set in config (magento_reward/points/review)
  • [P2] Display current points balance
  • [P2] Display link to reward points CMS page (if set)
  • [P2] Display how many more reviews can be submitted until the limit is reached based on the value set in config (magento_reward/points/review_limit) - should not display if this limit is not set

Future Enhancement Considerations

• [P3] Add to default product page route also - /catalog/product/view/id/{id}

Note: this would require a client-side implementation to not affect full page cache due to use of customer data in message (current points balance).

Actions for gaining points

Feature complete (click to expand items checklist)

Test/confirm the following interactions add the relevant number of points (as set in configuration) to the customer's account (i.e., they can be seen in points balance/history).

• [P1] Earn points based on the amount spent on orders (based on the conversion rate set)
• [P1] Earn points for creating an account
• [P1] Earn points for signing up for the newsletter
• [P1] Earn points for leaving a product review
• [P1] Earn points for inviting customers
• [P1] Earn points for invited customers placing an order (note order needs to be invoiced)

Contributors

Voting

Use 👍 to cast your vote.