How To Create A Custom Order State In Magento ?

In Magento, defining an appropriate Order Status provides a clear idea for the operations team to understand the position of the order and take the necessary action. Magento has an Order State and Order Status that describes the current position of the order. The Default Order State and the corresponding statuses available in Magento are:

Order State	Order Status
New	Processing
Pending Payment	Pending Payment
Processing	Suspected Fraud
Complete	Payment Review
Closed	Pending
Canceled	On Hold
On Hold	Complete
Payment Review	Closed
	Canceled
	Pending PayPal

Each Order State can be associated with different kinds of Order Statuses to provide a clear picture about the order. While Magento provides an option to customize the Order Status, the Order State still has the default options. In few occasions, retailers look out for a customized Order State so that there is no miscommunication across different verticals in the organization.

We are planning to add a new Order State called “Partially paid”. Let’s have a look at the method to create a customized Order State in Magento.

Step-1:

First we need register the new module in Magento. To accomplish this, create a new xml file in this path. app/etc/modules/Custom_Orderstate.xml

&lt;?xml version="1.0"?&gt;
&lt;config&gt;
&lt;modules&gt;
&lt;Custom_Orderstate&gt;
&lt;active&gt;true&lt;/active&gt;
&lt;codePool&gt;local&lt;/codePool&gt;
&lt;/Custom_Orderstate&gt;
&lt;/modules&gt;
&lt;/config&gt;

<?xml version="1.0"?>

<Custom_Orderstate>

<codePool>local</codePool>

</Custom_Orderstate>

</modules>

</config>

Step-2:

Next, we need to configure our module. The configuration files can be found in the “etc” folder inside our module directory. So let’s create the configuration xml file: app/code/local/Custom/Orderstate/etc/config.xml

&lt;?xml version="1.0"?&gt;
&lt;config&gt;
&lt;modules&gt;
&lt;Custom_Orderstate&gt;
&lt;version&gt;0.1.0&lt;/version&gt;
&lt;/Custom_Orderstate&gt;
&lt;/modules&gt;
&lt;global&gt;
&lt;resources&gt;
&lt;orderstate_setup&gt;
&lt;setup&gt;
&lt;module&gt;Custom_Orderstate&lt;/module&gt;
&lt;/setup&gt;
&lt;connection&gt;
&lt;use&gt;core_setup&lt;/use&gt;
&lt;/connection&gt;
&lt;/orderstate_setup&gt;
&lt;orderstate_write&gt;
&lt;connection&gt;
&lt;use&gt;core_write&lt;/use&gt;
&lt;/connection&gt;
&lt;/orderstate_write&gt;
&lt;orderstate_read&gt;
&lt;connection&gt;
&lt;use&gt;core_read&lt;/use&gt;
&lt;/connection&gt;
&lt;/orderstate_read&gt;
&lt;/resources&gt;
&lt;sales&gt;
&lt;order&gt;
&lt;statuses&gt;
&lt;partial_paid translate="label"&gt;
&lt;label&gt;Partial Paid&lt;/label&gt;
&lt;/partial_paid&gt;
&lt;/statuses&gt;
&lt;states&gt;
&lt;partial_paid translate="label"&gt;
&lt;label&gt;Partial Paid&lt;/label&gt;
&lt;statuses&gt;
&lt;partial_paid default="1"/&gt;
&lt;/statuses&gt;
&lt;/partial_paid&gt;
&lt;/states&gt;
&lt;/order&gt;
&lt;/sales&gt;
&lt;/global&gt;
&lt;/config&gt;

<?xml version="1.0"?>

<Custom_Orderstate>

</Custom_Orderstate>

</modules>

<orderstate_setup>

<setup>

<module>Custom_Orderstate</module>

</setup>

<use>core_setup</use>

</connection>

</orderstate_setup>

<orderstate_write>

<use>core_write</use>

</connection>

</orderstate_write>

<orderstate_read>

</connection>

</orderstate_read>

</resources>

<sales>

<order>

<partial_paid translate="label">

<label>Partial Paid</label>

</partial_paid>

</statuses>

<partial_paid translate="label">

<label>Partial Paid</label>

<partial_paid default="1"/>

</statuses>

</partial_paid>

</states>

</order>

</sales>

</global>

</config>

Step-3:

Once the configuration is done, we need to create a SQL script file to insert our order state on the database tables (sales_order_status & sales_order_status_state). Let’s create a new PHP file in the following folder:
app/code/local/Custom/Orderstate/sql/orderstate_setup/mysql4-install-0.1.0.php

