Getting Shipment Data
This guide walks you through getting shipment data from the JUSDA API.
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/Rates?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 shipments is:
https://services.jusdausa.com/api/v1/Shipments
Shipment URL Parameters
The /Shipments API accepts various filter values in its query string. Paging is also supported. Here are some example API calls with an explanation of how the query will execute.
https://services.jusdausa.com/api/v1/Shipments?shipmentNo=SLAX12345
The above example will retrieve a single shipment that has a ShipmentNo SLAX12345.
https://services.jusdausa.com/api/v1/Shipments?limit=10
The above example will retrieve the 10 most recent shipments.
https://services.jusdausa.com/api/v1/Shipments?limit=10&page=3
Limit specifies the maximum number of rows to return. Page specifies the page number. In this case, the shipments in positions 20-29 will be retrieved.
Get Shipments Query String Paramaters
Use any of the following parameters in your HTTP GET query string to filter your search for existing bookings.
- modifiedDateFrom: (optional) Supports search for shipments created or updated within a date range
- modifiedDateTo: (optional) Supports search for shipments created or updated within a date range
- dataSource: (optional) Shipments for a specific data source. Check with JUSDA for data source names relevant to your account.
- shipmentNo: (optional) Retrieve a specific Shipment Number
- limit: (optional) Default is 100
- page: (optional) Default is 1
- environment: (optional) Test or Production. Default is Production.
Sample Response Payload
[
{
"DataSource": null,
"ShipmentNo": "30312827",
"BillNo": "1Z780V7A03552411323",
"Mode": {
"Code": "ROA",
"Description": "Road Freight"
}
"OuterPackCount": 2,
"OuterPackType": {
"Code": "PCE",
"Description": "Piece"
},
"GrossWeight": 6.3504,
"WeightUnit": "KG",
"Commodity": "NETWORK EQUIPMENT",
"Incoterm": {
"Code": "FOB",
"Description": "Free On Board"
},
"DeliveryTerm": {
"Code": "PP",
"Description": "Prepaid"
},
"EstDeliveryDate": "2020-10-29T00:00:00",
"PodSignature": "PELLETIER",
"ShipmentTransitStatus": {
"Code": "DLV",
"Description": "Delivered"
},
"UpdateDate": "2020-10-22T16:59:07.5764044",
"Parties": [
{
"ShipmentPartyType": {
"Code": "CONSIGNEE",
"Description": "Consignee"
},
"OrganizationIdentifierValue": "CONSIGNEE INC... - SALEM",
"OrganizationIdentifierType": "CODE",
"Name": "CONSIGNEE INC... - SALEM",
"Address1": "23 Northeastern Blvd",
"Address2": "NULL ",
"City": "SALEM",
"StateProvince": "NH",
"PostalCode": "03079",
"Country": "US"
},
{
"ShipmentPartyType": {
"Code": "SHIPPER",
"Description": "Shipper"
},
"OrganizationIdentifierValue": "JUSDA",
"OrganizationIdentifierType": "CODE",
"Name": "SHIPPER INC.",
"Address1": "C/O JUSDA SUPPLY CHAIN MANAGEMENT",
"Address2": "1240 Don Haskins Dr, Suite C, B1 Docks 25-31",
"City": "El Paso",
"StateProvince": "TX",
"PostalCode": "79936",
"Country": "US"
},
{
"ShipmentPartyType": {
"Code": "PROVIDER",
"Description": "Provider"
},
"OrganizationIdentifierValue": "UNITED PARCEL SERVICE, INC",
"OrganizationIdentifierType": "CODE",
"Name": "UNITED PARCEL SERVICE, INC"
}
],
"Locations": [
{
"ShipmentLocationType": {
"Code": "LOADING",
"Description": "Port of Loading"
},
"LocationIdentifierValue": "USELP",
"Description": "EL PASO"
},
{
"ShipmentLocationType": {
"Code": "DISCHARGE",
"Description": "Port of Discharge"
},
"LocationIdentifierValue": "USWKH",
"Description": "Windham"
}
],
"TransportLegs": [
{
"Type": "Main",
"Description": null,
"Mode": {
"Code": "ROA",
"Description": "Road Freight"
},
"Sequence": 1,
"OriginLocation": {
"Type": "UNLOCODE",
"Code": "USELP",
"Description": "El Paso",
"Latitude": 31.75,
"Longitude": -106.483333333,
"GmtOffset": -25200,
"DstOffset": 3600,
"TimeZoneCode": "America/Denver",
"TimeZoneName": "Mountain Daylight Time",
"ScheduleD": "2402",
"ScheduleK": null,
"StateProvinceCode": "TX",
"StateProvinceName": "Texas",
"CountryCode": "US",
"CountryName": "USA"
},
"DestinationLocation": {
"Type": "UNLOCODE",
"Code": "USWKH",
"Description": "Windham",
"Latitude": 42.8,
"Longitude": -71.3,
"GmtOffset": -18000,
"DstOffset": 3600,
"TimeZoneCode": "America/New_York",
"TimeZoneName": "Eastern Daylight Time",
"ScheduleD": null,
"ScheduleK": null,
"StateProvinceCode": "NH",
"StateProvinceName": "New Hampshire",
"CountryCode": "US",
"CountryName": "USA"
}
}
],
"Milestones": [
{
"Description": "Shipment data received",
"EventCode": "JOP",
"LocationDescription": null,
"PlannedDateLocal": null,
"PlannedDateUtc": null,
"ActualDateLocal": "2020-10-22T00:00:00",
"ActualDateUtc": "2020-10-22T00:00:00"
},
{
"Description": "Order Processed: Ready for UPS",
"EventCode": "BKD",
"LocationDescription": "",
"PlannedDateLocal": null,
"PlannedDateUtc": null,
"ActualDateLocal": "2020-10-22T16:22:50",
"ActualDateUtc": "2020-10-22T16:22:50"
},
{
"Description": "Departed from Facility",
"EventCode": "INT",
"LocationDescription": "El Paso, TX ",
"PlannedDateLocal": null,
"PlannedDateUtc": null,
"ActualDateLocal": "2020-10-22T19:44:00",
"ActualDateUtc": "2020-10-23T02:44:00"
},
],
"Charges": [],
"Containers": [],
"Items": [
{
"CommercialInvoiceNo": "3038610",
"PurchaseOrderNo": "5015307",
"PurchaseOrderLineNo": "16",
"PurchaseOrderLineReference": "VECCHI_10022020",
"PalletNo": null,
"CartonNo": null,
"SerialNo": "2025C-W0004",
"ExternalLineReference": null,
"OrderItem": null,
"ProductIdentifier": "XA1480",
"ProductDescription": "Platform 1480",
"HtsNo": "8517.70.0000",
"Quantity": 1,
"UnitValue": null,
"TotalValue": null,
"CurrencyCode": null,
"CountryCode": null,
"ManufacturerIdCode": null,
"CountryOfOrigin": "TW"
},
{
"CommercialInvoiceNo": "3038610",
"PurchaseOrderNo": "5015307",
"PurchaseOrderLineNo": "16",
"PurchaseOrderLineReference": "VECCHI_10022020",
"PalletNo": null,
"CartonNo": null,
"SerialNo": "2025C-W0036",
"ExternalLineReference": null,
"OrderItem": null,
"ProductIdentifier": "XA1480",
"ProductDescription": "Platform 1480",
"HtsNo": "8517.70.0000",
"Quantity": 1,
"UnitValue": null,
"TotalValue": null,
"CurrencyCode": null,
"CountryCode": null,
"ManufacturerIdCode": null,
"CountryOfOrigin": "TW"
}
],
"CustomerReferences": [
{
"ReferenceType": "SO",
"ReferenceValue": "5015307"
},
{
"ReferenceType": "PO",
"ReferenceValue": "VECCHI_10022020"
},
{
"ReferenceType": "DN",
"ReferenceValue": "3038610"
}
]
}
]