Batch update order's tracking numbers
Update order's tracking can be done for multiple order states which will be listed as followed.
PREPARE_TO_SHIPPING
For normal order, when admin approves customer's proof of payment for payment amount. Order will be in this state preparing for shipping
COD_PREPARE_TO_SHIP
For COD order, when admin approves customer's proof of payment for deposit amount or when order does not require any deposit. Order will be in this state preparing for shippingg
Endpoint
/v1/orders/tracking-numbers
Resource method
POST
Parameters
Body parameters
| Field name | Types | Required/Optional | Description |
|---|---|---|---|
| shippingInformation | list of shipping information | R | Order's shipping information |
Shipping information structure
Maximum number of batch order is 5
| Field name | Types | Required/Optional | Description |
|---|---|---|---|
| orderNumber | string(12) | R | Order's number |
| isEnabledResponseMessage | boolean(1) | O | indicator whether the system should respond back to customer or not, default to false |
| shippingDetails | list of shipping details | R | Shipping information details |
Shipping details structure
Maximum number of shipping details for each order is 5
| Field name | Types | Required/Optional | Description |
|---|---|---|---|
| trackingNumber | string(30) | R | Order's tracking number |
| note | string(100) | O | Shipping note for customer |
| carrierName | string(50) | O | Shipping carrier name if carrier name is not provided, system will fall back to customer's selected carrier |
Support carrier name in our system
{
"ALPHAFAST": "Alphafast",
"ARAMEX": "Aramex",
"BEE_EXPRESS": "BEE express",
"BEST_EXPRESS": "BEST express",
"CJ_LOGISTICS": "CJ logistics",
"DHL": "DHL",
"FLASH_EXPRESS": "Flash express",
"INTER_EXPRESS": "Inter express",
"JWD_EXPRESS_CHILLED": "JWD express chilled",
"JWD_EXPRESS_FROZEN": "JWD express frozen",
"J_AND_T": "J&T",
"J_AND_T_DROPOFF": "J&T drop off",
"J_AND_T_PICKUP": "J&T pickup",
"KERRY": "Kerry",
"KERRY_DROPOFF": "Kerry drop off",
"KERRY_PICKUP": "Kerry pickup",
"LALAMOVE": "LALAMOVE",
"NIKO_LOGISTIC": "Niko logistic",
"NINJAVAN": "Ninjavan",
"POPMAN": "Popman",
"SCG_YAMATO_EXPRESS": "SCG yamato express",
"SCG_YAMATO_EXPRESS_CHILLED": "SCG yamato express chilled",
"SCG_YAMATO_EXPRESS_FROZEN": "SCG yamato express frozen",
"THAIPOST_EMS": "Thaipost-EMS",
"THAIPOST_REGISTER": "Thaipost-Register",
"TNT": "TNT",
"TRUE_E_LOGISTICS": "True E logistics",
"ZTO": "ZTO"
}
Example request parameter
{
"shippingInformation": [
{
"orderNumber": "__ORDER__NUMBER__",
"isEnabledResponseMessage": true, // optional
"shippingDetails": [
{
"trackingNumber": "__TRACKING__NUMBER__",
"note": "__NOTE__" // optional,
"carrierName": "__CARRIER_NAME__" // optional
},
{
"trackingNumber": "__TRACKING__NUMBER__",
"note": "__NOTE__", // optional
"carrierName": "__CARRIER_NAME__" // optional
}
]
},
{
"orderNumber": "__ORDER__NUMBER__",
"isEnabledResponseMessage": false, // optional
"shippingDetails": [
{
"trackingNumber": "__TRACKING__NUMBER__",
"note": "__NOTE__", // optional
"carrierName": "__CARRIER_NAME__" // optional
},
{
"trackingNumber": "__TRACKING__NUMBER__",
"note": "__NOTE__" // optional
"carrierName": "__CARRIER_NAME__" // optional
}
]
}
]
}
Example expected response object
200 - OK status code