Skip to content

Magento_Rma

Magento Modules:

  • Magento_Rma
  • Magento_RmaGrahpQl
  • Magento_RmaStaging

Only Magento_Rma contains storefront affecting logic/output.

Adobe Commerce Packages

  • magento/module-rma
  • magento/module-rma-graph-ql
  • magento/module-rma-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-rma

Features

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

  • basic - does not break layout/design

Note: All below features assume output only if RMA is enabled in Stores > Configuration: sales/magento_rma/enabled.

Customer Account Area (all pages)

  • customer/account add to navigation menu
    • in the menu, but needs ordering

Order Detail View (/sales/order/view/order_id/{id}/)

  • [P1] Display 'Return' button/link
  • [P1] Only display 'Return' link if the order contains items that are eligible for return

Order Invoice Detail View (/sales/invoice/view/order_id/{id}/)

  • [P1] Display 'Return' button/link
  • [P1] Only display 'Return' link if the order contains items that are eligible for return

Note: it is a decision design not to show additional buttons on invoices/shipments/credit memos, and therefore, this button output will not be replicated.

Order Shipment Detail View (/sales/shipment/view/order_id/{id}/)

  • [P1] Display 'Return' button/link
  • [P1] Only display 'Return' link if the order contains items that are eligible for return

Note: it is a decision design not to show additional buttons on invoices/shipments/credit memos, and therefore, this button output will not be replicated.

Order Refund (Credit Memo) Detail View (/sales/creditmemo/view/order_id/{id}/)

  • [P1] Display 'Return' button/link
  • [P1] Only display 'Return' link if the order contains items that are eligible for return

Note: it is a decision design not to show additional buttons on invoices/shipments/credit memos, and therefore, this button output will not be replicated.

Order Returns Detail View (/rma/returns/returns/order_id/{id}/)

  • [P1] Display content from other order view pages
    • Order number, status, date placed, order/invoice/shipment/creditmemo links (as applicable), order shipping and billing info (and addresses)
  • [P1] Returns listing table
    • Return # (ID), Date, Ship From (Name), Return Status and Actions columns
  • [P1] Displays returns related to current order only
  • [P1] View return action
  • [P2] Pagination works
  • [P2] Limiter works
  • [P2] No results message (when no returns placed)

Create New Return (/rma/returns/create/order_id/{id}/)

  • [P1] Display order information
    • Order ID, customer name, customer email, shipping address
  • [P1] Display returns form
  • [P1] Display 'Contact Email Address' field
    • [P2] Field validation: email
  • [P1] Display initial items to return section with first item preselected
  • [P1] Allow adding additional items
  • [P1] Allow removing additional items (not the first item)
  • [P1] Allow adding comments
  • [P1] Display form submit button
  • [P1] Submitting form creates a new return with the relevant data (assuming validation passes)

Items To Return Section

For each item within the main returns form:

  • [P1] Display Item To Return select dropdown
  • [P1] Display Quantity To Return input
    • [P2] Field validation: required
    • [P2] Field validation: number
    • [P1] Field validation: number max value (the number of qty eligible to return)
    • [P1] Remaining qty displayed alongside/below field
    • [P1] Remaining qty updates based on qty input in the field
    • [P1] Remaining qty considers and updates qty entered in additional item rows for the same item
    • [P1] If a number higher than the current remaining qty is entered, replace it with the remaining qty instead
      • This is currently replaced with 0 instead, which is not ideal
  • [P1] Display 'Resolution' select dropdown
    • [P1] Options display and are ordered as per set against the attribute*
    • [P1] Default option (is set) is selected as per set against the attribute*
    • [P2] Field validation: required
  • [P1] Display 'Item Condition' select dropdown
    • [P1] Options display and are ordered as per set against the attribute*
    • [P1] Default option (is set) is selected as per set against the attribute*
    • [P2] Field validation: required
  • [P1] Display 'Reason To Return' select dropdown
    • [P1] Options display and are ordered as per set against the attribute*
    • [P1] Default option (is set) is selected as per set against the attribute*

    Note: the 'Other' option is not admin controllable and should always appear last

    • [P2] Field validation: required
  • [P1] Display 'Other' input
    • [P1] Field should only display if the 'Other' option is selected on the 'Reason To Return' field

      Luma bug: this currently works for the first field, but on additional fields, this outputs by default (this is fixed in Hyvä)

    • [P2] Field validation: required, but only when visible
  • [P1] Additional custom attributes* are rendered

