Order Status
Get All Order Statuses
GET https://api.bigcommerce.com/stores/{store_hash}/v2/order_statusesRequest
Returns a Collection of All Order Statuses.
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. |
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
example
Response
Body
idinteger
The ID of the type of order status.namestring
Name of the type of order status.Example: Incompletesystem_labelstring
System name of the type of order status.Example: Incompletecustom_labelstring
Custom order status label given in the Control Panel.Example: Incomplete- Waiting on Shipmentsystem_descriptionstring
System description of the order status.Example: An incomplete order happens when a shopper reached the payment page, but did not complete the transaction.
response
Get a Single Order Status by ID
GET https://api.bigcommerce.com/stores/{store_hash}/v2/order_statuses/{status_id}Request
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. |
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- status_id in path - integerrequiredThe status ID of the order. You can get the status id from the
/ordersendpoints.
example
Response
Body
idinteger
The ID of the type of order status.namestring
Name of the type of order status.Example: Incompletesystem_labelstring
System name of the type of order status.Example: Incompletecustom_labelstring
Custom order status label given in the Control Panel.Example: Incomplete- Waiting on Shipmentsystem_descriptionstring
System description of the order status.Example: An incomplete order happens when a shopper reached the payment page, but did not complete the transaction.