Get Single Order Status by ID

Returns a single order status.

Order Status Descriptions

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 is 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.

X-Auth-Tokenstring

UI Name	Permission	Parameter
Orders	modify	`store_v2_orders`
Orders	read-only	`store_v2_orders_read_only`

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

status_idstringRequired

idinteger

The ID of the type of order status.

namestring

Name of the type of order status.

system_labelstring

System name of the type of order status.

custom_labelstring

Custom order status label given in the Control Panel.

system_descriptionstring

System description of the order status.

Returns a single order status.

Order Status Descriptions

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 is 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.

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v2/order_statuses/status_id"
4
5	headers = {"X-Auth-Token": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"id": 11,
3	"name": "Awaiting Fulfillment",
4	"system_label": "Awaiting Fulfillment",
5	"custom_label": "Awaiting Fulfillment",
6	"system_description": "Customer has completed the checkout process and payment has been confirmed.",
7	"order": 3
8	}