BigCommerce
Management API
Order Status

Orders V2

Get All Order Statuses

GET /order_statuses

Request

Returns a Collection of All Order Statuses.

Order Status Descriptions:

Status IDNameDescription
0IncompleteAn incomplete order happens when a shopper reached the payment page, but did not complete the transaction.
1PendingCustomer started the checkout process, but did not complete it.
2ShippedOrder has been shipped, but receipt has not been confirmed; seller has used the Ship Items action.
3Partially ShippedOnly some items in the order have been shipped, due to some products being pre-order only or other reasons.
4RefundedSeller has used the Refund action.
5CancelledSeller has cancelled an order, due to a stock inconsistency or other reasons.
6DeclinedSeller has marked the order as declined for lack of manual payment, or other reasons.
7Awaiting PaymentCustomer has completed checkout process, but payment has yet to be confirmed.
8Awaiting PickupOrder has been pulled, and is awaiting customer pickup from a seller-specified location.
9Awaiting ShipmentOrder has been pulled and packaged, and is awaiting collection from a shipping provider.
10CompletedClient has paid for their digital product and their file(s) are available for download.
11Awaiting FulfillmentCustomer has completed the checkout process and payment has been confirmed.
12Manual Verification RequiredOrder is on hold while some aspect needs to be manually confirmed.
13DisputedCustomer has initiated a dispute resolution process for the PayPal transaction that paid for the order.
14Partially RefundedSeller 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

Response

Get All Order Status Collection Response.

Body

array | application/json
  • id
    integer

    The ID of the type of order status.

    Example: 0

  • name
    string

    Name of the type of order status.

    Example: Incomplete

  • system_label
    string

    System name of the type of order status.

    Example: Incomplete

  • custom_label
    string

    Custom order status label given in the Control Panel.

    Example: Incomplete- Waiting on Shipment

  • system_description
    string

    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 /order_statuses/{status_id}

Request

Returns a single order status.

Order Status Descriptions

Status IDNameDescription
0IncompleteAn incomplete order happens when a shopper reached the payment page, but did not complete the transaction.
1PendingCustomer started the checkout process, but did not complete it.
2ShippedOrder has been shipped, but receipt has not been confirmed; seller has used the Ship Items action.
3Partially ShippedOnly some items in the order have been shipped, due to some products being pre-order only or other reasons.
4RefundedSeller has used the Refund action.
5CancelledSeller has cancelled an order, due to a stock inconsistency or other reasons.
6DeclinedSeller has marked the order as declined for lack of manual payment, or other reasons.
7Awaiting PaymentCustomer has completed checkout process, but payment has yet to be confirmed.
8Awaiting PickupOrder has been pulled, and is awaiting customer pickup from a seller-specified location.
9Awaiting ShipmentOrder has been pulled and packaged, and is awaiting collection from a shipping provider.
10CompletedClient has paid for their digital product and their file(s) are available for download.
11Awaiting FulfillmentCustomer has completed the checkout process and payment has been confirmed.
12Manual Verification RequiredOrder is on hold while some aspect needs to be manually confirmed.
13DisputedCustomer has initiated a dispute resolution process for the PayPal transaction that paid for the order.
14Partially RefundedSeller 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 /orders endpoints.

example

Response

Body

object | application/json
  • id
    integer

    The ID of the type of order status.

    Example: 0

  • name
    string

    Name of the type of order status.

    Example: Incomplete

  • system_label
    string

    System name of the type of order status.

    Example: Incomplete

  • custom_label
    string

    Custom order status label given in the Control Panel.

    Example: Incomplete- Waiting on Shipment

  • system_description
    string

    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

Did you find what you were looking for?