Getting Started

Welcome to the Order Management documentation. Whether you are a new or an advanced user, you can find some useful information here.

First of all, we recommend to check the following link:

Second of all, proceed then with Quick Start, which will guide you through creating your own Order Management.

How to install the extension

  1. Backup your store's database and web directory.
  2. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
  3. Copy the installation instructions from the page My Downloadable Products to the SSH console and press ENTER.
  4. Run command php -f bin/magento module:enable Mirasvit_Core Mirasvit_OrderEditor Mirasvit_OrderGrid Mirasvit_OrderNumber Mirasvit_ExtraPayment Mirasvit_OrderTag Mirasvit_QuickView to enable the extensions.
  5. Run command php -f bin/magento setup:upgrade to install the extension.
  6. Run command php -f bin/magento cache:clean to clean the cache.
  7. Deploy static view files

    rm -rf pub/static/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy

Quick Start

Banner ads encourage you to buy certain products.

The Order Management for Magento 2 extension is designed to make order management easier and more convenient.

The additional functionality of the Order Management for Magento 2 extension allows:

  1. Edit exists Order.
  2. Added additional columns to the Order Grid.
  3. Generate Order number by your rules.

This should be a good start. Refer to corresponding sections of this manual to know more.



Order Editor

You can easily modify orders in your store using the Order Management for Magento 2 extension.

To edit an order in the left panel of your store admin page select Sales > Orders. In the orders list find an order you need to edit and press View button.

get-into-order-edit.png

When the order page is opened, do not click on the orange button Edit. Otherwise, you will be given the suggestion to cancel the current order and create a new one.

To edit the order, click on the link Edit Section inside the order. You can edit the order sections one by one. To adjust any other order section, first finish editing the current section. To finish, press Submit or Cancel.

Edit Order & Account Information

To edit order status, order number, order date press an Edit Section button. The button is located near the current order number. Click Submit to save changes.

order-number-status-edit.gif

Edit Payment & Shipping Method

You can change the payment method for the order you are editing. Click Edit section near the headline Payment Information.

shipment-method-edit.png

Edit Items Ordered

Press the button Edit section near the headline Items Ordered.

You can change the ordered items, their quantity, prices, tax rate, and discount amount.

items-ordered-edit.gif

Press the Preview button to view the recalculated order. To save the changed order, press Submit.

Press Remove to delete the chosen product form the list.

items-ordered-remove-product.gif

To add new products to the order, press Add Products. Select a product from the list and press Add Selected Products.



Order Grid

Get additional columns in the order grid. See all necessary information on a single screen. Filter and search orders using additional columns.

In the admin panel of your store, visit Sales > Orders.

To add more columns, press Columns. When a particular column is added, you will get the option to filter through it in Filter.

Add information on items

In Columns, select Products. You can add on your screen relevant information for items including:

  • Item thumbnail

  • Item SKU

  • Item type

  • Item available options

  • Ordered item quantity

  • Ordered item cost

additional-items.gif

Show billing information

In Columns, select Billing. Our module allows you to display:

  • Invoice

  • Billing Fax

  • Billing City

  • Billing Region

  • Billing Postcode

  • Billing Telephone

  • Billing Country

additional-billing.gif

Get shipping information

In Columns, select Shipping. In addition, you will get:

  • Shipments

  • Shipping Fax

  • Shipping City

  • Shipping Region

  • Shipping Postcode

  • Shipping Telephone

  • Shipping Country

additional-shipping.gif



Order Number

This extension provides convenient way to generate order, invoice, credit memo, and shipping numbers according to your needs.

Follow to Stores > Settings > Configuration > MIRASVIT EXTENSIONS > Order Number to manage numbers.

open-order-number.gif

By default, the custom identification numbering pattern for orders, invoices, shipments, credit memos is disabled.

Custom identification number activation

Click on the document type you want to change numbering information for and turn it on. Here is the activation for Order Number:

activate-custom-order-number.gif

After activation custom numbering, you need to flush Magento cache.

When you use a custom order number, you can copy it for other documents invoices, shipments, credit memos.

activate-invoice-number.gif

You can make identification numbers customized for invoices, shipments, credit memos.

The module gives you a preview of all custom numbers in use via the button Preview.

preview-custom-number.gif

Variables and counters for identification number