*Note: managed under Stores > Attributes > Returns

Custom Return Attributes
  • [P1] Custom attributes output after default fields
  • [P1] Attributes only output if set to be shown in the storefront
  • [P2] Attributes output in correct sort order

The above also applies to the system 'Resolution', 'Item Condition' and 'Reason To Return' (and 'Other') fields.

Field Type Support (click to expand items checklist)
Text Field
  • [P1] Attribute input field displays
  • [P1] Title outputs with correct label (for current storefront)
  • [P1] Default value outputs (if set)
  • [P1] Required field validation works
  • [P2] Input/output filtering works (escape/strip tags)
  • [P2] Additional field validation works
    • [P2] Alphanumeric
    • [P2] Alphanumeric with spaces
    • [P2] Numeric Only
    • [P2] Alpha Only
    • [P2] URL
    • [P2] Email
    • [P2] Minimum Text Length
    • [P2] Maximum Text Length
  • [P1] Values saved on form submission
Text Area
  • [P1] Attribute input field displays
  • [P1] Title outputs with correct label (for current storefront)
  • [P1] Default value outputs (if set)
  • [P1] Required field validation works
  • [P2] Input/output filtering works (escape/strip tags)
  • [P1] Values saved on form submission
Dropdown (Select)
  • [P1] Attribute input field displays
  • [P1] Title outputs with correct label (for current storefront)
  • [P1] Options output with correct labels (for current storefront)
  • [P1] Options output in correct order (as per admin)
  • [P1] Default value outputs (if set)
  • [P1] Required field validation works
  • [P1] Values saved on form submission
Yes/No
  • [P1] Attribute input field displays
  • [P1] Title outputs with correct label (for current storefront)
  • [P1] Default value outputs (if set)
  • [P1] Required field validation works
  • [P1] Values saved on form submission
File (Attachment)
  • [P1] Attribute input field displays
  • [P1] Title outputs with correct label (for current storefront)
  • [P1] Required field validation works
  • [P2] Additional field validation works
    • [P2] Maximum File Size
    • [P2] Allowed File Extensions
  • [P1] Values saved on form submission
Image File
  • [P1] Attribute input field displays
  • [P1] Title outputs with correct label (for current storefront)
  • [P1] Required field validation works
  • [P2] Additional field validation works
    • [P2] Maximum File Size
    • [P2] Maximum File Width
    • [P2] Maximum File Height
  • [P1] Values saved on form submission

Returns Listing Page (/rma/returns/history/)

  • [P1] Returns listing table
    • Return # (ID), Date, Ship From (Name), Return Status and Actions columns
  • [P1] View return action
  • [P2] Pagination works
  • [P2] Limiter works
  • [P2] No results message (when no returns placed)

QA Notes

  • [P3] Secondary page title needs larger text to match other pages

Returns Detail View Page (/rma/returns/view/entity_id/{id}/)

  • [P1] Display return ID and status
  • [P1] Display return information
    • ID, Order ID, Date Requested, Email and Contact Email Address (if set)
  • [P1] Display shipping address
  • [P2] Display shipping and tracking information
    • [P2] Only displays if tracking information added to return
    • [P2] 'Track This Shipment' link (opens popup with shipment tracking info)
    • [P2] 'Print Shipping Label' link (opens page with shipping label)
      • Only displays if shipping label exists for RMA
    • [P2] 'Show Packages' link (opens page with shipment packages info)
      • Only displays if shipping label exists for RMA
    • [P2] List each tracking item added
      • Carrier, Number (with link to open print view popup with tracking info for) and Action
      • Remove action only displays for customer created carrier items
    • [P2] Add additional carrier
      • Adds selected carrier and number to above list
      • Only displays if custom carriers are available to choose from
  • [P1] List items returned
    • Product Name, SKU, Condition, Resolution, Request Qty, Qty, Status
  • [P1] Display togglable details section that contains custom attribute labels/values
    • [P2] Details section is hidden by default

    Note: the questions/answers labels are from Luma and could be updated to be more meaningful

  • [P1] Comments section
    • Outputs all comment history (from customer and admin user)
  • [P1] Leave a comment form
    • [P1] Display text area and submit button
    • [P2] Text area is a required field
    • [P1] Submitting form stores the comment and adds to comment history section

