GET - Shipments by Trip ID
GET Shipments by Trip ID
The GET trip endpoint allows users to send in a trip ID and get back a list of shipments that share the trip ID that was passed in on the GET request.
The HTTP Endpoint for shipment retrieval by trip ID is listed below:
HTTP Verb: GET
URI: /v1/trips/{{tripID}}
Authentication: Bearer TokenSuccess Response:
{
"data": [
{
"tripId": "ExampleTripID1",
"activeShipmentUniqueName": "CO6CF7E5",
"tripStatus": "InTransit",
"shipments": [
{
"createdDate": "2021-03-09T18:25:09+00:00",
"driver": null,
"equipmentType": null,
"equipmentSize": null,
"lastStatusUpdate": null,
"freightHauler": {
"name": "Regression Trucking",
"identifiers": [
{
"identifier": "214366",
"freightHaulerIdentifierType": "MCNumber"
}
]
},
"haulLength": 1260,
"remainingHaulLength": null,
"haulLinearUnitType": "Miles",
"isHazardous": false,
"shareGuid": null,
"shipmentStatus": "InTransit",
"shipmentTrackingType": "None",
"shipmentUniqueName": "CO6CF7E5",
"isPriorityShipment": false,
"modeType": "Truckload",
"minimumTemperature": null,
"maximumTemperature": null,
"deliveryStatus": "TenderAccepted",
"mobileTrackingNumber": null,
"isMobileTrackingActiveFlag": false,
"tripId": "ExampleTripID1",
"weatherSeverity": "Moderate",
"hasTemperatureExceededBoundsFlag": false,
"mobileTrackingStatus": "",
"tractorReferenceNumber": null,
"trailerReferenceNumber": null,
"freightProviderReferenceNumber": "1",
"currentPosition": null,
"notes": [],
"documents": [],
"deliveryExceptions": [],
"stops": [
{
"appointment": null,
"stopSequence": 1,
"stopType": "Origin",
"description": null,
"fixedLocationCode": null,
"name": null,
"stopReference": "Stop1",
"contact": {
"name": null,
"phoneNumber": null,
"phoneExtension": null,
"faxNumber": null,
"emailAddress": null
},
"address": {
"streetAddress1": "4888 Pearl East Cir",
"streetAddress2": null,
"city": "Boulder",
"state": "CO",
"postalCode": "80301",
"countryCode": "US"
},
"latitude": 40.0211,
"longitude": -105.2388,
"hasStopBeenVisited": false,
"isActiveStop": true,
"isDropTrailer": null,
"dwellTimeMinutes": 120,
"deliveryStatus": "TenderAccepted",
"polygonGeofenceIn": null,
"polygonGeofenceOut": null,
"geofenceRadiusInFeet": 2640,
"geofenceOutRadiusInFeet": 3960,
"scheduledStartDateTime": "2018-11-12T00:00:00-07:00 (America/Denver)",
"scheduledEndDateTime": "2018-11-12T00:00:00-07:00 (America/Denver)",
"actualArrivalDateTime": null,
"actualDepartureDateTime": null,
"estimatedDeliveryDateTime": null,
"geofenceArrivalDateTime": null,
"geofenceDepartureDateTime": null,
"carrierDepartureDateTime": null,
"carrierArrivalDateTime": null,
"stopNotes": []
},
{
"appointment": null,
"stopSequence": 2,
"stopType": "Destination",
"description": null,
"fixedLocationCode": null,
"name": null,
"stopReference": "Stop2",
"contact": {
"name": null,
"phoneNumber": null,
"phoneExtension": null,
"faxNumber": null,
"emailAddress": null
},
"address": {
"streetAddress1": " 935 Stewart Dr",
"streetAddress2": null,
"city": "Sunnyvale",
"state": "CA",
"postalCode": "94085",
"countryCode": "US"
},
"latitude": 37.384,
"longitude": -122.0052,
"hasStopBeenVisited": false,
"isActiveStop": false,
"isDropTrailer": null,
"dwellTimeMinutes": 120,
"deliveryStatus": "TenderAccepted",
"polygonGeofenceIn": null,
"polygonGeofenceOut": null,
"geofenceRadiusInFeet": 2640,
"geofenceOutRadiusInFeet": 3960,
"scheduledStartDateTime": "2018-12-12T11:59:59-08:00 (America/Los_Angeles)",
"scheduledEndDateTime": "2018-12-12T11:59:59-08:00 (America/Los_Angeles)",
"actualArrivalDateTime": null,
"actualDepartureDateTime": null,
"estimatedDeliveryDateTime": null,
"geofenceArrivalDateTime": null,
"geofenceDepartureDateTime": null,
"carrierDepartureDateTime": null,
"carrierArrivalDateTime": null,
"stopNotes": []
}
],
"referenceNumbers": [
{
"referenceNumberType": "FreightProviderReferenceNumber",
"referenceNumber": "1"
}
],
"orders": [],
"shipmentMilestones": [],
"totalShipmentAndOrderExceptions": 0
},
{
"createdDate": "2021-03-09T18:40:40+00:00",
"driver": null,
"equipmentType": null,
"equipmentSize": null,
"lastStatusUpdate": null,
"freightHauler": {
"name": "Regression Trucking",
"identifiers": [
{
"identifier": "214366",
"freightHaulerIdentifierType": "MCNumber"
}
]
},
"haulLength": 1260,
"remainingHaulLength": null,
"haulLinearUnitType": "Miles",
"isHazardous": false,
"shareGuid": null,
"shipmentStatus": "InTransit",
"shipmentTrackingType": "None",
"shipmentUniqueName": "CO82G9FG",
"isPriorityShipment": false,
"modeType": "Truckload",
"minimumTemperature": null,
"maximumTemperature": null,
"deliveryStatus": "TenderAccepted",
"mobileTrackingNumber": null,
"isMobileTrackingActiveFlag": false,
"tripId": "ExampleTripID1",
"weatherSeverity": "Moderate",
"hasTemperatureExceededBoundsFlag": false,
"mobileTrackingStatus": "",
"tractorReferenceNumber": null,
"trailerReferenceNumber": null,
"freightProviderReferenceNumber": "13333",
"currentPosition": null,
"notes": [],
"documents": [],
"deliveryExceptions": [],
"stops": [
{
"appointment": null,
"stopSequence": 1,
"stopType": "Origin",
"description": null,
"fixedLocationCode": null,
"name": null,
"stopReference": "Stop1",
"contact": {
"name": null,
"phoneNumber": null,
"phoneExtension": null,
"faxNumber": null,
"emailAddress": null
},
"address": {
"streetAddress1": "4888 Pearl East Cir",
"streetAddress2": null,
"city": "Boulder",
"state": "CO",
"postalCode": "80301",
"countryCode": "US"
},
"latitude": 40.0211,
"longitude": -105.2388,
"hasStopBeenVisited": false,
"isActiveStop": true,
"isDropTrailer": null,
"dwellTimeMinutes": 120,
"deliveryStatus": "TenderAccepted",
"polygonGeofenceIn": null,
"polygonGeofenceOut": null,
"geofenceRadiusInFeet": 2640,
"geofenceOutRadiusInFeet": 3960,
"scheduledStartDateTime": "2019-11-12T00:00:00-07:00 (America/Denver)",
"scheduledEndDateTime": "2019-11-12T00:00:00-07:00 (America/Denver)",
"actualArrivalDateTime": null,
"actualDepartureDateTime": null,
"estimatedDeliveryDateTime": null,
"geofenceArrivalDateTime": null,
"geofenceDepartureDateTime": null,
"carrierDepartureDateTime": null,
"carrierArrivalDateTime": null,
"stopNotes": []
},
{
"appointment": null,
"stopSequence": 2,
"stopType": "Destination",
"description": null,
"fixedLocationCode": null,
"name": null,
"stopReference": "Stop2",
"contact": {
"name": null,
"phoneNumber": null,
"phoneExtension": null,
"faxNumber": null,
"emailAddress": null
},
"address": {
"streetAddress1": " 935 Stewart Dr",
"streetAddress2": null,
"city": "Sunnyvale",
"state": "CA",
"postalCode": "94085",
"countryCode": "US"
},
"latitude": 37.384,
"longitude": -122.0052,
"hasStopBeenVisited": false,
"isActiveStop": false,
"isDropTrailer": null,
"dwellTimeMinutes": 120,
"deliveryStatus": "TenderAccepted",
"polygonGeofenceIn": null,
"polygonGeofenceOut": null,
"geofenceRadiusInFeet": 2640,
"geofenceOutRadiusInFeet": 3960,
"scheduledStartDateTime": "2018-12-12T11:59:59-08:00 (America/Los_Angeles)",
"scheduledEndDateTime": "2018-12-12T11:59:59-08:00 (America/Los_Angeles)",
"actualArrivalDateTime": null,
"actualDepartureDateTime": null,
"estimatedDeliveryDateTime": null,
"geofenceArrivalDateTime": null,
"geofenceDepartureDateTime": null,
"carrierDepartureDateTime": null,
"carrierArrivalDateTime": null,
"stopNotes": []
}
],
"referenceNumbers": [
{
"referenceNumberType": "FreightProviderReferenceNumber",
"referenceNumber": "13333"
}
],
"orders": [],
"shipmentMilestones": [],
"totalShipmentAndOrderExceptions": 0
}
],
"tripOriginStop": {
"appointment": null,
"stopSequence": 1,
"stopType": "Origin",
"description": null,
"fixedLocationCode": null,
"name": null,
"stopReference": "Stop1",
"contact": {
"name": null,
"phoneNumber": null,
"phoneExtension": null,
"faxNumber": null,
"emailAddress": null
},
"address": {
"streetAddress1": "4888 Pearl East Cir",
"streetAddress2": null,
"city": "Boulder",
"state": "CO",
"postalCode": "80301",
"countryCode": "US"
},
"latitude": 40.0211,
"longitude": -105.2388,
"hasStopBeenVisited": false,
"isActiveStop": true,
"isDropTrailer": null,
"dwellTimeMinutes": 120,
"deliveryStatus": "TenderAccepted",
"polygonGeofenceIn": null,
"polygonGeofenceOut": null,
"geofenceRadiusInFeet": 2640,
"geofenceOutRadiusInFeet": 3960,
"scheduledStartDateTime": "2018-11-12T00:00:00-07:00 (America/Denver)",
"scheduledEndDateTime": "2018-11-12T00:00:00-07:00 (America/Denver)",
"actualArrivalDateTime": null,
"actualDepartureDateTime": null,
"estimatedDeliveryDateTime": null,
"geofenceArrivalDateTime": null,
"geofenceDepartureDateTime": null,
"carrierDepartureDateTime": null,
"carrierArrivalDateTime": null,
"stopNotes": []
},
"tripDestinationStop": {
"appointment": null,
"stopSequence": 2,
"stopType": "Destination",
"description": null,
"fixedLocationCode": null,
"name": null,
"stopReference": "Stop2",
"contact": {
"name": null,
"phoneNumber": null,
"phoneExtension": null,
"faxNumber": null,
"emailAddress": null
},
"address": {
"streetAddress1": " 935 Stewart Dr",
"streetAddress2": null,
"city": "Sunnyvale",
"state": "CA",
"postalCode": "94085",
"countryCode": "US"
},
"latitude": 37.384,
"longitude": -122.0052,
"hasStopBeenVisited": false,
"isActiveStop": false,
"isDropTrailer": null,
"dwellTimeMinutes": 120,
"deliveryStatus": "TenderAccepted",
"polygonGeofenceIn": null,
"polygonGeofenceOut": null,
"geofenceRadiusInFeet": 2640,
"geofenceOutRadiusInFeet": 3960,
"scheduledStartDateTime": "2018-12-12T11:59:59-08:00 (America/Los_Angeles)",
"scheduledEndDateTime": "2018-12-12T11:59:59-08:00 (America/Los_Angeles)",
"actualArrivalDateTime": null,
"actualDepartureDateTime": null,
"estimatedDeliveryDateTime": null,
"geofenceArrivalDateTime": null,
"geofenceDepartureDateTime": null,
"carrierDepartureDateTime": null,
"carrierArrivalDateTime": null,
"stopNotes": []
},
"tripMostRecentPositionEvent": null
}
],
"messages": [],
"totalPossibleCount": 0
}Updated about 2 months ago