Skip to main content
There are several order status fields that apply to both eCommerce-only and eCommerce plus Order Management implementations of the Kibo Composable Commerce Platform, and exposed in both API data and the Admin UI. This guide describes what each of these statuses means and what actions can be taken on an order in that state.

Watch: Shipment Pending Review

See how to handle shipments blocked by payment errors or pending review status
These fields include the primary order status as well as payment, fulfillment, and return rollup statuses. These order-level rollup states sum up the current status of all individual payment, shipment, and return instances that belong to that order. The Orders page with a list of example orders

Order Status

The diagram below shows every order state and the action that moves an order between states. Solid lines are the normal flow. Dotted lines are re-validation or error paths.

Pending

The order has been created offline or online in a cart and has not yet been submitted. You can submit a Pending order if it has defined items, billing information, and shipping information. This moves the order to the Submitted state. If an order stays in the Pending state for two days, it will be moved to the Abandoned state. If anything goes wrong when moving from Pending to a target state, such as payment gateway issues, the order will move into the Errored state.

Submitted

The order includes one or more items and has defined billing information and shipping information. Once submitted, it proceeds to the validation process such as for fraud detection. If an order passes validation, it will move to the Validated and then Accepted order states. If it does not pass validation, it will move to Pending Review. It is possible to cancel the order at this time, which moves it to the Cancelled state.
In Order Management-only implementations, orders imported through the Create Order API with the isImport flag follow a different entry path than orders placed through checkout. As shown in the diagram above, they skip the Pending and Submitted states and are created directly in the Validated state. See Imported Orders and Fraud Review for details.

Validated

The order has passed the validation process, which validates the items in the order against the products in the catalog, verifies the fulfillment information (either the defined shipping method or in-store pickup location), and initiates communication with the payment gateway. If the order passes validation, it can be moved to the Accepted state. It is possible to cancel the order at this time, which moves it to the Cancelled state. If anything goes wrong when moving from Validated to a target state, such as payment gateway issues, the order will move into the Errored state. In Order Management-only implementations, imported orders are created directly in this state before their validation result is evaluated, so an imported order that requires fraud review will briefly appear as Validated before it moves to Pending Review. See Imported Orders and Fraud Review.

Pending Review

The order has been submitted but did not pass the order validation process. An order in this state can be manually accepted, which moves it to the Accepted state. If the order had already been accepted before it was placed into review (for example, because a new payment was added and the order was re-validated), accepting it returns it to the Processing state instead, or to Completed if it is already paid and fulfilled. If a new payment is added to an order in this state, the order is re-validated. Payments added manually by an agent do not trigger re-validation. Orders placed through checkout enter this state from Submitted. In Order Management-only implementations, imported orders enter this state from Validated, as described in Imported Orders and Fraud Review. It is possible to cancel the order at this time, which moves it to the Cancelled state.

Imported Orders and Fraud Review

In Order Management-only implementations, an imported order does not pass through the Pending or Submitted states. Instead, the import process saves the order with a status of Validated and then evaluates the validation result that was included with the imported order:
  1. The order is created and saved with the Validated status.
  2. If the order was imported without a validation result, or with a validation result whose status is Pass, the order proceeds to Accepted (or Pending Shipment if configurable shipment creation is enabled).
  3. If the order was imported with a validation result whose status is Review, Fail, or Error, the order validation action runs and transitions the order from Validated to Pending Review.
This means that an imported order flagged for fraud review will show a status of Validated for a short time before it moves to Pending Review. This is expected behavior and does not indicate a problem with the order or the validator. The order will not proceed to fulfillment until it is manually accepted from Pending Review. Imported orders in implementations that also use Kibo eCommerce keep the status supplied in the import request and do not follow this path. For more information about validation results and how they map to order states, see Order Validators and Fraud Check Applications.

Pending Shipment

If you have opted to delay shipment creation to a certain time after order submission, rather than create shipments immediately per the default, then the order will enter Pending Shipment until those shipments are created. If this behavior is not enabled, then orders will not enter this status.

Accepted