QA Notes

  • [P2] Page title (ID and status) needs styles to bring in line with other pages (e.g. order view)
    • Status should only be after secondary title and inside a box
  • [P3] Custom image attributes image output should have max height/width to reduce size (images are very large at present)
  • [P3] Recently ordered products section is in the incorrect place on the page - under main contents, should be under the sidebar (customer account navigation menu)
  • [P3] 'Track This Shipment' / 'Print Shipping Label' / 'Show Packages' links need better spacing/styles (perhaps make buttons)

Tracking Links

Tracking Popup

All Carriers (/rma/tracking/popup?hash={hash})
  • [P2] Displays 'Tracking Information' title
  • [P2] Displays shipment number
  • [P2] Displays tracking title for each carrier
  • [P2] Displays tracking number for each carrier
Individual Carrier (/rma/tracking/popup?hash={hash})
  • [P2] Displays 'Tracking Information' title
  • [P2] Displays tracking title for given carrier
  • [P2] Displays tracking number for given carrier

Tracking Print Label (/rma/tracking/printlabel?hash={hash})

  • [P2] Outputs PDF copy of label for printing

Tracking Package (/rma/tracking/package?hash={hash})

  • [P2] Outputs details of packages for the shipment
    • Package type, length, total weight, width, height
  • [P2] Outputs details of items within packages for the shipment
    • Product (name), weight, qty
  • [P2] Link to print package details
  • [P2] Link to close window (go back to returns view page)

Tracking Package (/rma/tracking/packageprint?hash={hash})

  • [P2] Outputs PDF copy of package (packing slip) for printing

Guest Orders View

Note: guest orders are accessed via /sales/guest/form/ when logged out.

Guest Order Detail View (/sales/guest/view/)

  • [P2] Display 'Return' button/link
  • [P2] Only display 'Return' link if the order contains items that are eligible for return

Guest Order Invoice Detail View (/sales/guest/invoice/order_id/{id}/)

  • [P2] Display 'Return' button/link
  • [P2] Only display 'Return' link if the order contains items that are eligible for return

Note: it is a decision design not to show additional buttons on invoices/shipments/credit memos, and therefore, this button output will not be replicated.

Guest Order Shipment Detail View (/sales/guest/shipment/order_id/{id}/)

  • [P2] Display 'Return' button/link
  • [P2] Only display 'Return' link if the order contains items that are eligible for return

Note: it is a decision design not to show additional buttons on invoices/shipments/credit memos, and therefore, this button output will not be replicated.

Guest Order Refund (Credit Memo) Detail View (/sales/guest/creditmemo/order_id/{id}/)

  • [P2] Display 'Return' button/link
  • [P2] Only display 'Return' link if the order contains items that are eligible for return

Note: it is a decision design not to show additional buttons on invoices/shipments/credit memos, and therefore, this button output will not be replicated.

Guest Order Returns Detail View (/rma/guest/returns/order_id/{id}/)

See main account area order returns view section above for granular compatibility (too many features to duplicate below)

  • [P2] Order returns view works as per logged in version

Guest Create New Return (/rma/guest/create/order_id/{id}/)

See main account area create new return section above for granular compatibility (too many features to duplicate below)

  • [P2] Guest creation form works as per logged in version

Guest Return Detail View (/rma/guest/view/entity_id/{id}/)

See main account area view return section above for granular compatibility (too many features to duplicate below)

  • [P2] Guest return view works as per logged in version

Contributors

Voting

Use 👍 to cast your vote.

Edited by John Hughes
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information