get

/order_statuses

Gets a list of order statues.

Authorization

apiKey - X-Auth-Token
apiKey - X-Auth-Client

Request Parameters

2 Query Parameters
2 Headers

Responses

1 Example
Schema
object
Status ID Name Description
0 Incomplete An incomplete order happens when a shopper reached the payment page, but did not complete the transaction.
1 Pending Customer started the checkout process, but did not complete it.
2 Shipped Order has been shipped, but receipt has not been confirmed; seller has used the Ship Items action.
3 Partially Shipped Only some items in the order have been shipped, due to some products being pre-order only or other reasons.
4 Refunded Seller has used the Refund action.
5 Cancelled Seller has cancelled an order, due to a stock inconsistency or other reasons.
6 Declined Seller has marked the order as declined for lack of manual payment, or other reasons.
7 Awaiting Payment Customer has completed checkout process, but payment has yet to be confirmed.
8 Awaiting Pickup Order has been pulled, and is awaiting customer pickup from a seller-specified location.
9 Awaiting Shipment Order has been pulled and packaged, and is awaiting collection from a shipping provider.
10 Completed Client has paid for their digital product and their file(s) are available for download.
11 Awaiting Fulfillment Customer has completed the checkout process and payment has been confirmed.
12 Manual Verification Required Order on hold while some aspect needs to be manually confirmed.
13 Disputed Customer has initiated a dispute resolution process for the PayPal transaction that paid for the order.
14 Partially Refunded Seller has partially refunded the order.
id
integer

The id of the type of order status

1 validation
name
string

Name of the type of order status

1 validation
system_label
string

System name of the type of order status.

1 validation
custom_label
string

Custom order status label given in the Control Panel

1 validation
system_description
string

System description of the order status

1 validation
count
number

Number of orders that exist with this status

1 validation
sort_order
number

The sort order of the order status from the Control Panel

1 validation

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
Path Params
1 path param not set
store_hash
$$.env
2 variables not set
X-Auth-Token
X-Auth-Client