Retrieve an order
Was this page helpful?
Retrieve an order
Get one order by O2M's ID.
Overview
Returns one order with its lines and parcels.
Request
GET/orders/{id}
Needs the permission orders:read
cURL
curl "https://api.o2m.in/api/v1/orders/4410" \
-H "X-Access-Key: $O2M_ACCESS_KEY" \
-H "X-Secret-Key: $O2M_SECRET_KEY"| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | O2M's ID for the order: the id field, not your order number. |
Tip Only have your own number? List orders, or keep the id when you create the order.
Response
200 with the order, in the shape described in List orders.
Response
{
"id": "4410",
"order_id": "SO-1001",
"channel": "mysite",
"status": "shipped",
"channel_status": null,
"ordered_at": "2026-10-02T10:00:00.000Z",
"updated_at": "2026-10-02T10:00:02.000Z",
"dispatch_by": null,
"shipped_at": "2026-10-02T15:00:00.000Z",
"delivered_at": null,
"cancelled_at": null,
"total": 200,
"tax": 30.51,
"customer": {
"name": "Ravi",
"email": "ravi@example.com"
},
"shipping_address": {
"name": "Ravi",
"phone": "9800000000",
"address1": "12 MG Road",
"address2": null,
"city": "Pune",
"state": "Maharashtra",
"pincode": "411001",
"country": "IN"
},
"client": null,
"lines": [
{
"id": "9001",
"sku": "MUG-BLUE",
"title": "Blue mug",
"quantity": 2,
"unit_price": 100,
"total": 200,
"tax": 30.51,
"reserved": 0,
"backordered": 0,
"dispatched": 2,
"delivered": 0,
"returned": 0
}
],
"shipments": [
{
"id": "77",
"number": "SHP-2627-00012",
"order_id": "SO-1001",
"status": "dispatched",
"warehouse": "BLR",
"courier": "Delhivery",
"awb": "1234567890",
"weight_grams": 450,
"tracking_status": null,
"packed_at": "2026-10-02T11:00:00.000Z",
"dispatched_at": "2026-10-02T15:00:00.000Z",
"updated_at": "2026-10-02T15:00:00.000Z"
}
]
}Errors
| Status | Code | Message | What to do |
|---|---|---|---|
| 404 | — | Order not found | Check the id. A 3PL client's key sees only its own orders. |
| 404 | — | Not found | The id is not a valid ID. |
Every endpoint can also return the common errors: a missing or invalid key, a missing permission, the rate limit, or a temporary failure.