Creating Parcel Tracking Requests

This guide walks you through creating parcel tracking requests. Currently UPS and Fedex are supported. If the shipment is already in transit, and completed milestones will be displayed. After the tracking request is created, you can pull the latest status using GET /Tracking endpoint

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.

API Endpoint

The URL for JUSDA Parcel Tracking APIs is:

https://services.jusdausa.com/api/v1/Tracking

Use an HTTP POST with the approprate payload as described below.

Post Tracking Request Payload

Craft a JSON payload as shown below. Note that this endpoint expects an array of one or more bookings to be provided. Key properties of the payload:

  • trackingNo: (required) The carrier's tracking number
  • trackingType: (required) Use WAYBILL for parcel tracking
  • carrier: (required) Carrier name. Currently FedEx and UPS are supported
  • orders: (optional) An array of Order Numbers can be provided which relate to this shipment.

Sample Request


            {
                "trackingNo": "1Z593Y5F0323271851",
                "trackingType": "WAYBILL",
                "carrier" : "UPS",
                "orders": [
                    {
                        "OrderNo": "TEST"
                    }
                ]
            }
            

Post Tracking Payload Response

The response payload confirms request information and provides a uniqueId for tracking.

Sample Response


            {
                "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 Tracking API endpoint, see JUSDA's API Documentation.