Working With Order Status in Magento Enterprise Edition (EE) and Community Edition (CE)

Table of Contents

Overview

This article discusses how you can create custom order statuses for orders placed on your web store. Except where noted, the information in this KB article applies to:

  • Enterprise Edition (EE) 1.9 and later
  • Community Edition (CE) 1.5 and later

All orders in your Magento CE or EE store have an order status associated with each order state. (An order state is a unique step in the order processing workflow.) You can see the status of an order on the Orders page (in the Admin Panel, click Sales > Orders).

The following figure shows order workflow. Order states are represented by squares in the figure. You cannot modify order states. You can add, remove, assign, and unassign order statuses to an order state as discussed in Creating a New Order Status and Assigning it to an Order State.

Understanding Order Status and Order State

The following table lists the default set of order states and statuses provided with Magento CE and EE.

Order status Order state
Processing
Pending Payment
Suspected Fraud
Payment Review
Pending
On Hold
Complete
Closed
Canceled
Pending PayPal
New
Pending Payment
Processing
Complete
Closed
Canceled
On Hold
Payment Review

The next section discusses how to create a new order status and assign it to an order state. You can use the tasks discussed in the next section to add additional order statuses to an existing state as well.

Creating a New Order Status and Assigning it to an Order State

Each order state can have multiple order statuses assigned to it. You can define order statuses and assign those statuses to states as discussed in this section. For a review of order workflow (states and status), see Understanding Order Status and Order State.

See one of the following sections:

Creating a New Order Status

This section discusses how to create a custom order status, assign the custom status to an order state, and to set a default order status for order states.

For example, you might need a custom order status for orders—for packaging or backordered—or a status that is specific to your store. In this case you can create a descriptive name for the custom status and assign it to the associated order states in the order processing workflow.

To create a custom order status:

  1. Log in to the Admin Panel as an administrator.
  2. Click System > Order Statuses.
    The following figure shows an example Order Statuses page.
  3. Click Create New Status in the upper right corner of the Order Statuses page.
    The following figure shows an example.
  4. On the New Order Status page, in the Order Status Information section, enter the following information:
    • Enter a Status Code to identify the status.
      For clarity, the code you enter should be descriptive. The first character in the field must be a letter. You can enter a combination of only lowercase letters (a-z), numbers (0-9), and underscore(_).
    • Enter a Status Label to identify the status setting in the Admin Panel and web store.
  5. In the Store View Specific Labels section, you can optionally specify labels for each store view or language.
  6. Click Save Status.

Assigning an Order Status to an Order State

This section discusses how to assign an order status—either an existing status or a custom status you created—to an order state.

To assign an order status to an order state:

  1. Log in to the Admin Panel as an administrator.
  2. Click System > Order Statuses.
    The following figure shows an example.
  3. Click Assign Status to State in the upper-right corner of the page.
    The following figure shows an example.
  4. On the Assign Order Status to State page, in the Assignment Information section, enter the following information:
    • From the Order Status list, click the status to assign.
    • From the Order State list, click the corresponding order state.
    • Select the Use Order Status as Default check box to use the specified status value as the default for the selected state.
  5. Click Save Status Assignment in the upper-right corner.

Unassigning an Order Status from an Order State

This section discusses how to unassign an order status from an order state.

Note: EE 1.13.1 and later only. You cannot unassign a status from a state if that status is currently being used. That is, if an order status is currently being used in your web store, you cannot unassign it.

To unassign an order status from an assigned state:

  1. Log in to the Admin Panel as an administrator.
  2. Click System > Order Statuses.
  3. In the Action column on the right, click the Unassign link corresponding to the order status to unassign.
    In EE 1.13.1 and later, an error similar to the following displays if you attempt to unassign a currently used status:
    Status "name" cannot be unassigned. It is in used in number payment method configuration(s): 
    payment-method-list store-view-list
    For example,
    Status "Test" cannot be unassigned. It is in used in 3 payment method configuration(s): 
    Check / Money order [Admin, Main Website, Private Sales Website]
    To unassign such an order status, make sure no orders are using it.

Discussion:

Explore the Knowledge Base