Skip to main content

Get Order / Shipment

POST /api/external/v1/order/getOrder

Fetch shipment(s) by exactly one of order_id, carton_id (internal carton UUID/AWB reference) or carton_awb (carrier AWB number) — supplying more than one at a time is rejected.

Request body

FieldTypeRequiredDescription
order_idUUID[]Exactly one of the threeOrder ID(s)
carton_uuid_awbUUID[]fields below must be setInternal carton reference(s)
carton_awbstring[]Carrier AWB number(s)
Request Example
{ "order_id": ["8b1e2c3d-....."] }

Response 200 OK

data.orders is an array of Order objects:

{
"success": true,
"status_code": 200,
"message": "Successfully fetched orders",
"data": {
"orders": [
{
"order_id": "8b1e2c3d-.....",
"user_id": "9f2b1e10-.....",
"po_ids": ["b6b2a3e1-0c61-4fd2-9a07-3bf2035888f1"],
"carrier": "delhivery",
"carrier_name": "Delhivery",
"lr_number": "DL123456789",
"master_waybill": "DL123456789",
"child_waybills": ["DL123456789"],
"current_status": "ORDERED",
"current_status_code": "3",
"expected_delivery_date": "2026-08-15T00:00:00Z",
"documents": { "shipping_label_url": "https://.../label.pdf" },
"customer_name": "Acme Retail Pvt Ltd",
"customer_address": "Plot 12, Industrial Area",
"customer_city": "Mumbai",
"customer_state": "Maharashtra",
"customer_pincode": "400001",
"total_cartons": 5,
"total_dead_weight": 120.5,
"shipping_charges": 1003.0,
"carton_details": [ { "type": "BOX", "length": 40, "breadth": 30, "height": 25, "weight": 24.1, "quantity": 5, "volumetric_weight": 19, "awb": ["DL123456789"] } ],
"sku_details": [ { "code": "SKU-001", "name": "Widget", "quantity": 100, "price": 120, "mrp": 150 } ],
"tracking_history": { "status": "IN TRANSIT", "status_code": 8, "scans": [ { "status": "IN TRANSIT", "status_code": 8, "status_date_time": "2026-08-12T10:00:00Z", "scan_location": "Mumbai Hub", "remark": "Departed from hub" } ] },
"order_placed_at": "2026-08-11T09:00:00Z",
"order_pickup_at": "2026-08-12T09:00:00Z",
"delivered_at": null
}
]
}
}

The Order object carries many more optional fields (billing address, vendor details, warehouse address, driver details, appointment scheduling timestamps, proof of delivery, etc.) — the fields above are the ones most relevant for shipment tracking/reporting. current_status_code uses the mapping in Order Status Codes.