Difference between revisions of "X-Cart:Advanced Order Management"

From X-Cart 4 Classic
Jump to: navigation, search
(Opening Orders for Editing)
m
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
== What X-AOM module does ==
+
==Overview==
 +
X-Cart's Advanced Order Management module allows you to edit your customers' orders after they have been placed. With this module you can add products to an existing order, remove products from order, update product prices and quantities, add/update discounts and coupons, change the delivery method and shipping cost, etc. In versions 4.5.3 and later, you can also create orders via the store's back end. This may help, for example, when a customer calls in to place an order.
  
'''X-AOM '''introduces a number of new features enabling you to modify your customers' orders after they are placed. It allows you to add/remove items from order, edit parameters of the order, change delivery method, change pricing, discounts, shipping and more.
+
Starting from version 4.3.0, the Advanced Order Management module is available as a built-in module in all X-Cart editions. It does not require installation and can be enabled in the Modules section of your store's Admin area.
 +
For versions 4.0.0-4.2.3, the Advanced Order Management module is available as an add-on module which can be purchased and installed separately.<br /><br />
  
The key features of this module include:
+
== Enabling the Advanced Order Management module==
  
'''1. Editing ordered products'''
+
To enable the module:
  
* adding new products to the order
+
# In Admin area, go to the <u>Modules</u> section (Settings menu -> Modules).
* removing products from the order
+
# Choose the <u>Advanced Order Management</u> module by selecting the respective check box on the left.
* updating the options and quantity of ordered products
+
# Click the '''Apply changes''' button. This activates the module.<br /><br />
* editing product prices
 
  
'''2. Editing Gift Certificates'''
+
== Configuring the Advanced Order Management module==
  
* changing the amount
+
In X-Cart versions 4.5.3 and later, after enabling the Advanced Order Management module, you should check and adjust the module's configuration settings:
* updating the original information (before the certificate has been activated)
 
  
'''3. Editing customer information'''
+
# In the <u>Modules</u> section (Settings menu -> Modules), click the <u>Configure</u> link opposite the module name ('Advanced Order Management').<br />The module configuration page (titled by the name of the module) opens:
 +
#: [[File:aom_settings.png|border]]<br /><br />
 +
# Adjust the settings on the module configuration page as needed. At present, there is only one setting, '''Username prefix for customer added when order is created in back-end'''. This setting is related to the [[#Creating orders with Advanced Order Management module|Create Order]] feature; it allows you to set a username prefix that will help you to identify automatically created customer profiles.<br />Whenever you create an order via the store's back end without linking it to an existing customer profile, the system automatically creates an anonymous customer profile for the person on whose behalf the order is being created. The username for such a profile is generated automatically as a string of numeric characters preceded by the username prefix specified in this field. For example, if the username prefix value is defined as "automatic", the usernames of automatically created customers will look as follows (Note the last three usernames in the list):
 +
#: [[File:automatic_customer.png|border]]<br /><br />
 +
# Click the '''Apply changes''' button to save the changes.<br /><br />
  
* updating personal and contact information
+
==Editing orders with Advanced Order Management module==
* editing billing/shipping addresses
+
To edit an order with Advanced Order Management, do the following:
 +
# In your store's back end, [[X-Cart:Orders#Finding_orders|find the order]] you want to edit and open its details. Now that Advanced Order Management module is enabled at your store, the 'Order details' page contains a button titled '''Modify''':<br />[[File:Order_details_modify.png|border]]<br /><div id="AOMLinks"> </div>
 +
#  Click the '''Modify''' button. This opens the 'Advanced Order Management' page where you can edit the order:<br />[[File:Aom.png|border]]<br />The top of the page provides links for access to the sections of the 'Advanced Order Management' page:<br />
 +
#* <u>[[#Previewing order details|Preview order]]</u>: Allows to preview the order details at any moment during the editing process.
 +
#* <u>[[#Editing ordered products|Edit ordered products]]</u>: Allows to add products to the order, remove products from the order, update product quantities and prices.
 +
#* <u>[[#Editing ordered gift certificates|Edit ordered gift certificates]]</u>: (This link is displayed only for orders containing ordered gift certificates; not available for orders created via the store's back end) Allows to edit the amount of the ordered gift certificate, remove the gift certificate from the order or access the 'Gift certificate details' page where virtually any details of the gift certificate can be edited.
 +
#* <u>[[#Editing customer information|Edit customer information]]</u>: Allows to edit customer information including personal information and billing/shipping addresses of the customer who placed the order.
 +
#* <u>[[#Editing order totals|Edit order totals]]</u>: Allows to change the payment and delivery methods selected for the order, the shipping cost, the amounts of applied global discounts and discount coupons, etc.
 +
#* <u>[[#Viewing the history of changes|History of changes]]</u>: Allows to view the history of changes made to the order.
 +
# Click the link you require and make the changes.
 +
# [[#Saving changes|Save the changes]].<br /><br />
  
'''4. Editing order totals'''
+
==Creating orders with Advanced Order Management module==
 +
Order creation with Advanced Order Management is available in X-Cart versions 4.5.3 and later. To create an order, do the following:
 +
# In your store's back end, go to the 'Create order' page (Orders->Create new order):<br />[[File:Create_order.png|border]]<br />
 +
# If the buyer for whom you are going to create the order does not have an account with your store, move on to the next step. If the buyer is an existing customer, select the customer account for which the order will be created:
 +
## Click '''Select customer'''. The 'Search for users' form opens in a new window:<br />[[File:Search_for_users.png]]<br />
 +
## Use the 'Search for users' form to find the customer you require.
 +
