True Order Edit

Introduction

What is True Order Edit?

Without creating a duplicate order (default Magento creates separate orders), this module allows administrators to quickly edit Magento orders, eliminating the source of many syncing issues between Magento, CSRs, fulfillment systems, credit card processing and accounting.

How it Works

With True Edit Orders, you can quickly edit billing and shipping information, shipping methods, item price and tax class, update item quantity, and add or remove items directly from the Order Details page. Depending upon your credit card processor, the module even provides the ability to re-auth if the edited order total exceeds the original total.

For each edit, the module automatically creates a note detailing the changes made, appends the CSR's name, adds a date / time stamp, and allows room for an optional comment.

Pre-requisites

Code/Conflicts

• NO EDITS OR MODIFICATIONS TO MAGENTO CORE (Typically, this includes all code inside the app/code/core folder)
• No conflicting modules (or conflicting custom code) installed (Typically, if installed component/module affects same functionality as True Order Edit--order-editing related, you should be wary of conflicts)

Magento Version

• Community Edition 1.4.1 - Backwards compatible to 1.3 and 1.4.x users in version 2.0 (1.5.0.x compatible 3.0.0 beta now available)

Installation

Installing on Magento CE 1.5.0.x

As of this writing, we've been successfully testing True Order Edit on installs of CE 1.5.0.1 using the new MCM (Magento Connect Manager) and no command line. While we're in beta, to accomplish this, you'll have to rename/remove two template files BEFORE installation:

• app/design/adminhtml/default/default/template/sales/order/view/items.phtml
• app/design/adminhtml/default/default/template/sales/order/view/items/renderer/default.phtml

Renaming them to something like items-old.phtml will do the trick. Without moving/removing these files, the Magento Connect Installation will fail.

Installing the Basic Application

Navigate to the root of your application. You should see folders like (app, downloader, skin, etc...). If you have not already used Magento Connect or any other Pear package management for your installation, you will need to run the following:

If you receive a permission error, run the following:

Then (Replace /path/to... with the path to your True Order Edit TarBall.):

If you get a message after running this command that has something to do with file conflicts, then you'll need to modify the command to add a -f in it like this:

If you ever need to UN-install True Order Edit, you can run:

Configuration

Backwards Compatibility (as of 2.0 - if you have a version lower than 1.4.1.0)

