Tracking
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v202206/trackings | Retrieves a list of trackings |
Header
| Key | Value |
|---|---|
| Authorization | Bearer eyJ0eXAiOiJKV1QiLCJhbGciOi ... |
GET /api/v202105/Trackings
Request
Params
| Type | Name | Description | Required/Optional | Schema |
|---|---|---|---|---|
| query | api | The API type Available Values: index.by-default | required | enum |
| query | next_token | The next page data | optional | string |
| body | tracking_numbers | Tracking Number list； | required | array |
Body Demo
{
"tracking_numbers": [ "UUXXXXXXXX1","UUXXXXXXXX2"]
}Response
| Key | Value |
|---|---|
| errcode | 0/4000 |
| errmsg | ok/Error Info |
| data | Data Properties |
Data Properties
| Name | Description | |
|---|---|---|
| tracking_number | Tracking number | string |
| platform_order_id | Platform Order Number | string |
| customer_order_id | Customer Order Number | string |
| trx_id | Shipsage Transaction ID | string |
| carrier | Transport company | string |
| service_type_name | Carrier service type name | string |
| latest_status | Latest tracking status | string |
| latest_event_time | Latest event time timezone:PST | datetime |
| latest_event_time_iso | Latest event time local time | datetime |
| latest_event_time_utc | Latest event time timezone:UTC | datetime |
| latest_event_description | Latest event description | string |
| final_scan_time | Warehouse final scan time timezone:PST | datetime |
| origin_scan_time | Carrier pick up time timezone:PST | datetime |
| delivered_time | Delivered time timezone:PST | datetime |
| ship_to_name | The recipient's name | string |
| ship_to_address1 | The recipient's address one | string |
| ship_to_address2 | The recipient's name address two | string |
| ship_to_phone | The recipient's phone | string |
| ship_to_city | The recipient's address city | string |
| ship_to_state | The recipient's address state | string |
| ship_to_country | The recipient's address country | string |
| ship_to_postal_code | The recipient's address postal code | string |
| milestone | Milestone | array |
| milestone.*.event_time | Event time timezone:PST | datetime |
| milestone.*.event_time_iso | Event time local time | datetime |
| milestone.*.event_time_utc | Event time timezone:UTC | datetime |
| milestone.*.description | Event description | string |
| milestone.*.location | Event location | string |
| milestone.*.stage | Event stage | string |
| milestone.*.sub_status | Event sub status | string |
| milestone.*.country | Event country | string |
| milestone.*.state | Event state | string |
| milestone.*.city | Event city | string |
| milestone.*.street | Event street | string |
| postal_code | Event post code | integer |
Data Demo
{
"errcode": 0,
"errmsg": "ok",
"data": [
{
"tracking_number": "UUXXXXXXXX1",
"platform_order_id": "XXXXXXX",
"customer_order_id": "XXXXXXX",
"trx_id": "e28de150-bbde-480d-b1e5-67070907b50d1729568339403",
"carrier": "FedEx",
"service_type_name": "GROUND_HOME_DELIVERY",
"latest_status": "Delivered",
"latest_event_time": "2024-06-17 10:36:04",
"latest_event_time_iso": "2024-06-17 13:36:04",
"latest_event_time_utc": "2024-06-17 17:36:04",
"latest_event_description": "Delivered, Left at front door. Signature Service not requested.",
"final_scan_time": "2024-06-16 04:25:02",
"origin_scan_time": "2024-06-16 00:00:00",
"delivered_time": "2024-06-17 13:36:04",
"ship_to_name": "XXX",
"ship_to_address1": "XXX",
"ship_to_address2": null,
"ship_to_phone": "16026716610",
"ship_to_city": "BAKERSFIELD",
"ship_to_state": "CA",
"ship_to_country": "US",
"ship_to_postal_code": "10000",
"milestone": [
{
"event_time": "2024-06-15 21:00:00",
"event_time_iso": "2024-06-16 00:00:00",
"event_time_utc": "2024-06-16 04:00:00",
"description": "Picked up",
"location": "US, PA, NORTHAMPTON",
"stage": "PickedUp",
"sub_status": "InTransit_PickedUp",
"country": "US",
"state": "PA",
"city": "NORTHAMPTON",
"street": "",
"postal_code": 1000
},
{
"event_time": "2024-06-15 21:10:00",
"event_time_iso": "2024-06-16 00:10:00",
"event_time_utc": "2024-06-16 04:10:00",
"description": "Shipment information sent to FedEx",
"location": "US, PA, NORTHAMPTON",
"stage": "InfoReceived",
"sub_status": "InfoReceived",
"country": "US",
"state": "PA",
"city": "NORTHAMPTON",
"street": "",
"postal_code": 1000
},
{
"event_time": "2024-06-16 14:53:00",
"event_time_iso": "2024-06-16 17:53:00",
"event_time_utc": "2024-06-16 21:53:00",
"description": "Arrived at FedEx location",
"location": "US, PA, NORTHAMPTON",
"stage": "",
"sub_status": "InTransit_Other",
"country": "US",
"state": "PA",
"city": "NORTHAMPTON",
"street": "",
"postal_code": 1000
},
{
"event_time": "2024-06-16 22:57:52",
"event_time_iso": "2024-06-17 01:57:52",
"event_time_utc": "2024-06-17 05:57:52",
"description": "Left FedEx origin facility",
"location": "US, PA, NORTHAMPTON",
"stage": "",
"sub_status": "InTransit_Other",
"country": "US",
"state": "PA",
"city": "NORTHAMPTON",
"street": "",
"postal_code": 1000
},
{
"event_time": "2024-06-17 01:35:00",
"event_time_iso": "2024-06-17 04:35:00",
"event_time_utc": "2024-06-17 08:35:00",
"description": "At local FedEx facility",
"location": "US, PA, READING",
"stage": "",
"sub_status": "InTransit_Other",
"country": "US",
"state": "PA",
"city": "READING",
"street": "",
"postal_code": 1001
},
{
"event_time": "2024-06-17 01:48:00",
"event_time_iso": "2024-06-17 04:48:00",
"event_time_utc": "2024-06-17 08:48:00",
"description": "On FedEx vehicle for delivery",
"location": "US, PA, READING",
"stage": "OutForDelivery",
"sub_status": "OutForDelivery_Other",
"country": "US",
"state": "PA",
"city": "READING",
"street": "",
"postal_code": 1001
},
{
"event_time": "2024-06-17 10:36:04",
"event_time_iso": "2024-06-17 13:36:04",
"event_time_utc": "2024-06-17 17:36:04",
"description": "Delivered, Left at front door. Signature Service not requested.",
"location": "US, PA, Elverson",
"stage": "Delivered",
"sub_status": "Delivered_Other",
"country": "US",
"state": "PA",
"city": "Elverson",
"street": "",
"postal_code": 1001
}
]
}
]
}Modified at 2026-08-13 00:43:51