## In the search results, select the customer and click '''Submit''':<br />[[File:Search_for_users1.png]]<br />The name of the customer you selected appears in the '''Customer''' field on the 'Create order' page:<br />[[File:Create_order0.png|border]]<br />
 +
# Click '''Create new order'''.<br />This opens the Advanced Order Management page where you can create the order.<br />You are now at the [[#Editing_ordered_products|'Order #X: edit products' screen]] where products can be added:<br /> [[File:Create_order1.png|border]]<br />For access to the other sections of the Advanced Order Management page, use the [[#AOMLinks|links at the top of the page]].
 +
# Create the order by defining all the necessary order details:
 +
#* add products;
 +
#* enter customer information;
 +
#* choose the payment and shipping methods, add a global discount/discount coupon, check and adjust the shipping cost, etc.<br />For details, see the section [[#Advanced Order Management operations|Advanced Order Management operations]].<br /><br />
  
* changing delivery method
+
==Advanced Order Management operations==
* changing payment method
 
* automatic recalculation of discounts, shipping costs, tax costs and order totals
 
  
{{Note1|Note: Pre-captured orders cannot be edited using X-AOM functionality.}}
+
===Editing ordered products===
 +
To add products to an existing order, remove products or edit the details of products contained in an order, click the <u>Edit ordered products</u> link on the 'Advanced Order Management' page. This opens the 'Order #X: edit products' screen.
 +
:[[File:Aom_ordered_products.png]]<br /><br />
 +
Scroll down the page and you will see two sections:
 +
:[[File:Edit_ordered_products.png|border]]<br /><br />
 +
* 'Product info' section: Allows to view/edit information about the products that were ordered. In this section, detailed information about each product in the order is displayed in the form of a table. In the table, the column titled '''Original''' shows the state of product information before editing (the way it was last saved); the column titled '''Current''' contains some editable fields - that is where you edit/update product info. It is possible to edit the product price, quantity (number of product units to be added to the order) and selected product options for any product in the order.<br />Note that, when you begin creating a new order, the order does not yet contain any products, so the 'Product info' section displays the "No products ordered" message.
 +
* 'Add product' section: Can be used to add products to the order.  
 +
<div id="EditingProductInfo"> </div>
 +
'''Editing product info:'''
  
Starting from the version 4.3.0, '''X-AOM ''' is available as a built-in module in all X-Cart editions. It does not require installation and can be enabled in the <u>Modules</u> section of X-Cart Admin area.
+
To edit information about any product in the order (like selected options, product price or quantity of product units being ordered):
 +
# In the 'Product info' section, locate the product you need to edit and review the information in the table below its name.
 +
# Adjust the contents of any editable fields in the '''Current''' column as you require.<br />''Notes:''<br />
 +
#* It is possible to change the selected product options (if present, these are displayed in the section '''Selected options (already considered in the price)'''), the number of product units being ordered (the '''Quantity''' field) and the price (the '''Price''' field).
 +
#* The "Catalog price: X" note displayed below the editable '''Price''' field reflects the current price of the product in your store's catalog. If the product has defined product options or variants, this note reflects the price of the product based on the selected product options as shown in the section '''Selected options (already considered in the price)''' below. Note that if you change the selected options, the "Catalog price: X" note and the contents of the editable '''Price''' field will not be updated automatically; you will have to manually adjust the contents of the '''Price''' field to match the new product options selected. To find out the current catalog price of any combination of product options, click '''Update''' after selecting the options you require in the section '''Selected options (already considered in the price)'''. The "Catalog price: X" note will be updated, and you will be able to copy the price shown in the note and enter it in the '''Price''' field.
 +
#* If inventory tracking is enabled at your store, below the editable '''Quantity''' field you will see a note saying "Available in stock: Y". This note reflects the currently available quantity of the product or selected product variant. You can enter any number in the '''Quantity''' field, but X-Cart will only save quantities smaller or equal to the currently available quantity in stock. Please be aware that, if you change the options in the section '''Selected options (already considered in the price)''', you will need to click '''Update''' before you see the actual availability of the newly selected product variant (This works similarly to the "Catalog price: X" note). If you want the product's quantity in stock to be updated after you change the number of product units ordered, make sure the check box '''Update quantity in stock after the changes are applied''' is selected.
 +
# Click '''Update'''. The changes will be finalized when you [[#Saving changes|save]] them.
  
For versions 4.0.0-4.2.3, '''X-AOM ''' is available as an add-on module which can be purchased and installed separately.
+
'''Adding products:'''
 
 
==Getting Started==
 
 
 
This section of the manual provides instructions on how to carry out some basic tasks concerning the X-AOM add-on module.
 
 
 
=== Opening Orders for Editing ===
 
 
 
Before you can start changing the order details, you must open the order for editing.
 
 
 
To open the order for editing:
 
 
 
# In the X-Cart Admin area, go to the <u>Orders</u> section (<u>Management menu->Search for orders</u>).
 
# Use the <u>Search for orders</u> form to find the order you want to edit.
 
# Click on the order number to display the order details.
 
# Click the '''Modify''' button to see the <u>Advanced Order Management</u> box.
 
 
 
[[Image:x-aom-01.gif|632px|center]]
 
 
 
Here you can choose to carry out the following tasks:
 
 
 
* <u>Preview order: </u>To preview the order at any moment;
 
* <u>Edit ordered products: </u>To modify the set of products in the order;
 
* <u>Edit ordered Gift Certificates: </u>To modify gift certificates in the order (if any);
 
* <u>Edit customer information</u>: To modify information about the customer who placed the order;
 
* <u>Edit order totals</u>: To modify the components that make up the order total (e.g., shipping cost, discount savings, etc.).
 
 
 
