Difference between revisions of "Order Statuses"

From WHMCS Documentation

m
 
(4 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.  
  
−
The order system has '''4''' core statuses. These are '''Pending, Active, Fraud and Cancelled'''. As the core system statuses, this means that orders are set to them automatically by the system when various events occur.  For example when an order is flagged as fraudulent by a fraud protection module it's set to "Fraud. The names of these statuses therefore cannot be changed, but you can still edit their color and the way they are treated.
+
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'''.
  
−
This is particularly useful for more complex products for which completion may take longer such as dedicated servers or website design so staff members can see more detailed updates on the progress of the client's order. For web design statuses such as ''Awaiting Approval'', ''Design Sent'' or ''Pending Revisions'' may be appropriate, for dedicated servers statuses such as ''Building'' or ''Software Configuration'' could be used.
+
== Core Statuses ==
  
−
You can add any additional statuses that you want and these 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 they are handled by the system and are explained in more detail below. The status of an order can be changed from the [http://docs.whmcs.com/Order_Management#Managing_Orders Order Details page].
+
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 Management#Managing_Orders|order details]].
  
 
==Status Options==
 
==Status Options==
Line 11: Line 15:
 
For each order status, you can set the following attributes:
 
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
+
*'''Status Color''' — A six-digit hexadecimal representation of the color to display that status in.
−
*'''Include in Pending''' - Ticking this box includes the status in the orders considered Pending (Orders > Pending Orders)
+
*'''Include in Pending''' — Check this box to include the status on '''Pending''' orders ('''Orders > Pending Orders''')
−
*'''Include in Active''' - Ticking this box includes the status in the orders considered as Active (Orders > Active Orders)
+
*'''Include in Active''' — Check this box to include the status on '''Active''' orders ('''Orders > Active Orders''')
−
*'''Include in Cancelled''' - Ticking this box includes the status in the orders considered as Cancelled (Orders > Cancelled Orders)
+
*'''Include in Cancelled''' — Check this box to include the status on '''Cancelled''' orders ('''Orders > Cancelled Orders''')
−
*'''Sort Order''' - This determines in what order the orders statuses are displayed.
+
*'''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.
Retrieved from "http://3.17.75.209/index.php?title=Order_Statuses&oldid=32447"