You can use variables to suit the identification number pattern for your needs. Full information on them is present at the bottom of the Order Number page.

You can also create a custom counter for which you can specify your own start number and step. Click Add in the Counter section, set counter’s code, type, start number, step.

Manually insert the variables and counter’s code into the identification number pattern before using them.

How to upgrade extension

To upgrade the extension follow these steps:

  1. Backup your store's database and web directory.
  2. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
  3. Run command composer require mirasvit/module-order-management:* --update-with-dependencies to update current extension with all dependencies.

    Note

    In some cases the command above is not applicable, it's not possible to update just current module, or you just need to upgrade all Mirasvit modules in a bundle. In this case command above will have no effect.

    Run instead composer update mirasvit/* command. It will update all Mirasvit modules, installed on your store.

  4. Run command php -f bin/magento setup:upgrade to install updates.
  5. Run command php -f bin/magento cache:clean to clean the cache.
  6. Deploy static view files

    rm -rf pub/static/*; rm -rf var/view_preprocessed/*; php -f bin/magento setup:static-content:deploy

Disabling the Extension

Temporarily Disable

To temporarily disable the extension please follow these steps:

  1. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
  2. Run command php -f bin/magento module:disable Mirasvit_OrderEditor Mirasvit_OrderGrid Mirasvit_OrderNumber to disable the extension.
  3. Log in to the Magento backend and refresh the store cache (if enabled).

Removing the Extension

To uninstall the extension, please follow these steps:

  1. Login to the SSH console of your server and navigate to the root directory of the Magento 2 store.
  2. Run the command composer remove mirasvit/module-order-management to remove the extension.
  3. Log in to the Magento backend and refresh the store cache (if enabled).

1.1.21

(2023-01-26)

Improvements

  • Added support of Magento 2.4.6

Fixed

  • Issue with checkout if using Klarna for payment

1.1.19

(2023-01-17)

Fixed

  • Issue with changing Shipping Address in guest order

1.1.18

(2022-12-16)

Fixed

  • Issue with removing discounts when editing items

1.1.17

(2022-12-15)

Fixed

  • Export

1.1.16

(2022-11-11)

Fixed

  • Sorting by Tags

1.1.15

(2022-11-09)

Fixed

  • Incorrect price if order currency is not base

1.1.14

(2022-11-09)

Features

  • Delete order

1.1.13

(2022-10-26)

Fixed

  • Create Order

1.1.12

(2022-10-26)

Fixed

  • Error while editing customer email on Account Information tab

1.1.11

(2022-10-24)

Improvements

  • Increase performance Order Grid

1.1.10

(2022-10-18)

Features

  • Order changes timeline

1.1.9

(2022-10-12)

Fixed

  • Change Tax Rate

1.1.8

(2022-08-22)

Fixed

  • Assigning a customer to a quote when editing the Account Information section

1.1.7

(2022-08-08)

Fixed

  • Filter by name

1.1.6

(2022-08-05)

Fixed

  • When editing the Shipping Address, the list of countries depends on the settings

1.1.5

(2022-07-27)

Improvements

  • Added a Product Name column to the Order Grid

1.1.4

(2022-07-26)

Fixed

  • Call to a member function getField() on bool error on Login as Customer Log page

1.1.3

(2022-07-01)

Fixed

  • ACL for Order Tag

1.1.2

(2022-06-20)

Improvements

  • remove db_schema_whitelist.json

1.1.1

(2022-06-03)

Fixed

  • Update dependencies

1.1.0

(2022-05-31)

Improvements

  • Migrate to declarative schema

1.0.43

(2022-05-25)

Fixed

  • Compatibility with Magento 2.4.4

1.0.42

(2022-05-23)

Fixed

  • Error "undefined index: base_discount_amount in..." if Wyomind_MsiOrderManagement is enabled

1.0.41

(2022-05-12)

Fixed

  • Issue with Salable Quantity in Magento 2.3

1.0.40

(2022-04-26)

Fixed

  • Issue with display columns selection
  • Issue with adding tag on order view page

1.0.39

(2022-03-22)

Fixed

  • Issue when adding product with Special Price

1.0.38

(2022-03-10)

Fixed

  • Issue with disabled products
  • Issue wiht Shipping Address

1.0.37

(2022-02-28)

Fixed

  • Issue with adding order item if price contains separator

1.0.36

(2022-02-21)

Fixed

  • Removed the ability to remove order item if quote item does not exist

1.0.35

(2022-02-16)

Fixed

  • Issue with display error message
  • Issue with duplicate edit area

1.0.34

(2022-02-07)

Fixed

  • Action remove order item

1.0.33

(2022-02-03)

Fixed

  • Order Editor: Tax calculation for price including tax

1.0.32

(2022-01-31)

Improvements

  • Order Editor: Added ability to change customer of the order

Fixed

  • Order Editor: Display of section errors

1.0.31

(2021-12-30)

Fixed

  • Order Editor: Compatibility with payment method "magenest_sagepay_form"
  • Order Editor: Infinite loader after a new product was added
  • Order Number: Error "Undefined entity type".

1.0.30

(2021-12-22)

Fixed

  • Order Editor: Base tax calculation
  • Order Editor: Reset tax for shipping update

1.0.29

(2021-12-17)

Fixed

  • Order Editor: Update of disabled products

1.0.27

(2021-12-13)

Improvements

  • Order Tag: Decrease reindex time

1.0.26

(2021-12-03)

Fixed

  • Order Editor: Edit price field shows only for the last item
  • Order Number: Order preview
  • Order Number: Usage of the {{ order }} for order

1.0.25

(2021-11-26)

Fixed

  • Order Editor: Compatibility with Stripe payment method
  • Order Grid: Error "Undefined index: base_discount_amount in ..."

Improvements

  • Order Editor: Added the ability to edit customer email

1.0.24

(2021-11-23)

Fixed

  • Order Editor: Item price update on multi currency store

1.0.23

(2021-11-10)

Improvements

  • Order Editor: Add a configurable product with different options
  • Order Editor: Add custom shipping price and ability to change order's State
  • Order Editor: Add an ability to edit shipping address

1.0.22

(2021-11-03)

Fixed

  • Order Editor: Price update

1.0.21

(2021-10-18)

Fixed

  • Order Editor: Uncaught Error: Call to a member function addItem() on array in vendor/magento/module-sales/Model/Order/Invoice.php:552

1.0.20

(2021-10-12)

Fixed

  • Order Editor: Qty for a new configurable products
  • Order Editor: Removed the ability to remove invoiced items

1.0.18

(2021-10-01)

Fixed

  • Order Editor: Configurable products with custom options

1.0.17

(2021-09-28)

Fixed

  • Order Editor: Compatibility with m2.3.1
  • Order Editor: Shipping methods list

1.0.16

(2021-09-13)

Fixed

  • Error for Braintree payment method
  • Permissions

1.0.15

(2021-09-02)

Fixed

  • Product reservation

1.0.14

(2021-08-19)

Fixed

  • Recursion error for new configurable products
  • Add configurable product with empty price
  • Price format in the order grid

1.0.13

(2021-07-13)

Fixed

  • Added columns group "Additional"
  • Added Extra Payments

1.0.12

(2021-06-15)

Fixed

  • Issue when an item does not remove after preview

1.0.11

(2021-06-11)

Fixed

  • Update items with custom price

1.0.10

(2021-06-08)

Improvements

  • Added mass action "Add Order Tag"

Fixed

  • Sticky filter bar gets messed up
  • Export of the items column

1.0.9

(2021-05-28)

Fixed

  • Colors do not apply to the grid

1.0.8

(2021-05-20)

Improvements

  • Added the ability to remove auto tags

1.0.7

(2021-05-07)

Features

  • Added new module "Order Tag"

1.0.6

(2021-04-23)

Fixed

  • Currency in the order items grid

Improvements

  • Compatibility with ParadoxLabs_Authnetcim and MageWorx_MultiFees

Features

  • Added new module "Quick View"

1.0.5

(2021-04-05)

Fixed

  • Product selection for multi websites

Improvements

  • Added product attributes to the "Add Product" dialog

1.0.5-beta

(2021-03-30)

Fixed

  • Product selection for multi websites

1.0.4

(2021-03-26)

Fixed

  • Issue when item qty does not save
  • Compatibility with m2.3
  • Broken order grid when exist orders with removed products

1.0.3

(2021-03-22)

Fixed

  • Error "Call to a member function getItemId() on null in OrderEditor/Observer/FilterTaxRatesObserver.php"

1.0.2

(2021-03-10)

Features

  • Initial release