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)
- Get Shipping Option (Dropship)
- Create B2C Order
- Create Delivery Order
- Create B2B Order
- Update Document
- Request Cancel Delivery Order
- Cancel Order
- Get Order Detail
- Get Order List
- Get Courier List
- Get Courier Service
- Get Packed Items
- Order Pack
- Get B2B Pickup TimeSlot
- Returns
- Finance
- Location
- Webhooks
- Guidelines
Order Status Push
POST
https://s.boxme.asia/webhook-url
Last modified:2024-10-04 07:10:54
Request
Header Params
Content-Type
string
optional
Example:
application/json
Authorization
string
optional
Example:
{{WEBHOOK_TOKEN}}
Body Params application/json
country
string
required
seller_id
integer
required
event_type
string
required
data
object
required
tracking_number
string
required
order_number
string
required
courier_name
string
required
courier_tracking_code
string
required
pickup_id
integer
required
order_type
string
required
status
integer
required
status_name
string
required
rts_time
integer
required
shipped_time
integer
required
delivery_time
integer
required
update_time
integer
required
note
string
optional
request_id
string
required
timestamp
integer
required
Example
{
"country": "VN",
"seller_id": 331529,
"event_type": "order.status.change",
"data": {
"tracking_number": "BM61556564658",
"order_number": "2023113001",
"courier_name": "Boxme Express",
"courier_tracking_code": "BM61556564658",
"order_type": "b2c",
"status": 210,
"status_name": "Awaiting process at warehouse",
"rts_time": 0,
"shipped_time": 0,
"delivery_time": 0,
"update_time": 1701336279
},
"request_id": "657408c12367d72792d4f403",
"timestamp": 1702103233
}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 POST 'https://s.boxme.asia/webhook-url' \
--header 'Authorization: {{WEBHOOK_TOKEN}}' \
--header 'Content-Type: application/json' \
--data-raw '{
"country": "VN",
"seller_id": 331529,
"event_type": "order.status.change",
"data": {
"tracking_number": "BM61556564658",
"order_number": "2023113001",
"courier_name": "Boxme Express",
"courier_tracking_code": "BM61556564658",
"order_type": "b2c",
"status": 210,
"status_name": "Awaiting process at warehouse",
"rts_time": 0,
"shipped_time": 0,
"delivery_time": 0,
"update_time": 1701336279
},
"request_id": "657408c12367d72792d4f403",
"timestamp": 1702103233
}'Responses
🟢200Success
application/json
Body
object {0}
Example
{}Modified at 2024-10-04 07:10:54