The order has passed validation and is accepted for processing. Any payments set to Authorize And Capture On Order Placement will be captured during acceptance. If no payment errors have occurred and/or any payment has been captured, shipments are created for the order items. When a payment action has been taken and/or items have been shipped, it will be moved into the Processing state. If a new payment is added to an Accepted or Processing order, the order is re-validated. If the validator flags the order, it moves to Pending Review. Payments added manually by an agent do not trigger re-validation. It is possible to cancel the order at this time, which moves it to the Cancelled state.

Processing

The order’s shipments are in fulfillment and/or a payment action has been taken. If any action is taken on an order after acceptance, it will automatically be transitioned to this status. When this order’s fulfillment rollup status is Fulfilled and the payment rollup status is either Paid or Paid and Errored, then it will be moved to Completed. It is possible to cancel the order at this time, which moves it to the Cancelled state.

Cancelled

The order was cancelled, voiding or crediting any payments. You cannot perform any actions on an order in the Cancelled state.

Completed

The order was accepted, fully shipped, and paid. An order will only be moved to this state if the fulfillment rollup status is Fulfilled and the payment rollup status is either Paid or Paid and Errored, or the order total is zero. You can reopen a completed order, which resets the order state back to Processing.

Errored

An unexpected error occurred during order submission. Orders move to the Errored state from the Pending, Submitted, Validated, or Pending Shipment states if an unexpected error occurs when moving to the target state, such as payment gateway issues and timeouts. An order can also move to Errored if shipment creation fails while it is being placed into Pending Review. An Errored order can be resubmitted, which moves it to Submitted, or cancelled.

Abandoned

An unpaid Pending order timed out because it was never submitted or cancelled. The only action available for an order in the Abandoned state is to cancel it, which moves it to the Cancelled state. An abandoned order cannot be submitted. Orders are determined to be abandoned when no action has been taken on them for a set period of time. By default, orders are determined to be Abandoned when no action has been taken on a Pending order for two days.

Payment Status

The payment rollup status summarizes the overall state of all payments on the order. This status may be:
  • Unpaid: There are no valid payments on the order and no balance has been collected.
  • Pending: There are valid payments on the order to collect the entire order balance.
  • Paid: There is zero balance remaining across all payment methods on the order.
  • Pending And Errored: There are pending payments as well as payments with errors of the type Void or Credit.
  • Paid And Errored: The order is fully collected but there are Credit errors.
  • Voided: The order is cancelled and every payment on it has been voided. This status only appears on cancelled orders.
  • Credited: The order is cancelled and its payments have been voided, credited, or are pending credit. This status only appears on cancelled orders.
  • Errored: Something is wrong with the payments on the order and at least one valid payment is still needed to cover the order balance. Not every payment has to be errored to trigger this status. For example, if a single payment failure means that there isn’t enough payment to cover the order balance, the order will enter this Errored state.
This state comes with rules that can affect fulfillment in Order Management, in which errored payment states block shipments from being able to progress in fulfillment. For more information about this behavior, see the Payment States section of the shipment processing documentation. And for more details about how payments are processed and the specific actions that can be performed on a payment while it’s in a particular state, see the payment processing documentation.

Fulfillment Status

The fulfillment rollup status summarizes the overall state of all shipments on the order. This status may be:
  • Customer Care: At least one shipment on the order is in the Customer Care status.
  • Not Fulfilled: No shipments associated with the order have been fulfilled.
  • Partially Fulfilled: One or more shipments have been fulfilled, but others are not.
  • Fulfilled: All shipments on the order have been fulfilled (ignoring canceled shipments).
For more granular explanations of shipment-level statuses in Order Management implementations and this fulfillment behavior, see the shipment processing documentation.

Return Status

The order-level return rollup status summarizes the overall state of all returns on the order. This status may be:
  • None: The order has no returns, or all returns associated with the order are rejected or cancelled.
  • In Progress: The order has at least one associated return that is not cancelled, closed or rejected.
  • Order Partially Returned: There are some closed returns associated with the order; however, there are also returns that are not cancelled, closed or rejected.
  • Order Fully Returned: All returns associated with the order are closed.
For more information about individual return states and the return process, see the Returns documentation.