Get Order List
GET/api/v2/orders/listModified at: 9 months ago
Get Order list by time or status.
Rate limit: 1rps/IP & 30rq/minute/IP
Request
Query Params
create_from
integer
required
Timestamp
Example:
1701363600
create_to
integer
required
Timestamp
Example:
1704041999
status
integer
optional
Refer to status list ID
Example:
210
page_size
integer
required
25, 50, 100
Example:
25
page
integer
required
Example:
1
Header Params
Authorization
string
required
Example:
Token {{API_TOKEN}}
Content-Type
string
optional
Example:
application/json
Request samples
Responses
OK(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
data
object
required
total_count
integer
required
orders
array [object {20}]
required
error
boolean
required
error_code
string
required
messages
string
required
request_id
string
required
Example
{
"data": {
"total_count": 1,
"orders": [
{
"country": "VN",
"tracking_number": "BM65333307514",
"order_number": "",
"courier_tracking_code": "BM65333307514",
"pickup_id": 409223,
"order_type": "b2c",
"receiver": {
"country": "VN",
"fullname": "Thịnh NV",
"phone": "84032999292",
"address": "18 Tam Trinh",
"province_id": 1,
"province_name": "Hà Nội",
"district_id": 250,
"district_name": "Huyện Mê Linh",
"sub_district_id": 8980,
"sub_district_name": "Xã Thạch Đà",
"zipcode": ""
},
"config": {
"preview": false,
"insurance": false,
"is_fulfill_now": false,
"is_co_inspection": false,
"is_priority_fulfill": false
},
"items": [
{
"bsin": "BSN33152979336228",
"seller_sku": "TEST-EXP-KIEN01",
"quantity": 1,
"weight": 10,
"dimension": "11x12x13",
"product_name": "TEST-EXP-KIEN01",
"line_no": "",
"updated_time": 0
}
],
"courier_id": 52,
"service_code": "BM_DBS",
"order_value": 20000,
"cod_amount": 0,
"currency": "VND",
"status": 201,
"status_name": "Label generated",
"rts_time": 0,
"shipped_time": 0,
"delivery_time": 0,
"created_time": 1704965987
}
]
},
"error": false,
"error_code": "",
"messages": "",
"request_id": "65a0e820669f750fbcc4e5ae"
}Last modified: 9 months ago