Get Order List
The get order list API allows you to retrieve orders that have been created in our system.
You can paginate and filter the results with parameters such as page, limit, status, and filter by date range with startDate / endDate (see the table below).
Endpoint
GET https://staging-manage.api.miniai.vn/api/external/v1/orders
https://staging-manage.api.miniai.vn/api/external/v1/orders?status=pending&page=1&limit=1
GET https://manage-api.miniap.vn/api/external/v1/orders
Query Parameters
All parameters are optional. shopId is resolved automatically from your API key — you do not need to send it. Results are always sorted newest first (by createdAt descending).
| Parameter | Type | Default | Description |
|---|---|---|---|
page | number | 1 | Page to retrieve |
limit | number | 10 | Orders per page (max 100) |
status | string | — | Filter by status: pending, confirmed, shipping, delivered, cancelled… |
startDate | string (ISO 8601) | — | Only orders with createdAt ≥ this value |
endDate | string (ISO 8601) | — | Only orders with createdAt ≤ this value |
customerId | string | — | Filter by customer ID |
paymentMethod | string | — | Filter by payment method |
platform | string | — | Filter by the platform the order was created on |
search | string | — | Search by order code / customer name / phone (case-insensitive) |
startDate and endDate must be in ISO 8601 format and are compared in UTC. endDate is compared with ≤ against createdAt, so passing a date only (e.g. 2025-09-16) is interpreted as 2025-09-16T00:00:00Z and will miss orders created later that day. To cover a full day, pass an explicit end-of-day timestamp — e.g. endDate=2025-09-16T23:59:59.999Z.
Example — filter by date range
GET https://staging-manage.api.miniai.vn/api/external/v1/orders?startDate=2025-09-01T00:00:00.000Z&endDate=2025-09-30T23:59:59.999Z&page=1&limit=50
Use meta.total (total orders matching the filter) and meta.totalPages from the response to iterate page by page — no need to scan everything and filter createdAt on the client side.
Response
- Response
{
"success": true,
"data": {
"orders": [
{
"_id": "68c9415a802d36826bc46836",
"code": "Q42Df8a2V2",
"shippingMethod": "ahamove",
"addressId": "685a28d9ec74b054e81ef206",
"shopAddressId": "689c054edab00e15569f2d54",
"userId": {
"_id": "685930fd539ae361bb35fa62",
"phone": "0335214562",
"fullName": "Lê Quốc An",
"avatar": "https://s120-ava-talk.zadn.vn/d/b/8/1/18/120/3fa4b3b7f2e9501ff1e42d65e4b97dd5.jpg",
"id": "685930fd539ae361bb35fa62"
},
"shopId": "64204a17a5a97a86f12e1f0a",
"price": 520000,
"discount": 0,
"originPrice": 500000,
"discountShipping": 0,
"flashSaleDiscount": 0,
"isPaid": false,
"paidAmount": 0,
"status": "pending",
"note": "",
"shippingFee": 70000,
"loyaltyDiscount": 50000,
"pointDiscountPrice": 0,
"points": 0,
"search": "q42df8a2v2 0335214562 le quoc an le quoc an",
"platform": "mini_app",
"createdAt": "2025-09-16T10:52:10.219Z",
"updatedAt": "2025-09-16T10:52:11.013Z",
"__v": 0,
"sOrderId": "1725173646",
"isSynced": true,
"orderItems": [
{
"_id": "68c9415a802d36826bc46838",
"orderId": "68c9415a802d36826bc46836",
"skuId": "68ad93ebe2945293c795e568",
"quantity": 1,
"price": 500000,
"listSubItem": [],
"name": "Combo 2 Thùng Kazu Chan Tặng 1 Lốc Cùng Loại Và 1 Lọ Yến Sào Sago Nest Kid Hồi Phục",
"status": "pending",
"sku": {
"_id": "68ad93ebe2945293c795e568",
"name": "Combo 2 Thùng Kazu Chan Tặng 1 Lốc Cùng Loại Và 1 Lọ Yến Sào Sago Nest Kid Hồi Phục",
"price": 500000,
"originPrice": null,
"images": [
"https://dmcl0k8mc5oht.cloudfront.net/68771917162907f3c32d45e2/692d4327-21ae-42a3-887f-3e92d1f224bf.png"
],
"itemId": "68ad93eae2945293c795dd39",
"sku": "COMBO-KAZU-01",
"barcode": "8935049500123",
"variantOptionIDs": [],
"item": {
"_id": "68ad93eae2945293c795dd39",
"name": "Combo 2 Thùng Kazu Chan Tặng 1 Lốc Cùng Loại Và 1 Lọ Yến Sào Sago Nest Kid Hồi Phục",
"images": [
"https://dmcl0k8mc5oht.cloudfront.net/68771917162907f3c32d45e2/692d4327-21ae-42a3-887f-3e92d1f224bf.png"
],
"id": "68ad93eae2945293c795dd39"
},
"variantOptions": [],
"id": "68ad93ebe2945293c795e568"
},
"id": "68c9415a802d36826bc46838"
}
],
"table": null,
"id": "68c9415a802d36826bc46836",
"paymentStatus": "not_paid",
"invoiceStatus": "draft",
"isVAT": false
}
],
"orderCountByStatus": {
"ready_to_ship": 1,
"confirmed": 97,
"completed": 24,
"shipping": 111,
"complete": 2,
"delivered": 304,
"pending": 1152,
"cancelled": 33,
"processing": 1
},
"meta": {
"page": 1,
"limit": 1,
"total": 1152,
"totalPages": 1152,
"pending": 1152,
"confirmed": 97,
"readyToShip": 1,
"shipping": 111,
"delivered": 304,
"cancelled": 33
}
}
}