GET Shipment Details

The GET shipment endpoint allows the retrieval of a specific shipment in the 10-4 Freight Portal.

The GET shipment endpoint has multiple parameter values that can be used as the shipmentReference. These values can be found below:

1. TenFourLicensePlate
2. FreightProviderReferenceNumbers

The HTTP Endpoint for shipment retrieval is listed below:

HTTP Verb: GET
URI: /atlas/frexapi/shipment/{shipmentReference}
Authentication: Basic Auth or Bearer Token

Success Response:

{
    "Stops": [
        {
            "Appointment": {
                "AppointmentType": 1,
                "AppointmentDatePart": "2018-08-11T00:00:00",
                "AppointmentStartTimePart": "00:15:32",
                "AppointmentEndDatePart": "2018-08-11T00:00:00",
                "AppointmentEndTimePart": "17:31:42"
            },
            "StopSequence": 1,
            "StopType": 1,
            "StopDescription": "Visibility",
            "StopScheduledDatePart": "2018-08-11T00:00:00",
            "StopScheduledStartTimePart": null,
            "StopScheduledEndTimePart": null,
            "StopActualArrival": null,
            "StopActualDeparture": null,
            "EstimatedDeliveryDate": null,
            "IsCarrierEtaOverride": false,
            "DeliveryStatus": 0,
            "DeliveryStatusDescription": null,
            "LocationCode": null,
            "StopName": "10-4 Systems",
            "StopReference": "1",
            "StopContactName": "Good Buddy",
            "StopContactPhoneNumber": "+11234567891",
            "StopContactEmailAddress": "[email protected]",
            "StopContactFaxNumber": "+10198765432",
            "StopContactPhoneExtension": "887",
            "StreetAddress1": "4888 Pearl E Cir",
            "StreetAddress2": "300W",
            "City": "Boulder",
            "State": "CO",
            "PostalCode": "80301",
            "Country": "US",
            "Latitude": 50.1234,
            "Longitude": -45.1234,
            "IsActiveStop": true,
            "Shared": true,
            "SharedShipmentGuid": null,
            "ShareUrl": "https://cloud.10-4.com/FreightPortal/SharedShipmentStop/11caa1ee-d790-4ce4-956c-d979e3b53718",
            "IsDropTrailer": null,
            "DwellTime": null,
            "ShipmentStopNote": [],
            "ShipmentNoteCreationType": 0
        },
        {
            "Appointment": {
                "AppointmentType": 0,
                "AppointmentDatePart": null,
                "AppointmentStartTimePart": null,
                "AppointmentEndDatePart": null,
                "AppointmentEndTimePart": null
            },
            "StopSequence": 2,
            "StopType": 2,
            "StopDescription": "Trimble Westminster",
            "StopScheduledDatePart": "2018-08-12T00:00:00",
            "StopScheduledStartTimePart": null,
            "StopScheduledEndTimePart": null,
            "StopActualArrival": null,
            "StopActualDeparture": null,
            "EstimatedDeliveryDate": null,
            "IsCarrierEtaOverride": false,
            "DeliveryStatus": 0,
            "DeliveryStatusDescription": null,
            "LocationCode": null,
            "StopName": "Trimble",
            "StopReference": "2",
            "StopContactName": "Bryn Fosburgh",
            "StopContactPhoneNumber": "+13821194829",
            "StopContactEmailAddress": "[email protected]",
            "StopContactFaxNumber": "+11124492283",
            "StopContactPhoneExtension": "127",
            "StreetAddress1": "10368 Westmoor Dr",
            "StreetAddress2": null,
            "City": "Westminster",
            "State": "CO",
            "PostalCode": "80021",
            "Country": "US",
            "Latitude": 51.411,
            "Longitude": -42.9803,
            "IsActiveStop": false,
            "Shared": true,
            "SharedShipmentGuid": null,
            "ShareUrl": "https://cloud.10-4.com/FreightPortal/SharedShipmentStop/cb890541-c941-41e3-a874-c9432d91d7fd",
            "IsDropTrailer": null,
            "DwellTime": null,
            "ShipmentStopNote": [],
            "ShipmentNoteCreationType": 0
        },
        {
            "Appointment": {
                "AppointmentType": 1,
                "AppointmentDatePart": "2018-08-13T00:00:00",
                "AppointmentStartTimePart": "11:12:30",
                "AppointmentEndDatePart": "2018-08-13T00:00:00",
                "AppointmentEndTimePart": "12:22:30"
            },
            "StopSequence": 3,
            "StopType": 3,
            "StopDescription": "Mothership",
            "StopScheduledDatePart": "2018-08-13T00:00:00",
            "StopScheduledStartTimePart": null,
            "StopScheduledEndTimePart": null,
            "StopActualArrival": null,
            "StopActualDeparture": null,
            "EstimatedDeliveryDate": null,
            "IsCarrierEtaOverride": false,
            "DeliveryStatus": 0,
            "DeliveryStatusDescription": null,
            "LocationCode": null,
            "StopName": "Trimble HQ",
            "StopReference": "3",
            "StopContactName": "Wyatt Hello",
            "StopContactPhoneNumber": "+15553291185",
            "StopContactEmailAddress": "[email protected]",
            "StopContactFaxNumber": "+19402742273",
            "StopContactPhoneExtension": "183",
            "StreetAddress1": "935 Stewart Drive",
            "StreetAddress2": null,
            "City": "Sunnyvale",
            "State": "CA",
            "PostalCode": "94085",
            "Country": "US",
            "Latitude": 50.492,
            "Longitude": -44.5543,
            "IsActiveStop": false,
            "Shared": true,
            "SharedShipmentGuid": null,
            "ShareUrl": "https://cloud.10-4.com/FreightPortal/SharedShipmentStop/d745a6de-6938-4566-a394-8c66142ce4e4",
            "IsDropTrailer": null,
            "DwellTime": null,
            "ShipmentStopNote": [],
            "ShipmentNoteCreationType": 0
        }
    ],
    "Orders": [
        {
            "Commodities": [
                {
                    "CommodityName": "Commodian",
                    "PieceDescription": ".14ISPIECEOFPI",
                    "PieceCount": 8,
                    "PieceUnit": 3,
                    "WeightAmount": 11644,
                    "WeightUnit": 1,
                    "Length": 12,
                    "Width": 29,
                    "Height": 32,
                    "LinearUnit": 2,
                    "Volume": 313,
                    "VolumeUnit": 1,
                    "IsHazardous": false,
                    "IsStackable": true,
                    "PurchaseOrderNumber": "10-4Av2",
                    "ProductLine": "DOUBLE VISION",
                    "ProductBrand": "VISIBILITY ALE",
                    "HazmatTypes": null,
                    "AllowDeliveredQuantity": false
                }
            ],
            "OrderNumber": "JUSTANORDERNARYORDER1",
            "PickupStopReference": "1",
            "DeliveryStopReference": "2",
            "CustomerReference": "APICUSTOMERGUYORGAL",
            "CustomerName": "Jonesy",
            "CustomerAuthToken": null,
            "OrderException": null
        }
    ],
    "Exceptions": [],
    "ReferenceNumbers": [],
    "FreightProviderReferenceNumber": "THEBIGKAHUNA111",
    "CarrierScac": "TEST",
    "CarrierMc": null,
    "CarrierDot": null,
    "TractorReferenceNumber": "188",
    "TrailerReferenceNumber": "9103",
    "Equipment": 7,
    "EquipmentSize": null,
    "ShipmentStatus": 5,
    "DeliveryStatus": 0,
    "ShipmentNoteCreationType": 0,
    "DeliveryStatusDescription": null,
    "ShipmentTracking": 1,
    "DriverFirstName": "Emilio",
    "DriverLastName": "Estevez",
    "DriverPhoneNumber": "+15558675309",
    "DriverEmailAddress": "[email protected]",
    "TenFourLicensePlate": "CO80OB55",
    "TenantExternalId": null,
    "HasTeamDrivers": true,
    "Shared": true,
    "IsPriorityShipment": false,
    "LastStatusUpdate": null,
    "ShareUrl": "https://cloud.10-4.com/FreightPortal/SharedShipment/ff0e437a-7d50-4460-9175-cd698a283a06",
    "LastPositionEvent": null,
    "MinimumTemperature": 68.2,
    "MaximumTemperature": 76.6,
    "CurrentTemperature": null,
    "ModeType": 2,
    "StatusAndTrackingHistory": [],
    "DeliveryStatusHistory": [],
    "Links": [
        {
            "Rel": "MobileTrackingUrl",
            "Href": "https://cloud.10-4.com/FreightPortal/a/i34w23",
            "Title": null
        },
        {
            "Rel": "QRCodeSvg",
            "Href": "https://cloud.10-4.com/atlas/frexapi/shipment/CO80OB55/qrcode.svg",
            "Title": null
        },
        {
            "Rel": "QRCodePng",
            "Href": "https://cloud.10-4.com/atlas/frexapi/shipment/CO80OB55/qrcode.png",
            "Title": null
        }
    ],
    "AllowFerryRoutes": false,
    "AllowBorderCrossing": false,
    "AvoidTolls": false,
    "HaulLength": 80,
    "HaulLinearUnitType": 3,
    "WeightDisplayUnitType": 1,
    "TemperatureUnitType": 1
}