&lt;?php
$installer = $this;
// Required tables
$statusTable = $installer-&gt;getTable('sales/order_status');
$statusStateTable = $installer-&gt;getTable('sales/order_status_state');
// Insert statuses
$installer-&gt;getConnection()-&gt;insertArray(
$statusTable,
array('status', 'label'),
array(
array(
'status' =&gt; 'partial_paid', 
'label' =&gt; 'Partial Paid'
)
)
);
// Insert states and mapping of statuses to states
$installer-&gt;getConnection()-&gt;insertArray(
$statusStateTable,
array('status', 'state', 'is_default'),
array(
array(
'status' =&gt; 'partial_paid', 
'state' =&gt; 'partial_paid', 
'is_default' =&gt; 1
)
)
);

<?php

$installer = $this;

// Required tables

$statusTable = $installer->getTable('sales/order_status');

$statusStateTable = $installer->getTable('sales/order_status_state');

// Insert statuses

$installer->getConnection()->insertArray(

$statusTable,

array('status', 'label'),

array(

'status' => 'partial_paid',

'label' => 'Partial Paid'

)

);

// Insert states and mapping of statuses to states

$installer->getConnection()->insertArray(

$statusStateTable,

array('status', 'state', 'is_default'),

array(

'status' => 'partial_paid',

'state' => 'partial_paid',

'is_default' => 1

)

);

Step-4:

The final step is to login your Magento admin side. You can see the newly created order state ‘Partial Paid’ under the System > Order Statuses path.

With changing market dynamic retailers, look out for methods to improve the operational efficiency by providing an appropriate order state. This will allow a clear flow of communication across different departments in the organization enabling retailers to avoid confusions and increase productivity.

13 Comments on "How To Create A Custom Order State In Magento?"

Guest

b7itzz

1 year 7 months ago

I tried the code above to the tee. It’s showing under system/order statuses but not showing as an option to change the status of an order.

Reply -

pardeep kumar

1 year 10 months ago

Custom added states are not appearing in status drop-down in comment box!

Hide Replies ∧

Author

Balasubramaniam

Hi Pardeep Kumar,
Can you please share your code. We will check and let you know.
Thanks.
Subscribe to our blogs.

I tested the code first with one state only and it worked but when added 2 more states, its not working.

I followed every step, also the code given in comment but nothing is working!!

Any suggestion please

Rafael Corrêa Gomes

2 years 4 months ago

Thanks for sharing!

Hi Rafael,

Thanks for your comments.
Please subscribe to our blogs for more insights on eCommerce,Magento & QA.

lounik

2 years 5 months ago

Hi, very nice tutorial! A question: how can I have the new custom state assigned to a particular process.. example: I need that when a credit memo is created for an order, the order does not go into complete state but goes into custom state. How do I achieve that?

Hi Lounik,
Thanks for your mail.
By using the above code, we can only create the new order state. For assigning that state to a particular process, we have to customaize the default code.
Let us know if you have any further queries.
Please subscribe to our blogs.
Thanks.

Mujahidh

2 years 9 months ago

awsom tutorial, but a kind request it would be better if you write the complete code like $installer->startSetup(); .It will help to new beginners.

How the code will look if we want to add 2 or more states?

Hi PK,

Sorry for the late reply.

Here is the code…please test it before you implement the same.
Thanks.
Please subscribe to our blogs. Mail us if you have any queries.

In the app/code/local/Custom/Orderstate/etc/config.xml file, add your state lists like follows,

Partial Paid

Partial Paid New State

In the app/code/local/Custom/Orderstate/sql/orderstate_setup/mysql4-install-0.1.0.php file, add your state lists like follows,

// Insert statuses
$installer->getConnection()->insertArray(
$statusTable,
array(‘status’, ‘label’),
array(
array(
‘status’ => ‘partial_paid’,
‘label’ => ‘Partial Paid’
),
array(
‘status’ => ‘partial_paid_new’,
‘label’ => ‘Partial Paid New State’
)
)
);

// Insert states and mapping of statuses to states
$installer->getConnection()->insertArray(
$statusStateTable,
array(‘status’, ‘state’, ‘is_default’),
array(
array(
‘status’ => ‘partial_paid’,
‘state’ => ‘partial_paid’,
‘is_default’ => 1
),
array(
‘status’ => ‘partial_paid_new’,
‘state’ => ‘partial_paid_new’,
‘is_default’ => 1
)
)
);

Samuele

3 years 7 months ago

Yeah!
The only guide that explains exactly which files to create, in what path and how to set the config properly.
The other guides put only portions of code without saying where and how they must to be written!
Thanks so much!!!