OrderStatus
in package
Enum class for all the order statuses.
For a full documentation on the public order statuses, please refer to the following link: https://woocommerce.com/document/managing-orders/order-statuses/
Table of Contents
- AUTO_DRAFT = 'auto-draft'
- The order is an automatically generated draft.
- CANCELLED = 'cancelled'
- The order was canceled by an admin or the customer.
- COMPLETED = 'completed'
- Order fulfilled and complete.
- DRAFT = 'draft'
- Draft orders are created when customers start the checkout process while the block version of the checkout is in place.
- FAILED = 'failed'
- The customer’s payment failed or was declined, and no payment has been successfully made.
- NEW = 'new'
- The order is a draft (legacy status).
- ON_HOLD = 'on-hold'
- The order is awaiting payment confirmation.
- PENDING = 'pending'
- The order has been received, but no payment has been made.
- PROCESSING = 'processing'
- Payment has been received (paid), and the stock has been reduced.
- REFUNDED = 'refunded'
- Orders are automatically put in the Refunded status when an admin or shop manager has fully refunded the order’s value after payment.
- TRASH = 'trash'
- The order is in the trash.
Constants
AUTO_DRAFT
The order is an automatically generated draft.
public
string
AUTO_DRAFT
= 'auto-draft'
CANCELLED
The order was canceled by an admin or the customer.
public
string
CANCELLED
= 'cancelled'
COMPLETED
Order fulfilled and complete.
public
string
COMPLETED
= 'completed'
DRAFT
Draft orders are created when customers start the checkout process while the block version of the checkout is in place.
public
string
DRAFT
= 'draft'
FAILED
The customer’s payment failed or was declined, and no payment has been successfully made.
public
string
FAILED
= 'failed'
NEW
The order is a draft (legacy status).
public
string
NEW
= 'new'
ON_HOLD
The order is awaiting payment confirmation.
public
string
ON_HOLD
= 'on-hold'
PENDING
The order has been received, but no payment has been made.
public
string
PENDING
= 'pending'
PROCESSING
Payment has been received (paid), and the stock has been reduced.
public
string
PROCESSING
= 'processing'
REFUNDED
Orders are automatically put in the Refunded status when an admin or shop manager has fully refunded the order’s value after payment.
public
string
REFUNDED
= 'refunded'
TRASH
The order is in the trash.
public
string
TRASH
= 'trash'