Payment State
As the name suggests, the payment state indicates the status of the payment(s) associated with the order. Payment states are as follows:| Payment State | Description |
|---|---|
| Paid | Payment for the order has been captured |
| Balance Due | Payment for the order has not been captured |
| Credit Owed | The customer is owed credit for the order (e.g., an item was out of stock) |
| Refunded | Payment for the order has been fully refunded |
| Partially Refunded | Payment for the order has been partially refunded |
| Failed | Payment could not be processed |
Shipment State
Similar to the above, the Shipment State indicates the status of shipment(s) associated with the order. Shipment states are as follows:| Shipment State | Description |
|---|---|
| Fulfilled | Order has been shipped |
| Partial | At least one suborder has been shipped |
| Ready | Order is ready to be shipped |
| Pending | Order needs to be shipped, but payment not yet captured |
| Cancelled | Order has been cancelled |
Using Order States
Understanding the meaning of each Payment State and Shipment State helps you identify the next steps for any given order, for example:| Payment State | Shipment State | Action |
|---|---|---|
| Paid | Fulfilled | None - the order is complete |
| Paid | Unfulfilled | Ship the order |
| Balance Due | Unfulfilled | Request payment from the customer |
| Credit Owed | Partial | Refund the amount owed |

