GET - Shipment Details (New)
GET Shipment Details
The GET shipment endpoint allows the retrieval of a specific shipment in the 10-4 Freight Portal.
The new GET shipment endpoint requires the shipment unique identifier to be sent in to collect shipment information. The identifiers that can be used are:
1. TenFourLicensePlate
or
2. FreightProviderReferenceNumberThe HTTP Endpoint for shipment retrieval is listed below:
HTTP Verb: GET
URI: {{shipmentUrl}}/v1/shipments/{{shipmentUniqueName}}
Authentication: Bearer TokenSuccess Response:
{
"data": [
{
"createdDate": "2020-10-05T18:02:23+00:00",
"driver": {
"emailAddress": "[email protected]",
"firstName": "Emilio",
"lastName": "Estevez",
"phoneNumber": "+15558675309"
},
"equipmentType": "Container",
"equipmentSize": null,
"lastStatusUpdate": null,
"freightHauler": {
"name": "Regression Trucking",
"identifiers": [
{
"identifier": "214366",
"freightHaulerIdentifierType": "MCNumber"
}
]
},
"haulLength": 2016,
"remainingHaulLength": null,
"haulLinearUnitType": "Kilometers",
"isHazardous": false,
"shareGuid": null,
"shipmentStatus": "InTransit",
"shipmentTrackingType": "None",
"shipmentUniqueName": "CO16UYVL",
"isPriorityShipment": false,
"modeType": "LTL",
"minimumTemperature": 68.2,
"maximumTemperature": 76.6,
"deliveryStatus": "TenderAccepted",
"mobileTrackingNumber": null,
"isMobileTrackingActiveFlag": false,
"tripId": "TESTID2",
"weatherSeverity": null,
"hasTemperatureExceededBoundsFlag": false,
"mobileTrackingStatus": "",
"tractorReferenceNumber": "188",
"trailerReferenceNumber": "9103",
"freightProviderReferenceNumber": "99BC9735",
"currentPosition": null,
"notes": [],
"documents": [],
"deliveryExceptions": [],
"stops": [
{
"appointment": {
"startTime": "2020-10-05T00:15:32-06:00 (America/Denver)",
"endTime": "2020-10-05T00:15:32-06:00 (America/Denver)"
},
"stopSequence": 1,
"stopType": "Origin",
"description": "Visibility",
"fixedLocationCode": null,
"name": "10-4 Systems",
"stopReference": "1",
"contact": {
"name": "Good Buddy",
"phoneNumber": "+11234567891",
"phoneExtension": "887",
"faxNumber": "+10198765432",
"emailAddress": null
},
"address": {
"streetAddress1": "4888 Pearl E Cir",
"streetAddress2": "300W",
"city": "Boulder",
"state": "CO",
"postalCode": "80301",
"countryCode": "US"
},
"latitude": 40.0211,
"longitude": -105.2388,
"hasStopBeenVisited": false,
"isActiveStop": false,
"isDropTrailer": null,
"dwellTimeMinutes": 50,
"deliveryStatus": "TenderAccepted",
"polygonGeofenceIn": null,
"polygonGeofenceOut": null,
"geofenceRadiusInFeet": 2640,
"geofenceOutRadiusInFeet": 3960,
"scheduledStartDateTime": "2020-10-05T00:00:00-06:00 (America/Denver)",
"scheduledEndDateTime": "2020-10-05T00:00:00-06:00 (America/Denver)",
"actualArrivalDateTime": null,
"actualDepartureDateTime": null,
"estimatedDeliveryDateTime": null,
"geofenceArrivalDateTime": null,
"geofenceDepartureDateTime": null,
"carrierDepartureDateTime": null,
"carrierArrivalDateTime": null,
"stopNotes": []
},
{
"appointment": null,
"stopSequence": 2,
"stopType": "Intermediate",
"description": "FL1288_Updated",
"fixedLocationCode": "FL1288",
"name": "Trimble",
"stopReference": "2",
"contact": {
"name": "Bryn Fosburgh",
"phoneNumber": "+13821194829",
"phoneExtension": "127",
"faxNumber": "+11124492283",
"emailAddress": null
},
"address": {
"streetAddress1": "4888 Pearl East Circle",
"streetAddress2": null,
"city": "Boulder",
"state": "CO",
"postalCode": "80301",
"countryCode": "US"
},
"latitude": 40.021,
"longitude": -105.239,
"hasStopBeenVisited": false,
"isActiveStop": false,
"isDropTrailer": null,
"dwellTimeMinutes": 10,
"deliveryStatus": "TenderAccepted",
"polygonGeofenceIn": null,
"polygonGeofenceOut": null,
"geofenceRadiusInFeet": 475,
"geofenceOutRadiusInFeet": 712,
"scheduledStartDateTime": "2020-10-05T00:00:00-06:00 (America/Denver)",
"scheduledEndDateTime": "2020-10-05T00:00:00-06:00 (America/Denver)",
"actualArrivalDateTime": null,
"actualDepartureDateTime": null,
"estimatedDeliveryDateTime": null,
"geofenceArrivalDateTime": null,
"geofenceDepartureDateTime": null,
"carrierDepartureDateTime": null,
"carrierArrivalDateTime": null,
"stopNotes": []
},
{
"appointment": {
"startTime": "2020-10-05T11:12:30-07:00 (America/Los_Angeles)",
"endTime": "2020-10-05T11:12:30-07:00 (America/Los_Angeles)"
},
"stopSequence": 3,
"stopType": "Destination",
"description": "Mothership",
"fixedLocationCode": null,
"name": "Trimble HQ",
"stopReference": "3",
"contact": {
"name": "Wyatt Hello",
"phoneNumber": "+15553291185",
"phoneExtension": "183",
"faxNumber": "+19402742273",
"emailAddress": null
},
"address": {
"streetAddress1": "935 Stewart Drive",
"streetAddress2": null,
"city": "Sunnyvale",
"state": "CA",
"postalCode": "94085",
"countryCode": "US"
},
"latitude": 37.384,
"longitude": -122.0052,
"hasStopBeenVisited": false,
"isActiveStop": false,
"isDropTrailer": null,
"dwellTimeMinutes": 30,
"deliveryStatus": "TenderAccepted",
"polygonGeofenceIn": null,
"polygonGeofenceOut": null,
"geofenceRadiusInFeet": 2640,
"geofenceOutRadiusInFeet": 3960,
"scheduledStartDateTime": "2020-10-05T11:59:59-07:00 (America/Los_Angeles)",
"scheduledEndDateTime": "2020-10-05T11:59:59-07:00 (America/Los_Angeles)",
"actualArrivalDateTime": null,
"actualDepartureDateTime": null,
"estimatedDeliveryDateTime": null,
"geofenceArrivalDateTime": null,
"geofenceDepartureDateTime": null,
"carrierDepartureDateTime": null,
"carrierArrivalDateTime": null,
"stopNotes": []
}
],
"referenceNumbers": [
{
"referenceNumberType": "TrailerNumber",
"referenceNumber": "9103"
},
{
"referenceNumberType": "TractorNumber",
"referenceNumber": "188"
},
{
"referenceNumberType": "FreightProviderReferenceNumber",
"referenceNumber": "99BC9735"
}
],
"orders": [
{
"orderNumber": "JUSTANORDERNARYORDER1",
"pickupStopReference": "1",
"deliveryStopReference": "3",
"customerReference": "APICUSTOMERGUYORGAL",
"customerName": "Jonesy",
"commodities": [
{
"orderCommodityGuid": "d632ca03-28e5-43f1-a8c1-17e15aaf09be",
"commodityName": "Commodian",
"pieceDescription": ".14ISPIECEOFPI",
"pieceCount": 8,
"pieceUnit": "Each",
"weightAmount": 11644,
"weightUnit": "Pounds",
"length": 12,
"width": 29,
"height": 32,
"linearUnit": "Feet",
"volume": 313,
"volumeUnit": "Gallons",
"isHazardous": false,
"unNumber": null,
"isStackable": true,
"purchaseOrderNumber": "10-4Av2",
"productLine": "DOUBLE VISION",
"productBrand": "VISIBILITY ALE",
"allowDeliveredQuantity": false,
"deliveredPieceCount": null
}
],
"exception": null
}
],
"shipmentMilestones": [],
"totalShipmentAndOrderExceptions": 0
}
],
"messages": [],
"totalPossibleCount": 0
}Updated about 2 months ago