GET Shipping Status Tracking (eMetro)
https://api.ewe.com.au/oms/api/tracking/ewe/Tracking Number
You can use EWE Tracking API to track the shipping status for eMetro orders.
Request
1.1 Tracking with GET method (Ad-hoc tracking)
The following is an example of request URL:
/oms/api/tracking/ewe/TrackingNumber1,TrackingNumber2,TrackingNumber3?IsDetailed=true
URL base is: https://api.ewe.com.au
· The URL can be access via Http Get method.
Required parameters: Tracking number(s).
· Use comma to separate multiple numbers.
Optional parameter: IsDetailed
· This field controls whether detailed tracking messages of each checkpoint for every package is returned. The default value is true when not specified.
· When set to false, The EweTrackingDetail property of EweTrackingInfo will be null. If only meta information such as delivery status and Id Card presence is wanted for a great number of packages but no checkpoint tracking is needed, specifying IsDetailed=false can reduce network traffic, resulting in much quicker response.
1.2 Tracking with POST method (Batch tracking)
If querying a great number of packages is wanted, we suggest using batch tracking method instead of ad-hoc tracking. See 1.3 Performance hint for detail.
URL: /oms/api/tracking/ewepost
· This URL is to be requested with HTTP POST method.
Required parameters: querystring, consisting of comma separated tracking numbers.
Optional parameter: IsDetailed
Use JSON format to construct the two parameters. Example:
{"querystring":"E000000696E,E000000697E,E000000698E,E000000699E,E0000007 00E,E000000701E","IsDetailed":"false"}
1.3 Performance hint
Different of the two methods: GET method can be used by a simple request issued by browser. However, it might be subjected to the limit of length of the URL, thus a limited number of tracking number per request. It could be used to track a few packages at a time by web clients.
POST method has no such limit as mentioned above. However, 200-500 packages per request is recommended to assure quick response. And please refrain from frequent large query. A reasonable interval between two large requests is 3-5 seconds or the time it took to finish the first interval, whichever is larger
Response
The interface returns a type EweApiResult
· Package meta information: EweTrackingInfo
| Attribute | Meaning | Description |
|---|---|---|
| IsInput | Order information received | Via API (for e-Business partners) or by data entry personnel (for hand written waybill) |
| IdPresent | Whether Id information exists | Value is true if Id is uploaded |
| IsReceived | Package is received at warehouse | Package is received at warehouse. Driver’s pick-up scan is irrelevant |
| EweNo | Ewe waybill number | |
| TransferNo | Courier tracking number when delivering inside China | |
| Departure | Departure from | Departure city |
| Destination | Delivery to | Destination province and city |
| CreateDate | Order creation date | |
| TransferName | Courier name whom the package is transferred to | |
| TransferRoute | Port of entry or name of customs broker | |
| LastInfo | Last checkpoint | The most recent tracking message |
| DeliveryStatusCn | Chinese description of delivery status | |
| DeliveryStatus | Delivery status code in integer | 0: Not yet sent out; 1: Sent out from EWE Depot; 2: Transferring in China; 3: Delivered |
| EweTrackingDetail | Object of type EweTrackingDetail | See the following table |
| DateString | Date / Time | |
| Place | Place of checkpoint | |
| Message | Message of tracking | |
| PositionCode | Integer. Not continuous but chronologically ascending indicating the order in which checkpoint is reached |
· Detailed checkpoint information: EweTrackingDetail, property of EweTrackingInfo
Successful Response Example
{
"Payload": [
{
"BoxNo": null,
"IsInput": false,
"IdPresent": false,
"IsReceived": false,
"EweNo": "EMA0000000001",
"TransferNo": "",
"Departure": "Greenacre NSW",
"Destination": "SCHOFIELDS NSW 2762",
"CreateDate": "2023-05-05T14:20:08.997",
"DeliveryDate": null,
"ReceiveDate": null,
"TransferName": "",
"TransferRoute": "EWE全球快递",
"LastInfo": "Delivered",
"DeliveryStatusCn": "Delivered",
"DeliveryStatus": 3,
"Details": [
{
"DateString": "2023-05-05 14:16",
"Place": "Sydney NSW Australia",
"Message": "Package processed at warehouse",
"PositionCode": 1
},
{
"DateString": "2023-05-08 10:44",
"Place": "Sydney NSW Australia",
"Message": "Onboard for delivery",
"PositionCode": 3
},
{
"DateString": "2023-05-08 22:32",
"Place": "Sydney NSW Australia",
"Message": "Delivered",
"PositionCode": 5
}
],
"Modified": false,
"InPipeline": false,
"Reminder": "Delivered",
"Reference": null,
"ArticleCount": 0
}
],
"Total": 1,
"Status": 0,
"Message": "",
"Error": ""
}