Order Editor for Magento 2

Overview

Edit a placed order in place: the same order number, the same order page. Change items (quantity, price, discount, add or remove a line), the billing and shipping address, the shipping method and amount and the payment method of offline orders. Totals and tax are re-collected, stock is reserved or released, and every change is written to an audit log.

Magento's own "Edit" button cancels the order and creates a new one with a new number. Order Editor does not.

Tested on Magento Open Source 2.4.8 (PHP 8.3). Compatibility with other versions is listed only after it has been tested. Not for SaaS editions that cannot run PHP modules.

What you get

• Items: change quantity, price (excluding tax) and discount of a line, add a product by SKU, remove a line.
• Addresses: correct the billing and the shipping address, with country and state checks.
• Shipping and payment: pick another shipping method and type the amount; switch between offline payment methods.
• Totals preview: see the order total, tax and discount before and after, before you save.
• Stock: higher quantities and new lines reserve stock (Inventory reservations), lower quantities and removed lines give it back.
• Safe: lines that are invoiced, shipped or refunded stay locked; a total below what the customer paid is refused; two admins cannot overwrite each other.
• Audit log: who changed what, when, and the order total before and after, on the order page and on one list for all orders.
• Permissions: separate rights for items, addresses, shipping, payment and the log.

Installation

Composer (recommended)

1. Add the Kavio Labs repository and your licence credentials (see your Kavio Labs account).
2. Run composer require kaviolabs/module-order-editor.
3. Run bin/magento module:enable KavioLabs_OrderEditor, bin/magento setup:upgrade and, in production mode, bin/magento setup:di:compile and bin/magento setup:static-content:deploy.

Zip upload

1. Download the zip from your Kavio Labs account.
2. Extract it into app/code/KavioLabs/OrderEditor/ (the folder holds registration.php).
3. Run the same bin/magento commands as above.

Uninstall

• Keep the data: bin/magento module:disable KavioLabs_OrderEditor (then delete the folder or composer remove the package and run setup:upgrade).
• Remove everything (tables, settings, licence state): Composer install bin/magento module:uninstall KavioLabs_OrderEditor --remove-data; zip install bin/magento module:uninstall KavioLabs_OrderEditor --non-composer, then module:disable, delete the folder and run setup:upgrade.

Configuration

Open Stores > Configuration > Kavio Labs > Order Editor.

1. Enter your licence key in Licence > Licence key and click Save Config. The key is verified at once.
2. The licence card shows the status, the licensed domain and the date until which updates are included. Check now verifies again.

General

Permissions

System > Permissions > User Roles > Role Resources > Sales > Operations > Order Editor has one right per kind of change:

• Edit items (add, remove, quantity, price)
• Edit addresses
• Edit shipping method and amount
• Edit payment method (offline methods)
• View the edit log

A section an admin may not edit is not shown on the edit page, and a save that tries to change it is refused.

Using the Order Editor

Open an order for editing

Open Sales > Orders, open an order and click Edit in place in the toolbar. The button appears for orders that are new, pending payment or processing (not on hold, complete, closed or cancelled) and for admins who have at least one Order Editor right.

Items

• Qty is a whole number of at least 1. Price (excl. tax) and Discount accept 12.50 or 12,50.
• Tick Remove to delete a line. An order must keep at least one line; to drop everything, cancel the order.
• Under Add products type the SKU of a simple or virtual product. Leave the price empty to use the current catalog price. Tax is calculated at the address of the order.
• If you change a line's quantity or price and leave its discount alone, the discount scales with the line total. Type a discount to set it yourself.
• Lines that were invoiced, shipped, refunded or cancelled are locked and show the reason. Configurable, bundle, grouped and downloadable products and lines with custom options are locked as well in this version.

Totals preview

Click Preview totals to see subtotal, shipping, tax, discount and the grand total before and after. Nothing is saved by the preview.

