Difference between revisions of "Order Statuses"

From WHMCS Documentation

 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
Order statuses allow you to better organise your workflow. The setup area allows you to customise the default statuses as well as creating your own via '''Setup > Other > Order Statuses'''.
+
Order statuses allow you to better organise your workflow.  
 +
 
 +
You can access this feature at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Order Statuses''' or, prior to WHMCS 8.0, '''Setup > Other > Order Statuses'''.
 +
 
 +
== Core Statuses ==
  
 
The order system has '''four''' core statuses.  These are '''Pending, Active, Fraud, and Cancelled'''. The system sets orders to these automatically when various events occur.  For example, when a fraud protection module flags an order as fraudulent, the system sets it to "Fraud. You can't change the names of these statuses, but you can still edit their color and the way the system handles them.
 
The order system has '''four''' core statuses.  These are '''Pending, Active, Fraud, and Cancelled'''. The system sets orders to these automatically when various events occur.  For example, when a fraud protection module flags an order as fraudulent, the system sets it to "Fraud. You can't change the names of these statuses, but you can still edit their color and the way the system handles them.
Line 5: Line 9:
 
This is useful products that take longer to complete, like dedicated servers or website design. It allows staff members to see more detailed updates on the progress of the client's order. For web design, statuses like ''Awaiting Approval'', ''Design Sent'' or ''Pending Revisions'' may be appropriate. For dedicated servers' statuses, you could use ''Building'' or ''Software Configuration''.
 
This is useful products that take longer to complete, like dedicated servers or website design. It allows staff members to see more detailed updates on the progress of the client's order. For web design, statuses like ''Awaiting Approval'', ''Design Sent'' or ''Pending Revisions'' may be appropriate. For dedicated servers' statuses, you could use ''Building'' or ''Software Configuration''.
  
You can add more statuses, which will then appear in the admin order details page as options for you to assign orders.  The options you select allow you to determine how the system handles them (see below). You can change the status of an order on the [http://docs.whmcs.com/Order_Management#Managing_Orders Order Details page].
+
You can add more statuses, which will then appear in the admin order details page as options for you to assign orders.  The options you select allow you to determine how the system handles them (see below). You can change the status of an order in the [[Order Management#Managing_Orders|order details]].
  
 
==Status Options==
 
==Status Options==
Line 12: Line 16:
  
 
*'''Status Color''' — A six-digit hexadecimal representation of the color to display that status in.
 
*'''Status Color''' — A six-digit hexadecimal representation of the color to display that status in.
*'''Include in Pending''' — Check this box to include the status on Pending orders (Orders > Pending Orders)
+
*'''Include in Pending''' — Check this box to include the status on '''Pending''' orders ('''Orders > Pending Orders''')
*'''Include in Active''' — Check this box to include the status on Active orders (Orders > Active Orders)
+
*'''Include in Active''' — Check this box to include the status on '''Active''' orders ('''Orders > Active Orders''')
*'''Include in Cancelled''' — Check this box to include the status on Cancelled orders (Orders > Cancelled Orders)
+
*'''Include in Cancelled''' — Check this box to include the status on '''Cancelled''' orders ('''Orders > Cancelled Orders''')
 
*'''Sort Order''' — This determines the display order for statuses.
 
*'''Sort Order''' — This determines the display order for statuses.

Latest revision as of 21:03, 26 April 2022

Order statuses allow you to better organise your workflow.

You can access this feature at Configuration () > System Settings > Order Statuses or, prior to WHMCS 8.0, Setup > Other > Order Statuses.

Core Statuses

The order system has four core statuses. These are Pending, Active, Fraud, and Cancelled. The system sets orders to these automatically when various events occur. For example, when a fraud protection module flags an order as fraudulent, the system sets it to "Fraud. You can't change the names of these statuses, but you can still edit their color and the way the system handles them.

This is useful products that take longer to complete, like dedicated servers or website design. It allows staff members to see more detailed updates on the progress of the client's order. For web design, statuses like Awaiting Approval, Design Sent or Pending Revisions may be appropriate. For dedicated servers' statuses, you could use Building or Software Configuration.

You can add more statuses, which will then appear in the admin order details page as options for you to assign orders. The options you select allow you to determine how the system handles them (see below). You can change the status of an order in the order details.

Status Options

For each order status, you can set the following attributes:

  • Status Color — A six-digit hexadecimal representation of the color to display that status in.
  • Include in Pending — Check this box to include the status on Pending orders (Orders > Pending Orders)
  • Include in Active — Check this box to include the status on Active orders (Orders > Active Orders)
  • Include in Cancelled — Check this box to include the status on Cancelled orders (Orders > Cancelled Orders)
  • Sort Order — This determines the display order for statuses.