{{Note1|Important: Simultaneous editing of two or more orders during one session can result in incorrect functioning of the module. We recommend that you first finish editing one order before you start editing another order. To finish editing the order, save or cancel the changes and click the Exit button on the <u>Advanced Order Management</u> box.}}
 
 
 
=== Previewing Order Details ===
 
 
 
While editing an order, you may wish to preview the order details. X-AOM allows you to preview the order details at any moment.
 
 
 
To preview the order you only need to click on the <u>Preview order</u> link in the the <u>Advanced Order Management</u> box. The <u>Order # %order_number%: Preview</u> form will display the order details as shown below:
 
 
 
[[Image:x-aom-02.gif|632px|center]]
 
 
 
{{Note1|Important: Before previewing the order, make sure you've updated the changes by clicking the Update button.}} Undoing Changes
 
 
 
If necessary, you can undo unsaved changes and restore the saved state of the order.
 
 
 
To undo the changes, click the '''Cancel''' button on the <u>Advanced Order Management</u> box. The system displays a confirmation message saying that all the modifications were canceled.
 
 
 
[[Image:x-aom-13.gif|632px|center]]
 
 
 
=== Saving Changes ===
 
 
 
After the order details are modified, you must save the changes to the database. Otherwise the changes will not take effect.
 
 
 
To save the changes to the database:
 
 
 
1. Click the '''Save''' button on the <u>Advanced Order Management</u> box.
 
 
 
The system will display a message saying that the database is going to be updated and asking to confirm the action.
 
 
 
[[Image:x-aom-03.gif|637px|center]]
 
 
 
2. If you want to send the customer who placed the order a notification about the changes, select the Notify customer by e-mail check box.
 
 
 
3. Click the '''Yes''' button to save the modified order to the database, or click the '''No''' button to return to the order preview without saving the changes.
 
 
 
{{Note1|Important: If you save the changes to the database, you will not be able to undo the changes.}}
 
 
 
=== Deleting Orders ===
 
 
 
If necessary, you can delete the order and, thus, remove it from the database.
 
 
 
To delete the order:
 
 
 
4. Open the order for editing (see section [[#Opening Orders for Editing]]).
 
 
 
5. Click the '''Delete order''' button on the <u>Advanced Order Management</u> box.
 
 
 
After you click Delete order, the system displays a confirmation dialog.
 
 
 
[[Image:x-aom-12.gif|637px|center]]
 
 
 
6. Click the the '''Yes''' button to delete the order and remove it from the database, or click the '''No''' button to keep the order in the database and your store order history.
 
 
 
{{Note1|Important: If you choose to delete the order, you will not be able to restore it.}}
 
 
 
==Editing Ordered Products==
 
 
 
X-AOM allows you to add, delete and modify products in an order.
 
 
 
=== Editing Product Details ===
 
 
 
For each product in an order, X-AOM allows you to edit product details including the product price, product options and product quantity.
 
 
 
To edit the product details:
 
 
 
1. Open the order for editing (see section [[#Opening Orders for Editing]]).
 
 
 
2. Click on the '''Edit ordered products''' link on the <u>Advanced Order Management</u> box.
 
 
 
After you click on '''Edit ordered products''', X-AOM displays the <u>Order # %order_number%: edit products </u>box. The box has the <u>Product info </u>subsection which includes the list of products in the order. For each product, the <u>Product info</u> subsection displays a list of parameters organized in a three-column table. The values of the parameters are displayed in columns <u>Current</u> and <u>Original</u>.
 
 
 
The column <u>Current</u> contains the changed order details which are written to the database after you save the order. The column <u>Original</u> contains the saved order details.
 
 
 
 
 
[[Image:x-aom-04.gif|632px|center]]
 
 
 
 
 
3. Use the editable fields in the column <u>Current</u> to modify the available product details.
 
 
 
* To change the product price, edit the value of the field <u>Price</u>.
 
 
 
{{Note1|Note: If you use product options and product variants, the value of the field <u>Catalog price</u> is the price of the default product variant. If the default product variant is not defined, the default product variant completely coincides with the combination of the first valid product options i.e. product options which are enabled and are not excluded from the available product option combinations.}}
 
 
 
* To change the product quantity, edit the value of the field <u>Quantity, item(s)</u>.
 
* To change the product options, edit the values in the field <u>Selected options</u>.
 
 
 
{{Note1|Note: Changing the values of the product options does not affect the product cost. If the product price depends on the product options, you must re-calculate and enter the product cost manually.}}
 
 
 
4. Click the '''Update''' button to save the changes.
 
 
 
===Adding Products===
 
 
 
X-AOM allows you to add extra products to the order.
 
  
 
To add a product:
 
To add a product:
 +
# In the 'Add product' section, click the '''Browse''' button. This opens the 'Select a product' box.<br />[[File:Select_product0.png|border]]
 +
# Use the 'Select a product' box to select the product you want to add to the order: Choose the product category from the list on the left and double-click on its name; the list of products contained in the category will be displayed on the right. Locate the name of the product in the list on the right and double-click on it.<br />[[File:Select_product.png|border]]<br /><br />The 'Select a product' box will be closed; the product name and SKU of the selected product will appear in the 'Add product' section:<br />[[File:Create_order2.png|border]]<br /><br />
 +
# Click '''Update'''. The product will be added to the list of ordered products in the 'Product info' section:<br />[[File:Create_order3.png|border]]<br />
 +
# Review the product information in the 'Product info' section. If necessary, adjust the selected product options, quantity and price in the '''Current''' column. See instructions for [[#EditingProductInfo|Editing product info]].
 +
# Click '''Update'''. The changes will be finalized when you [[#Saving changes|save]] them.
  
1. Open the order for editing (see section [[#Opening Orders for Editing]]).
+
'''Deleting products:'''
 
 
2. Click on the '''Edit ordered products''' link on the <u>Advanced Order Management</u> box.
 
 
 
After you click on '''Edit ordered products''', X-AOM displays the <u>Order # %order_number%: edit products </u>box. The box has the <u>Add product </u>subsection.
 
 
 
 
 
[[Image:x-aom-14.gif|632px|center]]
 
 
 
 
 
3. Click the '''Browse''' button to open the <u>Choose a product</u> dialog box.
 
 
 
 
 
[[Image:x-aom-05.gif|637px|center]]
 
 
 
 
 
4. Choose a product category from the list on the left and click the '''Show products''' button to display the list of products.
 
 
 
5. Select a product and click the '''Select''' button to add this product to the order.
 
 
 
6. If necessary, you can bookmark several products and add them to the order later.
 
  
* To bookmark a product, select it in the list and click the Bookmark button. The bookmarked product will appear in the <u>Bookmarks</u> list at the top of the <u>Choose a product</u> dialog box.
+
To delete a product:
* To add a bookmarked product to the order, click on the product title in the <u>Bookmarks</u> list.
+
# In the 'Product info' section, select the '''Delete''' check box below the name of the product that needs to be removed from the order:<br />[[File:aom_delete1.png|border]]
* To remove a product from the <u>Bookmarks</u> list, click [delete] next to the corresponding product title.
+
# Click '''Update'''. The product will be marked as ''Deleted'' and its price will be set to zero:<br />[[File:aom_delete2.png|border]]<br />The deletion will be finalized when you [[#Saving changes|save]] the changes.<br />
 +
Before the deletion has been finalized, it is possible to restore the deleted product:
 +
# Select the '''Restore''' check box below the name of the product.
 +
# Click '''Update'''.
  
 +
===Editing ordered gift certificates===
 +
To edit ordered gift certificates, click the <u>Edit ordered gift certificates</u> link on the 'Advanced Order Management' page. This opens the 'Order #X: edit gift certificates' screen:
 +
:[[File:Aom_gift_certificates.png|border]]<br /><br />
 +
Here you can view/edit information about the gift certificates that were ordered. Note that it is not possible to add new gift certificates to orders, only to edit already ordered ones.<br />Detailed information about each gift certificate in the order is displayed in the form of a table. In the table, the column titled '''Original''' shows the state of gift certificate information before editing (the way it was last saved); the column titled '''Current''' contains current information. The editable '''Amount''' field in the '''Current''' column is where you can quickly edit the gift certificate amount:
 +
# Adjust the contents of the '''Amount''' field.
 +
# Click '''Update'''. The changes will be finalized when you [[#Saving changes|save]] them.
 +
If you need to edit gift certificate details other than amount, click the Gift certificate ID link for the gift certificate that needs to be edited:
 +
:[[File:Aom_gift_certificates1.png|border]]<br />
 +
This opens the 'Gift certificate details' page where you will be able to make all the necessary changes:
 +
:[[File:gift_cert.png|border]]<br /><br />
  
[[Image:x-aom-06.gif|637px|center]]
+
===Editing customer information===
 +
To edit customer information, click the <u>Edit customer information</u> link on the 'Advanced Order Management' page. This opens the 'Order #X: edit customer information' screen:
 +
:[[File:Aom_customer_info.png|border]]
 +
Here you can view/edit the customer's email address, membership and billing/shipping addresses. Customer information is displayed in the form of a table where the column titled '''Original''' shows the state of customer information before editing (the way it was last saved) and the column titled '''Current''' - current customer information. All the fields in the '''Current''' column are editable, so you can change their contents as you require. After editing the contents of any fields on the page, be sure to click '''Update''' to apply the changes. The changes will be finalized when you [[#Saving changes|save]] them.
  
 +
Note that on the 'Order #X: edit customer information' screen you edit customer information only for the selected order; the information in the customer profile remains unchanged.
  
7. Click the '''Update''' button to save the changes.
+
===Editing order totals===
 +
To change information pertaining to order totals (the payment and delivery methods selected for the order, the shipping cost, the amounts of applied global discounts and discount coupons, etc), click the <u>Edit order totals</u> link on the 'Advanced Order Management' page. This opens the 'Order #X: edit totals' screen:
 +
:[[File:Aom_order_totals.png|border]]
 +
On this screen information pertaining to order totals is displayed in the form of a table where the column titled '''Original''' shows the state of information before editing (the way it was last saved) and the column titled '''Current''' - the current state.  The '''Current''' column contains some editable fields, where you can change field contents as you require. After editing any fields in the '''Current''' column, be sure to click '''Update''' to apply the changes. The changes will be finalized when you [[#Saving changes|save]] them.<br />''Notes:''<br />
 +
:* It is possible to change the payment method selected for the order.<br />[[File:Aom_payment_method.png|border]]<br />To change the payment method, do one of the following:<br />1) Type the payment method name you require into the '''Payment method''' field replacing the name of the currently selected method. The new payment method name can be anything, does not have to be a payment method already used in your store.<br />''or''<br />2) Below the '''Payment method''' field, select the check box titled '''Other''', then choose the payment method you require from the drop-down box next to it.<br /><br />
 +
:* It is possible to change the delivery method selected for the order:<br />[[File:Aom_delivery_method.png|border]]<br />To change the delivery method, simply select from the '''Delivery method''' drop-down box the delivery method you require - instead of the currently selected one. If the products are to be delivered electronically, choose the ''Not available'' option (In this case, the delivery method will be displayed on the Order details page in Customer area (the '''Order history''' section) as "Delivery method: n/a").<br /><br />
 +
:* If at the time of order placement a global discount was applied to the order, it is possible to change the discount amount that was applied. Also, if no discount was applied when the order was placed, it is possible to manually add a discount to the order. Note that when you change the discount amount via Advanced Order Management, the changes will affect only the order you are editing, the global discount settings on the Catalog->Discounts page won't be changed.<br />[[File:Aom_discount.png|border]]<br />To add or edit a discount: Select the '''Use other discount''' check box, then enter the discount amount you require and specify whether the discount is expressed as an amount in currency units or as percentage off.<br /><br />
 +
:* If at the time of order placement a discount coupon was applied to the order, it is possible to edit the savings that the coupon applied to the order provides. Also, it is possible to manually add a coupon to the order. Note that when you change the coupon savings amount via Advanced Order Management, the changes will affect only the order you are editing, the coupon itself - as configured on the Catalog->Coupons page - won't be changed.<br />[[File:Aom_coupon.png|border]]<br />To add or edit a discount coupon, do one of the following:<br />1) From the '''Coupon saving''' drop-down box, select the coupon you want to be applied to the order.<br />''or''<br />2) Select the '''New coupon saving''' check box, then enter the coupon amount you require (expressed in currency units).<br /><br />
 +
:* The shipping cost for the order typically depends on the merchandise ordered, the shipping method selected and the address to which the order needs to be shipped. If any of these are changed via Advanced Order Management, the shipping cost for the order is re-calculated and updated automatically. However, if you wish to define the shipping cost for the order manually, you can easily do so by selecting the '''Use fixed shipping cost''' check box below the '''Shipping cost''' field and entering the desired amount into the respective field.<br />[[File:Aom_shipping.png|border]]<br />
 +
:* Taxes are not editable via Advanced Order Management.<br />[[File:Aom_tax.png|border]]<br />When editing an order via Advanced Order Management, you can see which taxes were applied at the time of order placement and their amount, but you cannot edit the amount or remove the tax. However, the tax amount may be updated automatically if the order's subtotal, discounted subtotal and/or shipping cost change as a result of the order being edited via Advanced Order Management (Whether or not the tax amount will be updated depends on the configuration of the specific tax).<br />Note that a tax applied to the order at the time of order placement may not be replaced by another tax as a result of any changes made to the order via Advanced Order Management. Example: Your store has a tax that applies to orders shipped to Tennessee. When a customer from New York places an order at your store, this tax for Tennessee residents is not applied. Then the customer requests a change of shipping address so their order is shipped to Tennessee instead of New York. You can change the state from New York to Tennessee in the customer's shipping address via the <u>Edit customer information</u> section in Advanced Order Management; however, this will not cause the tax for Tennessee residents to be applied to the order.<br /><br />
 +
:* Payment method surcharge is not editable via Advanced Order Management: you cannot manually add a surcharge or edit the amount of an existing surcharge.<br />[[File:Aom_payment_surcharge.png|border]]<br />However, if you change the payment method for the order replacing a payment method without a surcharge by a payment method with a surcharge, the new surcharge (it will be shown in the '''Current''' column) will be automatically applied to the order. Also, if you change the payment method from one with a surcharge to another one without a surcharge, the surcharge amount will be removed from the order when the payment method is updated.
  
===Deleting Products===
+
===Previewing order details===
 +
While editing an order, you can preview its details at any moment by clicking the <u>Preview order</u> link at the top of the 'Advanced Order Management' page. Before clicking the <u>Preview order</u> link, be sure to apply any changes you have made by clicking the '''Update''' button.
  
X-AOM enables you to remove products from the order.
+
===Saving changes===
 +
To finalize the changes made to the order via Advanced Order Management, you must save them.
  
To remove products:
+
After you have applied changes to the order using the '''Update''' button, two more buttons appear on the Advanced Order Management page: '''Save''' and '''Cancel'''.
 +
:[[File:Aom_save.png|border]]
 +
The '''Cancel''' button allows you to undo any changes made to the order during the editing session restoring the latest "saved" version of the order.
  
1. Open the order for editing (see section [[#Opening Orders for Editing]]).
+
The '''Save''' button allows you to finalize the changes made to the order during the editing session and applied with the '''Update''' button.
  
2. Click on the '''Edit ordered products''' link on the <u>Advanced Order Management</u> box.
+
After clicking '''Save''' you will see the confirmation screen:
 +
:[[File:Aom_save_confirm.png|border]]
 +
Here you must confirm your decision to save the changes.  
  
X-AOM displays the <u>Order # %order_number%: edit products </u>box. The box contains the <u>Product info</u> subsection with a list of products in the order.
+
Before saving the changes, you can specify whether any other users need to be notified about the changes you made to the order via Advanced Order Management. You have the following options:
 +
* '''Notify customer by email''': Select this option if you want a notification to be sent to the customer who placed the order.
 +
* '''Notify provider by email''': (X-Cart PLATINUM only) Select this option if you want a notification to be sent to any providers whose products are in the order.
 +
* '''Notify Orders department by email''': Select this option if you want a notification to be sent to the Orders department.
 +
Select all the options that apply. After the changes have been saved, the updated order details will be emailed to the selected users.  
  
[[Image:x-aom-15.gif|632px|center]]
+
If necessary, you can add comments for the changes you have made:
 +
# Click the <u>[+] Leave comment to these changes</u> link. This expands a text area where you can enter your comments.
 +
# Type in your comments. 
 +
# If you want the comments to be visible to the customer who placed the order via the Order history/History of changes in Customer area, select the '''Visible to customer''' check box below the comments in the text area.
 +
:[[File:Aom_changes_comments1.png|border]]
  
3. Select the '''Delete''' check box for each product that you want to remove from the order.
+
To proceed with saving the changes, click '''Yes'''. To return to the order preview without saving the changes, click '''No'''.
  
4. Click the '''Update''' button to save the changes.
+
After you click '''Yes''', X-Cart saves the changes and sends out the notifications you have specified.  
  
==Editing Ordered Gift Certificates==
+
The changes made to the order can be viewed via the [[#Viewing the history of changes|History of changes]].
  
==Editing Customer Information==
+
===Viewing the history of changes===
 +
All changes made to an order via Advanced Order Management are stored to the order's History of changes. In your store's back end, it is possible to view the History of changes for any order by clicking the <u>History of changes</u> link on the Advanced Order Management page. The history of changes opens in a new window:<br />
 +
:[[File:Aom_history.png|border]]
 +
The customer who placed the order can view its history of changes in the Order history.
 +
<br /><br />
  
==Editing Order Totals==
+
==See also==
 +
* [[X-Cart:Gift_Certificates|Gift Certificates]]
  
 
[[Category:X-Cart user manual]]
 
[[Category:X-Cart user manual]]
 
[[Category:X-Cart modules]]
 
[[Category:X-Cart modules]]

Latest revision as of 22:49, 15 April 2022

Overview

X-Cart's Advanced Order Management module allows you to edit your customers' orders after they have been placed. With this module you can add products to an existing order, remove products from order, update product prices and quantities, add/update discounts and coupons, change the delivery method and shipping cost, etc. In versions 4.5.3 and later, you can also create orders via the store's back end. This may help, for example, when a customer calls in to place an order.

Starting from version 4.3.0, the Advanced Order Management module is available as a built-in module in all X-Cart editions. It does not require installation and can be enabled in the Modules section of your store's Admin area. For versions 4.0.0-4.2.3, the Advanced Order Management module is available as an add-on module which can be purchased and installed separately.

Enabling the Advanced Order Management module

To enable the module:

  1. In Admin area, go to the Modules section (Settings menu -> Modules).
  2. Choose the Advanced Order Management module by selecting the respective check box on the left.
  3. Click the Apply changes button. This activates the module.

Configuring the Advanced Order Management module

In X-Cart versions 4.5.3 and later, after enabling the Advanced Order Management module, you should check and adjust the module's configuration settings:

  1. In the Modules section (Settings menu -> Modules), click the Configure link opposite the module name ('Advanced Order Management').
    The module configuration page (titled by the name of the module) opens:
    Aom settings.png

  2. Adjust the settings on the module configuration page as needed. At present, there is only one setting, Username prefix for customer added when order is created in back-end. This setting is related to the Create Order feature; it allows you to set a username prefix that will help you to identify automatically created customer profiles.
    Whenever you create an order via the store's back end without linking it to an existing customer profile, the system automatically creates an anonymous customer profile for the person on whose behalf the order is being created. The username for such a profile is generated automatically as a string of numeric characters preceded by the username prefix specified in this field. For example, if the username prefix value is defined as "automatic", the usernames of automatically created customers will look as follows (Note the last three usernames in the list):
    Automatic customer.png

  3. Click the Apply changes button to save the changes.

Editing orders with Advanced Order Management module

To edit an order with Advanced Order Management, do the following:

  1. In your store's back end, find the order you want to edit and open its details. Now that Advanced Order Management module is enabled at your store, the 'Order details' page contains a button titled Modify:
    Order details modify.png
  2. Click the Modify button. This opens the 'Advanced Order Management' page where you can edit the order:
    Aom.png
    The top of the page provides links for access to the sections of the 'Advanced Order Management' page:
    • Preview order: Allows to preview the order details at any moment during the editing process.
    • Edit ordered products: Allows to add products to the order, remove products from the order, update product quantities and prices.
    • Edit ordered gift certificates: (This link is displayed only for orders containing ordered gift certificates; not available for orders created via the store's back end) Allows to edit the amount of the ordered gift certificate, remove the gift certificate from the order or access the 'Gift certificate details' page where virtually any details of the gift certificate can be edited.
    • Edit customer information: Allows to edit customer information including personal information and billing/shipping addresses of the customer who placed the order.
    • Edit order totals: Allows to change the payment and delivery methods selected for the order, the shipping cost, the amounts of applied global discounts and discount coupons, etc.
    • History of changes: Allows to view the history of changes made to the order.
  3. Click the link you require and make the changes.
  4. Save the changes.

Creating orders with Advanced Order Management module

Order creation with Advanced Order Management is available in X-Cart versions 4.5.3 and later. To create an order, do the following:

  1. In your store's back end, go to the 'Create order' page (Orders->Create new order):
    Create order.png
  2. If the buyer for whom you are going to create the order does not have an account with your store, move on to the next step. If the buyer is an existing customer, select the customer account for which the order will be created:
    1. Click Select customer. The 'Search for users' form opens in a new window:
      Search for users.png
    2. Use the 'Search for users' form to find the customer you require.
    3. In the search results, select the customer and click Submit:
      Search for users1.png
      The name of the customer you selected appears in the Customer field on the 'Create order' page:
      Create order0.png
  3. Click Create new order.
    This opens the Advanced Order Management page where you can create the order.
    You are now at the 'Order #X: edit products' screen where products can be added:
    Create order1.png
    For access to the other sections of the Advanced Order Management page, use the links at the top of the page.
  4. Create the order by defining all the necessary order details:
    • add products;
    • enter customer information;
    • choose the payment and shipping methods, add a global discount/discount coupon, check and adjust the shipping cost, etc.
      For details, see the section Advanced Order Management operations.

Advanced Order Management operations

Editing ordered products

To add products to an existing order, remove products or edit the details of products contained in an order, click the Edit ordered products link on the 'Advanced Order Management' page. This opens the 'Order #X: edit products' screen.

Aom ordered products.png

Scroll down the page and you will see two sections:

Edit ordered products.png

  • 'Product info' section: Allows to view/edit information about the products that were ordered. In this section, detailed information about each product in the order is displayed in the form of a table. In the table, the column titled Original shows the state of product information before editing (the way it was last saved); the column titled Current contains some editable fields - that is where you edit/update product info. It is possible to edit the product price, quantity (number of product units to be added to the order) and selected product options for any product in the order.
    Note that, when you begin creating a new order, the order does not yet contain any products, so the 'Product info' section displays the "No products ordered" message.
  • 'Add product' section: Can be used to add products to the order.

Editing product info:

To edit information about any product in the order (like selected options, product price or quantity of product units being ordered):

  1. In the 'Product info' section, locate the product you need to edit and review the information in the table below its name.
  2. Adjust the contents of any editable fields in the Current column as you require.
    Notes:
    • It is possible to change the selected product options (if present, these are displayed in the section Selected options (already considered in the price)), the number of product units being ordered (the Quantity field) and the price (the Price field).
    • The "Catalog price: X" note displayed below the editable Price field reflects the current price of the product in your store's catalog. If the product has defined product options or variants, this note reflects the price of the product based on the selected product options as shown in the section Selected options (already considered in the price) below. Note that if you change the selected options, the "Catalog price: X" note and the contents of the editable Price field will not be updated automatically; you will have to manually adjust the contents of the Price field to match the new product options selected. To find out the current catalog price of any combination of product options, click Update after selecting the options you require in the section Selected options (already considered in the price). The "Catalog price: X" note will be updated, and you will be able to copy the price shown in the note and enter it in the Price field.
    • If inventory tracking is enabled at your store, below the editable Quantity field you will see a note saying "Available in stock: Y". This note reflects the currently available quantity of the product or selected product variant. You can enter any number in the Quantity field, but X-Cart will only save quantities smaller or equal to the currently available quantity in stock. Please be aware that, if you change the options in the section Selected options (already considered in the price), you will need to click Update before you see the actual availability of the newly selected product variant (This works similarly to the "Catalog price: X" note). If you want the product's quantity in stock to be updated after you change the number of product units ordered, make sure the check box Update quantity in stock after the changes are applied is selected.
  3. Click Update. The changes will be finalized when you save them.

Adding products:

To add a product:

  1. In the 'Add product' section, click the Browse button. This opens the 'Select a product' box.
    Select product0.png
  2. Use the 'Select a product' box to select the product you want to add to the order: Choose the product category from the list on the left and double-click on its name; the list of products contained in the category will be displayed on the right. Locate the name of the product in the list on the right and double-click on it.
    Select product.png

    The 'Select a product' box will be closed; the product name and SKU of the selected product will appear in the 'Add product' section:
    Create order2.png

  3. Click Update. The product will be added to the list of ordered products in the 'Product info' section:
    Create order3.png
  4. Review the product information in the 'Product info' section. If necessary, adjust the selected product options, quantity and price in the Current column. See instructions for Editing product info.
  5. Click Update. The changes will be finalized when you save them.

Deleting products:

To delete a product:

  1. In the 'Product info' section, select the Delete check box below the name of the product that needs to be removed from the order:
    Aom delete1.png
  2. Click Update. The product will be marked as Deleted and its price will be set to zero:
    Aom delete2.png
    The deletion will be finalized when you save the changes.

Before the deletion has been finalized, it is possible to restore the deleted product:

  1. Select the Restore check box below the name of the product.
  2. Click Update.

Editing ordered gift certificates

To edit ordered gift certificates, click the Edit ordered gift certificates link on the 'Advanced Order Management' page. This opens the 'Order #X: edit gift certificates' screen:

Aom gift certificates.png

Here you can view/edit information about the gift certificates that were ordered. Note that it is not possible to add new gift certificates to orders, only to edit already ordered ones.
Detailed information about each gift certificate in the order is displayed in the form of a table. In the table, the column titled Original shows the state of gift certificate information before editing (the way it was last saved); the column titled Current contains current information. The editable Amount field in the Current column is where you can quickly edit the gift certificate amount:

  1. Adjust the contents of the Amount field.
  2. Click Update. The changes will be finalized when you save them.

If you need to edit gift certificate details other than amount, click the Gift certificate ID link for the gift certificate that needs to be edited:

Aom gift certificates1.png

This opens the 'Gift certificate details' page where you will be able to make all the necessary changes:

Gift cert.png

Editing customer information

To edit customer information, click the Edit customer information link on the 'Advanced Order Management' page. This opens the 'Order #X: edit customer information' screen:

Aom customer info.png

Here you can view/edit the customer's email address, membership and billing/shipping addresses. Customer information is displayed in the form of a table where the column titled Original shows the state of customer information before editing (the way it was last saved) and the column titled Current - current customer information. All the fields in the Current column are editable, so you can change their contents as you require. After editing the contents of any fields on the page, be sure to click Update to apply the changes. The changes will be finalized when you save them.

Note that on the 'Order #X: edit customer information' screen you edit customer information only for the selected order; the information in the customer profile remains unchanged.

Editing order totals

To change information pertaining to order totals (the payment and delivery methods selected for the order, the shipping cost, the amounts of applied global discounts and discount coupons, etc), click the Edit order totals link on the 'Advanced Order Management' page. This opens the 'Order #X: edit totals' screen:

Aom order totals.png

On this screen information pertaining to order totals is displayed in the form of a table where the column titled Original shows the state of information before editing (the way it was last saved) and the column titled Current - the current state. The Current column contains some editable fields, where you can change field contents as you require. After editing any fields in the Current column, be sure to click Update to apply the changes. The changes will be finalized when you save them.
Notes:

  • It is possible to change the payment method selected for the order.
    Aom payment method.png
    To change the payment method, do one of the following:
    1) Type the payment method name you require into the Payment method field replacing the name of the currently selected method. The new payment method name can be anything, does not have to be a payment method already used in your store.
    or
    2) Below the Payment method field, select the check box titled Other, then choose the payment method you require from the drop-down box next to it.

  • It is possible to change the delivery method selected for the order:
    Aom delivery method.png
    To change the delivery method, simply select from the Delivery method drop-down box the delivery method you require - instead of the currently selected one. If the products are to be delivered electronically, choose the Not available option (In this case, the delivery method will be displayed on the Order details page in Customer area (the Order history section) as "Delivery method: n/a").

  • If at the time of order placement a global discount was applied to the order, it is possible to change the discount amount that was applied. Also, if no discount was applied when the order was placed, it is possible to manually add a discount to the order. Note that when you change the discount amount via Advanced Order Management, the changes will affect only the order you are editing, the global discount settings on the Catalog->Discounts page won't be changed.
    Aom discount.png
    To add or edit a discount: Select the Use other discount check box, then enter the discount amount you require and specify whether the discount is expressed as an amount in currency units or as percentage off.

  • If at the time of order placement a discount coupon was applied to the order, it is possible to edit the savings that the coupon applied to the order provides. Also, it is possible to manually add a coupon to the order. Note that when you change the coupon savings amount via Advanced Order Management, the changes will affect only the order you are editing, the coupon itself - as configured on the Catalog->Coupons page - won't be changed.
    Aom coupon.png
    To add or edit a discount coupon, do one of the following:
    1) From the Coupon saving drop-down box, select the coupon you want to be applied to the order.
    or
    2) Select the New coupon saving check box, then enter the coupon amount you require (expressed in currency units).

  • The shipping cost for the order typically depends on the merchandise ordered, the shipping method selected and the address to which the order needs to be shipped. If any of these are changed via Advanced Order Management, the shipping cost for the order is re-calculated and updated automatically. However, if you wish to define the shipping cost for the order manually, you can easily do so by selecting the Use fixed shipping cost check box below the Shipping cost field and entering the desired amount into the respective field.
    Aom shipping.png
  • Taxes are not editable via Advanced Order Management.
    Aom tax.png
    When editing an order via Advanced Order Management, you can see which taxes were applied at the time of order placement and their amount, but you cannot edit the amount or remove the tax. However, the tax amount may be updated automatically if the order's subtotal, discounted subtotal and/or shipping cost change as a result of the order being edited via Advanced Order Management (Whether or not the tax amount will be updated depends on the configuration of the specific tax).
    Note that a tax applied to the order at the time of order placement may not be replaced by another tax as a result of any changes made to the order via Advanced Order Management. Example: Your store has a tax that applies to orders shipped to Tennessee. When a customer from New York places an order at your store, this tax for Tennessee residents is not applied. Then the customer requests a change of shipping address so their order is shipped to Tennessee instead of New York. You can change the state from New York to Tennessee in the customer's shipping address via the Edit customer information section in Advanced Order Management; however, this will not cause the tax for Tennessee residents to be applied to the order.

  • Payment method surcharge is not editable via Advanced Order Management: you cannot manually add a surcharge or edit the amount of an existing surcharge.
    Aom payment surcharge.png
    However, if you change the payment method for the order replacing a payment method without a surcharge by a payment method with a surcharge, the new surcharge (it will be shown in the Current column) will be automatically applied to the order. Also, if you change the payment method from one with a surcharge to another one without a surcharge, the surcharge amount will be removed from the order when the payment method is updated.

Previewing order details

While editing an order, you can preview its details at any moment by clicking the Preview order link at the top of the 'Advanced Order Management' page. Before clicking the Preview order link, be sure to apply any changes you have made by clicking the Update button.

Saving changes

To finalize the changes made to the order via Advanced Order Management, you must save them.

After you have applied changes to the order using the Update button, two more buttons appear on the Advanced Order Management page: Save and Cancel.

Aom save.png

The Cancel button allows you to undo any changes made to the order during the editing session restoring the latest "saved" version of the order.

The Save button allows you to finalize the changes made to the order during the editing session and applied with the Update button.

After clicking Save you will see the confirmation screen:

Aom save confirm.png

Here you must confirm your decision to save the changes.

Before saving the changes, you can specify whether any other users need to be notified about the changes you made to the order via Advanced Order Management. You have the following options:

  • Notify customer by email: Select this option if you want a notification to be sent to the customer who placed the order.
  • Notify provider by email: (X-Cart PLATINUM only) Select this option if you want a notification to be sent to any providers whose products are in the order.
  • Notify Orders department by email: Select this option if you want a notification to be sent to the Orders department.

Select all the options that apply. After the changes have been saved, the updated order details will be emailed to the selected users.

If necessary, you can add comments for the changes you have made:

  1. Click the [+] Leave comment to these changes link. This expands a text area where you can enter your comments.
  2. Type in your comments.
  3. If you want the comments to be visible to the customer who placed the order via the Order history/History of changes in Customer area, select the Visible to customer check box below the comments in the text area.
Aom changes comments1.png

To proceed with saving the changes, click Yes. To return to the order preview without saving the changes, click No.

After you click Yes, X-Cart saves the changes and sends out the notifications you have specified.

The changes made to the order can be viewed via the History of changes.

Viewing the history of changes

All changes made to an order via Advanced Order Management are stored to the order's History of changes. In your store's back end, it is possible to view the History of changes for any order by clicking the History of changes link on the Advanced Order Management page. The history of changes opens in a new window:

Aom history.png

The customer who placed the order can view its history of changes in the Order history.

See also