Getting Parcel Tracking Results
This guide walks you through getting parcel tracking results from previously created requests.
Authentication
JUSDA uses API keys for authentication. At this time API keys are assigned by JUSDA's Technology Team. To obtain a key, contact your JUSDA Sales representative.
Once you have an API key, to authenticate, it will be necessary to pass the key in the HTTP header of each call you make. For the header key pass x-api-key. Pass your key as the value. For example:
x-api-key=34A81032-979E-4EFC-9A6F-87E2973F3E20
If there is any problem authenticating your key, the API will respond with an HTTP 401 code.
Testing
JUSDA may provide you an API key that is set to our test environment. If instead you have a production API key, it's possible to use the test environment on any API call by including an environment attribute in the endpoint's query string. For example:
https://services.jusdausa.com/api/v1/Tracking?environment=Test
API Endpoint
The URL for JUSDA APIs is:
https://services.jusdausa.com/api/v1
To this endpoint add the resource you are accessing. For example, the endpoint to get Last Mile Requests is:
https://services.jusdausa.com/api/v1/Tracking
Tracking URL Parameters
The GET Tracking API accepts various filter values in its query string. Here are some example API calls with an explanation of how the query will execute.
https://services.jusdausa.com/api/v1/Tracking/1Z593Y5F0323271851
The above example will retrieve the tracking results for tracking number 1Z593Y5F0323271851.
https://services.jusdausa.com/api/v1/Tracking
The above example will retrieve all tracking requests for the account.
Tracking Request Query String Parameters
Use any of the following parameters in your HTTP GET query string to filter your search for existing Tracking requests.
- trackingNo: (optional) Retrieve a specific Tracking number
Sample Response Payload
{
"trackingNo": "1Z593Y5F0323271851",
"trackingType": "WAYBILL",
"carrier": null,
"mode": "Courier",
"serviceLevel": null,
"requestStatus": null,
"requestDate": "2021-01-21T23:54:09.1916067Z",
"trackingStatus": "Delivered",
"trackingStatusDate": null,
"pickupDate": null,
"deliveryDate": null,
"podSignatureName": null,
"orders": [
{
"orderNo": "TEST"
}
],
"milestones": [
{
"eventCode": "DLV",
"eventDescription": "Delivered",
"eventDateLocal": "2021-01-12T16:27:00",
"location": "PORTER RANCH, CA 91326"
},
{
"eventCode": "INT",
"eventDescription": "Out For Delivery Today",
"eventDateLocal": "2021-01-12T09:42:00",
"location": "Van Nuys, CA "
},
{
"eventCode": "INT",
"eventDescription": "Processing at UPS Facility",
"eventDateLocal": "2021-01-12T05:45:00",
"location": "Van Nuys, CA "
},
{
"eventCode": "INT",
"eventDescription": "Arrived at Facility",
"eventDateLocal": "2021-01-12T01:27:00",
"location": "Van Nuys, CA "
},
{
"eventCode": "INT",
"eventDescription": "Departed from Facility",
"eventDateLocal": "2021-01-12T00:32:00",
"location": "La Mirada, CA "
},
{
"eventCode": "INT",
"eventDescription": "Origin Scan",
"eventDateLocal": "2021-01-11T18:54:00",
"location": "La Mirada, CA "
},
{
"eventCode": "INT",
"eventDescription": "Drop-Off",
"eventDateLocal": "2021-01-11T12:05:00",
"location": "La Mirada, CA "
},
{
"eventCode": "INT",
"eventDescription": "Shipper created a label, UPS has not received the package yet.",
"eventDateLocal": "2021-01-10T23:38:00",
"location": ", "
}
]
}
API Documentation
For more details about the Last Mile API endpoint, see JUSDA's API Documentation.