R2R Withdrawal documentation

What R2R Withdrawal does

R2R Withdrawal handles withdrawal declarations for HikaShop orders and their administration. Customers identify an order, select the products and quantities, review their declaration and confirm submission. Each withdrawal becomes a separate case in the Joomla administrator area.

The package installs a component, a shared library, two plugins and an administrator module. It needs no Joomla or HikaShop core-file changes. It does not transfer refunds or change the HikaShop order status.

Installation and first run

1. Back up your site and start in a test environment. See the compatibility table for the combinations already tested. PHP 8.1 or later is required.
2. In Joomla, open System → Install → Extensions and upload the complete pkg_r2r_withdrawal-…zip package. Do not install its inner ZIP files separately.
3. Under System → Plugins, enable System – R2R Withdrawal and Ajax – R2R Withdrawal.
4. Set your shop name and notification email addresses in the system plugin. Separate multiple addresses with commas, semicolons or line breaks.
5. Create a published, publicly accessible menu item of the Withdrawal declaration (wizard) type. An alias such as withdrawal gives it a permanent address.
6. Open the component’s Help and checks page, run the checks, then submit a test withdrawal as both a guest and a registered customer.

Make the link easy to find. If HikaShop’s built-in withdrawal workflow is also enabled, check for duplicate entry points. R2R keeps its own cases; it does not share the native feature’s case list.

System plugin settings

Shop-specific settings are in the System – R2R Withdrawal plugin. Check the customer-facing result after saving.

Guidance for each step

The wizard text tab provides before-and-after fields for order identification, item selection, the summary and confirmation. There are two more for the success page: ten optional text positions in total.

An empty field adds no extra text. Basic HTML such as paragraphs, emphasis, lists and links is supported, with unsafe elements filtered on save. Your own content is shop-specific; the supplied Hungarian and English language files do not automatically translate it.

Email templates and notifications

There are three editable templates: customer receipt, administrator notification and status update. HTML is supported. An empty template field uses the built-in version. Joomla’s mail service must work; check the actual inbox when testing.

Keep the braces around each placeholder. Keep the items, reference and timestamp in the receipt. Adapt custom text to your shop’s language and customer information.

Privacy and identification limits

IP storage is enabled by default, while browser identifier (User-Agent) storage is disabled. Both can be configured separately. The technical-data retention default is 365 days; 0 disables that automatic removal. Eligible technical data from closed cases is cleaned when the administrator opens the case list, rather than by a scheduled job.

Failed order-identification attempts can be limited by IP and order reference. Defaults are 10 and 5 attempts within 15 minutes. These controls protect order identification in your shop; they are separate from the regreen website download counter.

Your privacy notice should reflect the settings you use. Withdrawal data stays on your shop’s hosting; R2R does not send me your customers’ declarations.

The customer journey

1. Identify an order. Registered customers choose from their own orders. Guests enter the order reference and the email address used for that order.
2. Select items and quantities. Full and partial withdrawals are supported. Previously claimed quantities are taken into account; one order can have multiple declarations.
3. Review. The customer checks the selected items. A reason is optional.
4. Confirm. This creates the declaration, assigns a reference and starts the notification emails.

Rejected and cancelled cases do not reserve quantities against a new declaration. Verify both the submission result and the notification emails during testing.

Case handling and the dashboard

Open the component’s Withdrawals page. Each case has its items, quantities, history and refund information. Internal notes are separate from messages intended for the customer.

States include submitted, awaiting return, return received, under review, approved, refunded, rejected and cancelled. Only valid next transitions are offered. Rejection requires a reason. Decided cases can be reopened with a separate action.

The system suggests a refund amount. Review shipping costs, discounts and coupons. Make the actual payment through your own financial workflow and record it in the case.

The administrator module shows new-case counts, recent submissions and cases under review. Publish it in a suitable Joomla administrator dashboard position. The event log cannot be edited through the interface.

Updating and checking

Back up the website and database before updating. The package registers a Joomla update source, so you can check Joomla’s extension updates. You can also install the newer complete package over the existing installation. Do not uninstall first to perform an update.

Afterwards, check plugin status, the menu item, custom text, guest identification, a partial withdrawal and notification emails. See the changelog for release notes.

Troubleshooting

Use the support form with your Joomla, PHP, HikaShop and R2R versions, reproduction steps and exact error text. Do not send passwords or real customer data.