We announce the release of a new API version aimed at providing convenience for our partners using the service.
- Overview
- Getting Started
- Authentication
- Q&A
- Common Errors
- API Call Flow
- Instant Order Flow
- Boxme's RTO and RPO
- Changelog
- API References
- Location
- Pickup
- Product
- Shipment (ASN)
- Customer
- Orders
- Order API Overview
- Error Codes
- Get Shipping Option (Fulfillment)POST
- Get Shipping Option (Dropship)POST
- Create B2C OrderPOST
- Create Delivery OrderPOST
- Create B2B OrderPOST
- Update DocumentPUT
- Request Cancel Delivery OrderPOST
- Cancel OrderPOST
- Get Order DetailGET
- Get Order ListGET
- Get Courier ListGET
- Get Courier ServiceGET
- Get Packed ItemsGET
- Order PackPUT
- Get B2B Pickup TimeSlotGET
- Returns
- Finance
- Location
- Webhooks
- Guidelines
Get Order List
GET
https://s.boxme.asia/api/v2/orders/list
Last modified:2025-02-05 02:58:53
Rate limit: 1rps/IP & 30rq/minute/IP
Request
Query Params
create_from
integer
required
Example:
1701363600
create_to
integer
required
Example:
1704041999
status
integer
optional
Example:
210
page_size
integer
required
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
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://s.boxme.asia/api/v2/orders/list?create_from=1701363600&create_to=1704041999&status=210&page_size=25&page=1' \
--header 'Authorization: Token {{API_TOKEN}}' \
--header 'Content-Type: application/json'Responses
🟢200OK
application/json
Body
data
object
required
total_count
integer
required
orders
array [object {28}]
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",
"price": 85000,
"discounted_price": 83000,
"insurance_price": 71440,
"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",
"approved_time": 1738651774,
"sla_to_pack": 0,
"sla_to_ship": 1738774799,
"sla_to_fulfill": 1738774799,
"sla_to_delivery": 0,
"sla_to_cancel": 1739033999,
"sla_commitment": true,
"sla_commitment_note": "OTHER",
"rts_time": 0,
"shipped_time": 0,
"delivery_time": 0,
"created_time": 1704965987
}
]
},
"error": false,
"error_code": "",
"messages": "",
"request_id": "65a0e820669f750fbcc4e5ae"
}Modified at 2025-02-05 02:58:53