How the money is calculated: tax of a line is the line total minus its discount (or the plain line total, following your tax setting "Apply tax after discount") times the tax percent the line was ordered with; a new line uses the rate at the order's address. Shipping tax keeps the ratio the order was placed with. Other totals of the order, for example a payment fee from another module, are carried over unchanged. Cart price rules are not evaluated again.

Addresses

Correct names, company, street lines, city, state, postcode, country and phone. Country and state are checked against Magento's lists. The tax rate of existing lines does not change when the address changes.

Shipping and payment

• Shipping: choose among the active carriers' methods and type the amount (excluding tax). Rates are not re-quoted. Not available once a shipment exists or the shipping was invoiced or refunded.
• Payment: switch between active offline methods (for example Check / Money order, Bank Transfer, Purchase Order with a PO number). Not available for online methods, and not after an invoice or a payment.

Locked lines

On a partly invoiced order you can still change the open lines and add new ones. An edit that would bring the total below the amount already paid is refused: refund the difference with a credit memo instead.

Save

Add a note for the order history (optional), tick Notify the customer by e-mail if you want the customer to get the change by e-mail (uses the "order comment" e-mail of Magento; off by default), and click Save changes. The order keeps its number. If the order was changed by someone else since you opened the page, the save is refused; reload the page and edit again.

Stock follows the saved quantities through the Inventory reservations (the same way placing and cancelling an order does).

The edit log

Every saved edit is one row: time (UTC), admin, what was changed (items, addresses, shipping, payment), a one-line summary, the order total before and after and whether the customer was e-mailed. The rows are shown on the order page and, for all orders, under Sales > Operations > Order edit log. The summary is also added to the order's comment history.

FAQ

What is different from Magento's own "Edit" button?

The core button cancels the order and creates a new order with a new number (and a new quote, stock movement and e-mails). Order Editor changes the order you have: same number, same invoices and shipments, one history.

Can I edit an order that was invoiced?

Open lines yes, invoiced lines no. You can still add lines and correct addresses. The total can never be lowered below the amount already paid (use a credit memo to refund).

Can I edit a shipped order?

You can correct the addresses and change open lines. Shipped lines and the shipping method of an order with a shipment are locked.

Which products can I edit or add?

Simple and virtual products without custom options. Configurable, bundle, grouped, downloadable and custom-option lines are shown as locked.

Are cart price rules and promotions recalculated?

No. The discount of a line scales with its total or you type it. New lines get the discount you type, not a promotion.

Which tax rate does a new line get?

The rate of the product's tax class at the shipping address of the order (billing address for virtual orders), as Magento's tax calculation returns it. Existing lines keep the percent they were ordered with.

Does the tax breakdown by rate stay right?

The grand total, the tax of every line and the shipping tax are recalculated. The tax summary by rate (the lines under "Tax" on the order page) is scaled with the new tax total: exact when the order has one tax rate, an approximation when it has several.

Does it change the stock?

Yes. A higher quantity or a new line reserves stock, a lower quantity or a removed line gives it back, through the Inventory reservation API (the same API that placing and cancelling an order use). With "Check stock when quantities grow" on, a quantity that is not salable is refused.

Does the customer get an e-mail?

Only if you tick the box on the edit page and the order comment e-mail is enabled in Magento (Stores > Configuration > Sales > Sales Emails > Order Comments). The default is off.

Does it work with payment methods like PayPal or Stripe?

Payment methods that charge online are not changed by this module. The order can still be edited when only items, addresses and shipping change and nothing was paid; the payment section is locked for online methods.

What if two people edit the same order?

The page carries a token of the order's state. The first save wins; the second is refused with a message to reload.

Where is the history?

On the order page (Edit history), under Sales > Operations > Order edit log, and as a comment in the order's comment history.

Does it work with Hyva?

The module changes only admin pages. The storefront is not touched.

Does it work on SaaS editions?

No. It needs a store that runs PHP modules (Magento Open Source or Adobe Commerce, self-hosted or cloud).

Does the licence check slow down my store?

No. The store reads the stored result; the server is asked only from the Admin or once a day by cron after a key was entered.