Order API Overview
Order API Overview
Context
You may programmatically GET an Order List, and GET the Order Details from a specific Order.
Additionally, you may also subscribe to the Order Status Webhook to be notified regarding order status changes.
Important Concepts
Order status flow
1. MKP's order & Seller Delivery/Delivery by MKP
2. Webstore/MKP orders & Delivery by Boxme
Order Status Definition
| Status | Status Code | Description |
|---|---|---|
| Awaiting Label | 110 | Orders are waiting for label generation from couriers or initial fulfillment |
| Label generated | 201 | Labels for orders have been generated, waiting to sync to the warehouse |
| Out of stock | 212 | Order has an out-of-stock product |
| Awaiting process at warehouse | 210 | Orders awaiting processing (pick) at the warehouse |
| Processing at warehouse | 217 | Orders are being processed (pick, pack) at the warehouse |
| Ready to ship at warehouse | 211 | Packaging process completed, waiting to hand over to the courier |
| Waiting to handover | 280 | Orders awaiting handover to the courier |
| Shipped | 300, 301 | Orders have been handed over to the courier |
| Courier refuse | 302 | Courier has refused to receive the orders |
| In-transit | 304 | Orders are currently in transit to receiver locations |
| Out for delivery | 310 | Orders waiting for delivery |
| Out of delivery | 400 | Delivery was unsuccessful for some reason |
| Awaiting to Re-Delivery | 410 | Awaiting confirmation for a redelivery attempt |
| Return processing | 420 | The orders are currently being processed for return |
| Return approved | 430 | The return has been approved, waiting to return to the warehouse |
| Return processing | 420 | The orders are currently being processed for return |
| Return approved | 430 | The return has been approved, waiting to return to the warehouse |
| Returned | 600 | Orders have been successfully returned. This is end of order status |
| Destroy at Destination Hub | 606, 605 | Parcel damage/lost by courier. This is end of order status |
| Cancelled by sellers | 700 | The order was cancelled by the sellers |
| Cancelled by operator | 701 | The order was cancelled by the operator |
| Cancelled by system | 703 | The order was cancelled automatically by the system |
| Pending for audit status | 704 | The status of the order is pending verification |
| Cancelled at warehouse | 705 | The order was cancelled during the warehouse process. This is end of order status |
| Waiting for cancellation | 706 | Awaiting processing of the cancellation request |
| Cancelled by lost item | 708 | The order was cancelled due to the loss of items. This is end of order status |
| Fulfilled | 801 | Orders have been successfully fulfilled. This is end of order status |
| Delivered | 800 | Orders have been successfully delivered. This is end of order status |
Returns Order Status
| Status | Status Code | Description |
|---|---|---|
| Awaiting to receive | 501 | Waiting to receive orders at the warehouse. Specific for Returns order |
| Received | 502 | Warehouse has received the orders. Specific for Returns order |
| Inspected | 503 | Returned orders have completed inspection/quality checking. Specific for Returns order |
| Returned | 600 | Orders have been inspected successfully & putawayed. Stock increased. |
Modified at 2024-10-07 04:42:15