Get All Order Statuses
GET /stores/{store_hash}/v2/order_statuses
Request
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 - required
Parameters
- store_hash in path - string
- Accept in header with default of application/json - string - required
The MIME type of the response body.
example
curl --request GET \ --url 'https://api.bigcommerce.com/stores/[store_hash]/v2/order_statuses' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'
Response
Get All Order Status Collection Response.
Body
array | application/json
idinteger
The ID of the type of order status.
Example: 0
namestring
Name of the type of order status.
Example: Incomplete
system_labelstring
System name of the type of order status.
Example: Incomplete
custom_labelstring
Custom order status label given in the Control Panel.
Example: Incomplete- Waiting on Shipment
system_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
[ { "id": 0, "name": "Incomplete", "system_label": "Incomplete", "custom_label": "Incomplete - Testing", "system_description": "An incomplete order happens when a shopper reached the payment page, but did not complete the transaction.", "order": 0 }, { "id": 1, "name": "Pending", "system_label": "Pending", "custom_label": "Pending", "system_description": "Customer started the checkout process, but did not complete it.", "order": 1 }, { "id": 2, "name": "Shipped", "system_label": "Shipped", "custom_label": "Shipped", "system_description": "Order has been shipped, but receipt has not been confirmed; seller has used the Ship Items action.", "order": 8 }, { "id": 3, "name": "Partially Shipped", "system_label": "Partially Shipped", "custom_label": "Partially Shipped", "system_description": "Only some items in the order have been shipped, due to some products being pre-order only or other reasons.", "order": 6 }, { "id": 4, "name": "Refunded", "system_label": "Refunded", "custom_label": "Refunded", "system_description": "Seller has used the Refund action.", "order": 11 }, { "id": 5, "name": "Cancelled", "system_label": "Cancelled", "custom_label": "Cancelled", "system_description": "Seller has cancelled an order, due to a stock inconsistency or other reasons.", "order": 9 }, { "id": 6, "name": "Declined", "system_label": "Declined", "custom_label": "Declined", "system_description": "Seller has marked the order as declined for lack of manual payment, or other reasons.", "order": 10 }, { "id": 7, "name": "Awaiting Payment", "system_label": "Awaiting Payment", "custom_label": "Awaiting Payment", "system_description": "Customer has completed checkout process, but payment has yet to be confirmed.", "order": 2 }, { "id": 8, "name": "Awaiting Pickup", "system_label": "Awaiting Pickup", "custom_label": "Awaiting Pickup", "system_description": "Order has been pulled, and is awaiting customer pickup from a seller-specified location.", "order": 5 }, { "id": 9, "name": "Awaiting Shipment", "system_label": "Awaiting Shipment", "custom_label": "Awaiting Shipment", "system_description": "Order has been pulled and packaged, and is awaiting collection from a shipping provider.", "order": 4 }, { "id": 10, "name": "Completed", "system_label": "Completed", "custom_label": "Completed - Testing", "system_description": "Client has paid for their digital product and their file(s) are available for download.", "order": 7 }, { "id": 11, "name": "Awaiting Fulfillment", "system_label": "Awaiting Fulfillment", "custom_label": "Awaiting Fulfillment", "system_description": "Customer has completed the checkout process and payment has been confirmed.", "order": 3 }, { "id": 12, "name": "Manual Verification Required", "system_label": "Manual Verification Required", "custom_label": "Manual Verification Required", "system_description": "Order is on hold while some aspect needs to be manually confirmed.", "order": 13 }, { "id": 13, "name": "Disputed", "system_label": "Disputed", "custom_label": "Disputed", "system_description": "Customer has initiated a dispute resolution process for the PayPal transaction that paid for the order.", "order": 12 }, { "id": 14, "name": "Partially Refunded", "system_label": "Partially Refunded", "custom_label": "Partially Refunded", "system_description": "Seller has partially refunded the order.", "order": 14 } ]
Get a Single Order Status by ID
GET /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 - required
Parameters
- store_hash in path - string
- Accept in header with default of application/json - string - required
The MIME type of the response body.
- status_id in path - integer - required
The status ID of the order. You can get the status id from the
/ordersendpoints.
example
curl --request GET \ --url 'https://api.bigcommerce.com/stores/[store_hash]/v2/order_statuses/[status_id]' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'X-Auth-Token: xxxxxxxxxxxxxxxxx'
Response
Body
object | application/json
idinteger
The ID of the type of order status.
Example: 0
namestring
Name of the type of order status.
Example: Incomplete
system_labelstring
System name of the type of order status.
Example: Incomplete
custom_labelstring
Custom order status label given in the Control Panel.
Example: Incomplete- Waiting on Shipment
system_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
{ "id": 11, "name": "Awaiting Fulfillment", "system_label": "Awaiting Fulfillment", "custom_label": "Awaiting Fulfillment", "system_description": "Customer has completed the checkout process and payment has been confirmed.", "order": 3 }