The following MUST be renamed (To replace the current files) to enable True Order Edit to work any magento version below 1.4.1.0 (It's been tested down to Magento 1.3):

app/code/community/TinyBrick/OrderEdit/Model/Resource/Order/ Address(rename).php

app/code/community/TinyBrick/OrderEdit/Model/Resource/Order/ Address/Collection(rename).php

Settings

True Order Edit also has a few settings (as of 2.0) that allow you to control how it behaves over your entire application. To access these settings browse to System -> Configuration -> True Order Edit (On left side). Once there, you should see something like the following:

If you're seeing a blank page instead, you may need to refresh your admin.

The breakdown is as follows:

1. Enabled: Allows you to disable or enable the entire output of the module. Other methods using the module's xml file aren't as comprehensive because of the overwritten templates to accomplish the changes to the order view.
2. Re-Authorize Payment?: This selection allows you to set whether True Order Edit re-authorizes the payment that was already made. You enable this if you have your payment processor and fulfillment process setup to handle a new authorization before shipments are sent. Some setups do not allow this because they "authorize and capture" at the same time. In that case, a new authorization wouldn't do anything so it's recommended that it be disabled for customers with that sort of setup.
3. Order status allowed to be edited: In previous versions any order was allowed to be edited, however, some orders (depending on your setup) should not be. This allows you to select one or more order statuses where the edit button should even appear.

General Usage

Overview

So you've gone through the installation. Now, let's give you a tour of how to use True Order Edit from the admin. The Order View is arranged in sections, as seen below. With this module, Billing Address, Shipping Address, Shipping & Handling Information, and Items may be edited. The new Order View page includes a large button labeled 'Edit Order' which appears above all sections. When the button is clicked, the editable sections of the page open, calculating new shipping rates and methods. After editing content, the 'Edit Order' button updates to a 'Save Changes' button which will commit final edits to the database.

The Pieces

1. Comments: The first field is labeled 'Reason for editing order'. This field is required, and will be logged in the Comments History section when an edit is saved.
2. Billing Address: This section contains the order's Billing Address information, including tele- phone number. To edit this section, simply re-key values or select from the dropdown lists.
3. Shipping Address: This section contains the order's Shipping Address information, including telephone number. To edit this section, simply re-key values or select from the dropdown lists.
4. Shipping & Handling Information: Current rates for an updated shipping address are displayed here. If no new selection is made, there will be no modification to the shipping method or order price. If a change is required, simply select the radio button indicating the desired change. Also, as of 1.0.2, a custom shipping field is also added to allow you to enter a custom shipping carrier, method, and price (can be useful if no other table rates are setup).
   The 'Get new shipping methods and rates' link will retrieve current shipping rates, based on the information in the Shipping Address fields.

   Note

   This function retrieves rates based on the values which exist in the Shipping Address text boxes, rather than the order's saved Shipping Address. It is recommended to retrieve new Shipping Methods and Shipping Rates if the order's Shipping Address has been updated.

5. Items: There are three operations available with Product updates: Edit, Delete, and Add. When Editing or Adding an item you can change the price, quantity, or discount the item.
   • Editing: Edit a product's price directly on the line item. Simply type the desired value for that product.
   • Deleting: Click the 'Remove' link at the right of the line item. When an item is marked for deletion, the details will be grayed out. To keep a product that has been marked for deletion, click 'Undo Remove'.
   • Adding: At the right of the Items Grid is a button labeled 'Add Item'. Click to Add new products. A new row will appear, requesting a SKU. After entering a SKU – and upon leaving the field – price, quantity, and name for the product will appear. You may then enter quantity, and if desired, a custom price and/or discount amount for the new item.
6. The Final Save: When all order information is correct, click the 'Save Changes' button at the top of the page. This will save all information to the order, and recalculated totals based on the new information.
7. Comments History: The module tracks order updates, appending changes and the required Reason Comment to the comment history. Comments record changes, date and time stamp, user making the change, and the original values which were updated, as seen below:

Developer Reference

Create Additional Editable Sections (If you've added any)

If you desire to add other sections to the Order View, the True Edit Orders module allows additional custom sections to be added relatively simply. Each section includes an updater file that handles its own saving. The procedure of creating a new section are as follows:

• Create the Section Form on the Order View in the location you require. This is usually a field-set with display set to none, as shown through the javascript below.
• The javascript that sends data from all sections is found in app/design/adminhtml/{your admin theme folder}/default/template/sales/order/view/tab/info.phtml. Javascript which retrieves these values are commented for easy identification. All data sets are given a type, usually a hidden field in the form above, identifying which updater to use. This information is sent as a JSON string in the request.
• Create an updater file. The existing files are located in app/code/community/TinyBrick/ OrderEdit/Model/Edit/Updater/Type/. Included are an abstract class to extend, as well as existing updaters to serve as reference. These files return true if there is no error, or, if you require your updater to log changes to the comment section, return a string including the changes. If an error is thrown, it should return false.
• Once an order is edited, the module fires and event called orderedit_edit. You may create custom listeners for purposes such as merchant services or fulfillment systems.

Known Limitations

• Re-Authorizations - If you choose to enable Re-Authorizations in the True Edit Order config settings, please be aware that this is new functionality that has not been enterprise tested. You're welcome to try it, but don't be surprised if it doesn't work for situation. Un-expected results can occur. Also, check with your gateway provider first to find out how they handle re-authorizations. Our module will simply re-authorize with the same payment method (magento default - $method->authorize()) as the original order.
• Re-Calculate Shipping - If you choose to enable Re-Calculate Shipping, be aware that most shipping methods are not set up to calculate based on an "Order", rather they are set up to calculate based on a "Quote" like during checkout. We include the flatrate method. Custom rates can still be entered.
• Adding Products to Orders - Products can only be added to orders via a simple SKU.
• Editing Customer Account Info - While Billing and Shipping info CAN be edited, customer account info like Name and Email cannot.
• Inventory - Adding or removing items does not adjust the inventory level of those items.