Update order's tracking number by order number
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 shipping
Endpoint
/v1/orders/:orderNumber/tracking-number
Resource method
PATCH
Parameters
URL parameter
| Field name | Types | Required/Optional | Description |
|---|---|---|---|
| orderNumber | string(12) | R | Order's number |
Body parameters
| Field name | Types | Required/Optional | Description |
|---|---|---|---|
| trackingNumber | string(30) | R | Order's tracking number |
| note | string(100) | O | Shipping note for customer |
| isEnabledResponseMessage | boolean(1) | O | indicator whether the system should respond back to customer or not, default to false |
Example request parameter
{
"trackingNumber": "TN1234",
"isEnabledResponseMessage": false
}
Example expected response object
200 - OK status code