Status Codes

This article contains a list of the various status codes that are used throughout the platform, along with a description of the code and the circumstances that result in the code being displayed.

Orders

The order status event holds details of the current status with regards to the order itself, along with it's fulfilments and payments.

There are 3 types of status events for orders:

order
payment
fulfilment

Each of the codes applicable to each category are detailed below.

Order Status Codes

Code	Description
`ORDER_CREATED`	When the order is created. Payment may not have been taken.
`ORDER_CONFIRMED`	When the order is committed. If an order has this status and the `PAYMENT_COMPLETED` status, the order is paid for and awaiting fulfilment.
`ORDER_CANCELLED`	Order is cancelled. (Either manually or due to bad payment status.)
`ORDER_COMPLETED`	Order has completed.

Payment Status Codes

Code	Description
`PAYMENT_PENDING`	Awaiting payment. This can occur if there is a delay between the payment being created and the payment being captured. This status will also activate if any payment detail has the status `requires_action` or `processing`.
`PAYMENT_COMPLETED`	All payments have completed successfully. Every payment detail must have the status of `succeeded` for this status to activate.
`PAYMENT_FAILED`	At least one payment detail has a status of `failed`.
`PAYMENT_PARTIALLY_REFUNDED`	The order has been partially refunded. Currently this status is only active when manually assigned - no process automatically activates it and refunds are not tracked internally.
`PAYMENT_REFUNDED`	The order has been refunded. Currently this status is only active when manually assigned - no process automatically activates it and refunds are not tracked internally.
`PAYMENT_DISPUTED`	The customer has opened a dispute for a payment attached to the order. The order is automatically transitioned to the `ORDER_CANCELLED` status, as disputes are assumed to be a mitaken order or a fraudulent purchase.

Fulfilment Status Codes

Code	Description
`AWAITING_FULFILMENT`	The order is awaiting fulfilment. This state is the default when an order is created, it does not indicate that the order has been paid for.
`PARTIALLY_FULFILLED`	At least one of the line items has been assigned to a fulfilment.
`FULFILLED`	All of the line items have been assigned to a fulfilment.
`PARTIALLY_SHIPPED`	At least one fulfilment attached to the order has had a shipment created for it. No checks are carried out on whether all line items have been assigned to a fulfilment.
`SHIPPED`	All fulfilments attached to the order have had corresponding shipments created. Also checks that all applicable line items have been assigned to fulfilments. If not, the order will be in the `PARTIALLY_SHIPPED` state.
`PARTIALLY_DELIVERED`	At least one shipment has been marked as delivered by the carrier.
`DELIVERED`	All shipments have been marked as delivered by the carrier.
`PARTIALLY_RETURNED`	Indicates that part of the order has been returned. Currently this status is only manually assigned, and does not hold any info on the return.
`RETURNED`	Indicates that the order has been returned. Currently this status is only manually assigned, and does not hold any info on the return.

Payment Details

The codes detailed above are the top level status codes for an order, in that they apply to all entities contained in an order.

An order may contain multiple payment details, which may not all necessarily have the same status.

Each payment detail has a status indicating the state of the individual payment. The possible values are:

Code	Description
`succeeded`	The payment was successful.
`failed`	The payment failed.
`processing`	The payment is processing, and may either succeed or fail in future (eg. a bank transfer that has not yet cleared).
`requires_action`	The payment requires action to be completed. (eg. additional customer verification, the capture stage of an authorize & capture flow)