GET - Orders
GET Shipments by Order
The Orders Service comprises a GET HTTP Endpoint that allows users to retrieve active shipments with orders referencing a supplied orderNumber within the 10-4 System's Freight Portal. This endpoint is only applicable for active shipments and does not apply to completed/canceled shipments which would appear on the history page.
The GET orders endpoint allows the retrieval of a specific shipment(s) in the 10-4 Freight Portal. Orders are displayed and sorted by Shipment Creation Date.
The GET orders endpoint has a single parameter value that can be used as the orderNumber. The value can be found below:
1. OrderNumberThe Orders HTTP Endpoint for shipment retrieval is listed below:
HTTP Verb: GET
URI: /atlas/frexapi/orders/{orderNumber}
Authentication: Basic Auth or Bearer TokenSuccess Response:
[
{
"ShipmentUniqueName": "COUSSXMA",
"Commodities": [
{
"OrderCommodityId": 17870289,
"OrderId": 9069906,
"PieceDescription": ".14ISPIECEOFPI",
"PieceCount": 8,
"WeightAmount": 11644,
"PieceUnitDisplayName": "Each",
"PieceCountDisplayName": "8",
"CommodityCode": null,
"PurchaseOrderNumber": "10-4Av2",
"CommodityName": "Commodian",
"PieceUnit": 3,
"WeightUnit": 1,
"Length": 12,
"Width": 29,
"Height": 32,
"LinearUnit": 2,
"Volume": 313,
"VolumeUnit": 1,
"IsHazardous": false,
"IsStackable": true,
"ProductLine": "DOUBLE VISION",
"ProductBrand": "VISIBILITY ALE"
}
],
"OrderNumber": "JUSTANORDERNARYORDER1",
"OrderStatusType": 1,
"ShipmentPrice": 0,
"ValidFrom": "2018-08-12T02:34:57.4401695",
"ValidTo": "9999-12-31T23:59:59.9999999",
"Stops": [
{
"ShipmentStopId": 18354220,
"ShipmentId": 14074553,
"FixedLocationId": null,
"LocationCode": null,
"StopScheduledDate": "2018-08-11T00:00:00+00:00",
"StopScheduledEndDate": null,
"StopScheduledDatePart": "2018-08-11T00:00:00",
"StopScheduledEndDatePart": "2018-08-11T00:00:00",
"StopScheduledStartTimePart": null,
"StopScheduledEndTimePart": null,
"StreetAddress1": "4888 Pearl E Cir",
"StreetAddress2": "300W",
"City": "Boulder",
"State": "CO",
"PostalCode": "80301",
"Country": "US",
"Latitude": 50.1234,
"Longitude": -45.1234,
"LocalDateTime": "2018-08-11T00:00:00+00:00",
"NonLocalDateTime": null,
"MatchConfidenceType": 0,
"StopContactName": "Good Buddy",
"StopContactPhoneNumber": "1234567891",
"StopContactEmailAddress": "[email protected]",
"StopContactFaxNumber": "0198765432",
"StopContactPhoneExtension": "887",
"RelatedFixedLocation": null,
"StopSequence": 1,
"StopType": 1,
"StopName": "10-4 Systems",
"StopDescription": "Visibility",
"StopDepartureDate": null,
"StopActualArrivalDate": null,
"StopScheduledEndTime": null,
"StopAppointmentDatePart": "2018-08-11T00:00:00",
"StopAppointmentStartTimePart": "00:15:32",
"StopAppointmentEndDatePart": "2018-08-11T00:00:00",
"StopAppointmentEndTimePart": "17:31:42",
"EstimatedDeliveryDate": null,
"IsCarrierEtaOverride": false,
"DeliveryStatus": 0,
"DeliveryStatusDescription": null,
"AppointmentType": 1,
"Appointment": {
"ShipmentStopId": 0,
"AppointmentType": 0,
"AppointmentDate": null,
"AppointmentDatePart": null,
"AppointmentStartTimePart": null,
"AppointmentEndDate": null,
"AppointmentEndDatePart": null,
"AppointmentEndTimePart": null
},
"StopReference": "1",
"IsCompletedFlag": false,
"ShipmentStopGeography": null,
"ShipmentStopNote": [],
"ShipmentNoteCreationType": 0,
"IsActualArrivalOverride": false,
"IsActualDepartureOverride": false,
"Shared": false,
"ShareGuid": null,
"IsDropTrailer": null,
"DwellTime": null,
"DocumentCount": 0,
"GeofenceRadiusInFeet": 0
},
{
"ShipmentStopId": 18354221,
"ShipmentId": 14074553,
"FixedLocationId": null,
"LocationCode": null,
"StopScheduledDate": "2018-08-12T00:00:00+00:00",
"StopScheduledEndDate": null,
"StopScheduledDatePart": "2018-08-12T00:00:00",
"StopScheduledEndDatePart": "2018-08-12T00:00:00",
"StopScheduledStartTimePart": null,
"StopScheduledEndTimePart": null,
"StreetAddress1": "10368 Westmoor Dr",
"StreetAddress2": null,
"City": "Westminster",
"State": "CO",
"PostalCode": "80021",
"Country": "US",
"Latitude": 51.411,
"Longitude": -42.9803,
"LocalDateTime": "2018-08-12T00:00:00+00:00",
"NonLocalDateTime": null,
"MatchConfidenceType": 0,
"StopContactName": "Bryn Fosburgh",
"StopContactPhoneNumber": "3821194829",
"StopContactEmailAddress": "[email protected]",
"StopContactFaxNumber": "1124492283",
"StopContactPhoneExtension": "127",
"RelatedFixedLocation": null,
"StopSequence": 2,
"StopType": 2,
"StopName": "Trimble",
"StopDescription": "Trimble Westminster",
"StopDepartureDate": null,
"StopActualArrivalDate": null,
"StopScheduledEndTime": null,
"StopAppointmentDatePart": null,
"StopAppointmentStartTimePart": null,
"StopAppointmentEndDatePart": null,
"StopAppointmentEndTimePart": null,
"EstimatedDeliveryDate": null,
"IsCarrierEtaOverride": false,
"DeliveryStatus": 0,
"DeliveryStatusDescription": null,
"AppointmentType": 0,
"Appointment": {
"ShipmentStopId": 0,
"AppointmentType": 0,
"AppointmentDate": null,
"AppointmentDatePart": null,
"AppointmentStartTimePart": null,
"AppointmentEndDate": null,
"AppointmentEndDatePart": null,
"AppointmentEndTimePart": null
},
"StopReference": "2",
"IsCompletedFlag": false,
"ShipmentStopGeography": null,
"ShipmentStopNote": [],
"ShipmentNoteCreationType": 0,
"IsActualArrivalOverride": false,
"IsActualDepartureOverride": false,
"Shared": false,
"ShareGuid": null,
"IsDropTrailer": null,
"DwellTime": null,
"DocumentCount": 0,
"GeofenceRadiusInFeet": 0
},
{
"ShipmentStopId": 18354223,
"ShipmentId": 14074554,
"FixedLocationId": null,
"LocationCode": null,
"StopScheduledDate": "2018-08-11T00:00:00+00:00",
"StopScheduledEndDate": null,
"StopScheduledDatePart": "2018-08-11T00:00:00",
"StopScheduledEndDatePart": "2018-08-11T00:00:00",
"StopScheduledStartTimePart": null,
"StopScheduledEndTimePart": null,
"StreetAddress1": "4888 Pearl E Cir",
"StreetAddress2": "300W",
"City": "Boulder",
"State": "CO",
"PostalCode": "80301",
"Country": "US",
"Latitude": 50.1234,
"Longitude": -45.1234,
"LocalDateTime": "2018-08-11T00:00:00+00:00",
"NonLocalDateTime": null,
"MatchConfidenceType": 0,
"StopContactName": "Good Buddy",
"StopContactPhoneNumber": "1234567891",
"StopContactEmailAddress": "[email protected]",
"StopContactFaxNumber": "0198765432",
"StopContactPhoneExtension": "887",
"RelatedFixedLocation": null,
"StopSequence": 1,
"StopType": 1,
"StopName": "10-4 Systems",
"StopDescription": "Visibility",
"StopDepartureDate": null,
"StopActualArrivalDate": null,
"StopScheduledEndTime": null,
"StopAppointmentDatePart": "2018-08-11T00:00:00",
"StopAppointmentStartTimePart": "00:15:32",
"StopAppointmentEndDatePart": "2018-08-11T00:00:00",
"StopAppointmentEndTimePart": "17:31:42",
"EstimatedDeliveryDate": null,
"IsCarrierEtaOverride": false,
"DeliveryStatus": 0,
"DeliveryStatusDescription": null,
"AppointmentType": 1,
"Appointment": {
"ShipmentStopId": 0,
"AppointmentType": 0,
"AppointmentDate": null,
"AppointmentDatePart": null,
"AppointmentStartTimePart": null,
"AppointmentEndDate": null,
"AppointmentEndDatePart": null,
"AppointmentEndTimePart": null
},
"StopReference": "1",
"IsCompletedFlag": false,
"ShipmentStopGeography": null,
"ShipmentStopNote": [],
"ShipmentNoteCreationType": 0,
"IsActualArrivalOverride": false,
"IsActualDepartureOverride": false,
"Shared": false,
"ShareGuid": null,
"IsDropTrailer": null,
"DwellTime": null,
"DocumentCount": 0,
"GeofenceRadiusInFeet": 0
},
{
"ShipmentStopId": 18354224,
"ShipmentId": 14074554,
"FixedLocationId": null,
"LocationCode": null,
"StopScheduledDate": "2018-08-12T00:00:00+00:00",
"StopScheduledEndDate": null,
"StopScheduledDatePart": "2018-08-12T00:00:00",
"StopScheduledEndDatePart": "2018-08-12T00:00:00",
"StopScheduledStartTimePart": null,
"StopScheduledEndTimePart": null,
"StreetAddress1": "10368 Westmoor Dr",
"StreetAddress2": null,
"City": "Westminster",
"State": "CO",
"PostalCode": "80021",
"Country": "US",
"Latitude": 51.411,
"Longitude": -42.9803,
"LocalDateTime": "2018-08-12T00:00:00+00:00",
"NonLocalDateTime": null,
"MatchConfidenceType": 0,
"StopContactName": "Bryn Fosburgh",
"StopContactPhoneNumber": "3821194829",
"StopContactEmailAddress": "[email protected]",
"StopContactFaxNumber": "1124492283",
"StopContactPhoneExtension": "127",
"RelatedFixedLocation": null,
"StopSequence": 2,
"StopType": 2,
"StopName": "Trimble",
"StopDescription": "Trimble Westminster",
"StopDepartureDate": null,
"StopActualArrivalDate": null,
"StopScheduledEndTime": null,
"StopAppointmentDatePart": null,
"StopAppointmentStartTimePart": null,
"StopAppointmentEndDatePart": null,
"StopAppointmentEndTimePart": null,
"EstimatedDeliveryDate": null,
"IsCarrierEtaOverride": false,
"DeliveryStatus": 0,
"DeliveryStatusDescription": null,
"AppointmentType": 0,
"Appointment": {
"ShipmentStopId": 0,
"AppointmentType": 0,
"AppointmentDate": null,
"AppointmentDatePart": null,
"AppointmentStartTimePart": null,
"AppointmentEndDate": null,
"AppointmentEndDatePart": null,
"AppointmentEndTimePart": null
},
"StopReference": "2",
"IsCompletedFlag": false,
"ShipmentStopGeography": null,
"ShipmentStopNote": [],
"ShipmentNoteCreationType": 0,
"IsActualArrivalOverride": false,
"IsActualDepartureOverride": false,
"Shared": false,
"ShareGuid": null,
"IsDropTrailer": null,
"DwellTime": null,
"DocumentCount": 0,
"GeofenceRadiusInFeet": 0
}
],
"Links": [
{
"Rel": "full shipment",
"Href": "https://cloud.10-4.com/atlas/frexapi/shipment/COUSSXMA",
"Title": "Link to the full shipment details."
},
{
"Rel": "position events",
"Href": "https://cloud.10-4.com/atlas/frexapi/shipment/COUSSXMA/positions",
"Title": " Link to the shipment position events."
}
]
},
{
"ShipmentUniqueName": "CO02IH89",
"Commodities": [
{
"OrderCommodityId": 17870290,
"OrderId": 9069907,
"PieceDescription": ".14ISPIECEOFPI",
"PieceCount": 8,
"WeightAmount": 11644,
"PieceUnitDisplayName": "Each",
"PieceCountDisplayName": "8",
"CommodityCode": null,
"PurchaseOrderNumber": "10-4Av2",
"CommodityName": "Commodian",
"PieceUnit": 3,
"WeightUnit": 1,
"Length": 12,
"Width": 29,
"Height": 32,
"LinearUnit": 2,
"Volume": 313,
"VolumeUnit": 1,
"IsHazardous": false,
"IsStackable": true,
"ProductLine": "DOUBLE VISION",
"ProductBrand": "VISIBILITY ALE"
}
],
"OrderNumber": "JUSTANORDERNARYORDER1",
"OrderStatusType": 1,
"ShipmentPrice": 0,
"ValidFrom": "2018-08-12T02:35:04.6589744",
"ValidTo": "9999-12-31T23:59:59.9999999",
"Stops": [
{
"ShipmentStopId": 18354220,
"ShipmentId": 14074553,
"FixedLocationId": null,
"LocationCode": null,
"StopScheduledDate": "2018-08-11T00:00:00+00:00",
"StopScheduledEndDate": null,
"StopScheduledDatePart": "2018-08-11T00:00:00",
"StopScheduledEndDatePart": "2018-08-11T00:00:00",
"StopScheduledStartTimePart": null,
"StopScheduledEndTimePart": null,
"StreetAddress1": "4888 Pearl E Cir",
"StreetAddress2": "300W",
"City": "Boulder",
"State": "CO",
"PostalCode": "80301",
"Country": "US",
"Latitude": 50.1234,
"Longitude": -45.1234,
"LocalDateTime": "2018-08-11T00:00:00+00:00",
"NonLocalDateTime": null,
"MatchConfidenceType": 0,
"StopContactName": "Good Buddy",
"StopContactPhoneNumber": "1234567891",
"StopContactEmailAddress": "[email protected]",
"StopContactFaxNumber": "0198765432",
"StopContactPhoneExtension": "887",
"RelatedFixedLocation": null,
"StopSequence": 1,
"StopType": 1,
"StopName": "10-4 Systems",
"StopDescription": "Visibility",
"StopDepartureDate": null,
"StopActualArrivalDate": null,
"StopScheduledEndTime": null,
"StopAppointmentDatePart": "2018-08-11T00:00:00",
"StopAppointmentStartTimePart": "00:15:32",
"StopAppointmentEndDatePart": "2018-08-11T00:00:00",
"StopAppointmentEndTimePart": "17:31:42",
"EstimatedDeliveryDate": null,
"IsCarrierEtaOverride": false,
"DeliveryStatus": 0,
"DeliveryStatusDescription": null,
"AppointmentType": 1,
"Appointment": {
"ShipmentStopId": 0,
"AppointmentType": 0,
"AppointmentDate": null,
"AppointmentDatePart": null,
"AppointmentStartTimePart": null,
"AppointmentEndDate": null,
"AppointmentEndDatePart": null,
"AppointmentEndTimePart": null
},
"StopReference": "1",
"IsCompletedFlag": false,
"ShipmentStopGeography": null,
"ShipmentStopNote": [],
"ShipmentNoteCreationType": 0,
"IsActualArrivalOverride": false,
"IsActualDepartureOverride": false,
"Shared": false,
"ShareGuid": null,
"IsDropTrailer": null,
"DwellTime": null,
"DocumentCount": 0,
"GeofenceRadiusInFeet": 0
},
{
"ShipmentStopId": 18354221,
"ShipmentId": 14074553,
"FixedLocationId": null,
"LocationCode": null,
"StopScheduledDate": "2018-08-12T00:00:00+00:00",
"StopScheduledEndDate": null,
"StopScheduledDatePart": "2018-08-12T00:00:00",
"StopScheduledEndDatePart": "2018-08-12T00:00:00",
"StopScheduledStartTimePart": null,
"StopScheduledEndTimePart": null,
"StreetAddress1": "10368 Westmoor Dr",
"StreetAddress2": null,
"City": "Westminster",
"State": "CO",
"PostalCode": "80021",
"Country": "US",
"Latitude": 51.411,
"Longitude": -42.9803,
"LocalDateTime": "2018-08-12T00:00:00+00:00",
"NonLocalDateTime": null,
"MatchConfidenceType": 0,
"StopContactName": "Bryn Fosburgh",
"StopContactPhoneNumber": "3821194829",
"StopContactEmailAddress": "[email protected]",
"StopContactFaxNumber": "1124492283",
"StopContactPhoneExtension": "127",
"RelatedFixedLocation": null,
"StopSequence": 2,
"StopType": 2,
"StopName": "Trimble",
"StopDescription": "Trimble Westminster",
"StopDepartureDate": null,
"StopActualArrivalDate": null,
"StopScheduledEndTime": null,
"StopAppointmentDatePart": null,
"StopAppointmentStartTimePart": null,
"StopAppointmentEndDatePart": null,
"StopAppointmentEndTimePart": null,
"EstimatedDeliveryDate": null,
"IsCarrierEtaOverride": false,
"DeliveryStatus": 0,
"DeliveryStatusDescription": null,
"AppointmentType": 0,
"Appointment": {
"ShipmentStopId": 0,
"AppointmentType": 0,
"AppointmentDate": null,
"AppointmentDatePart": null,
"AppointmentStartTimePart": null,
"AppointmentEndDate": null,
"AppointmentEndDatePart": null,
"AppointmentEndTimePart": null
},
"StopReference": "2",
"IsCompletedFlag": false,
"ShipmentStopGeography": null,
"ShipmentStopNote": [],
"ShipmentNoteCreationType": 0,
"IsActualArrivalOverride": false,
"IsActualDepartureOverride": false,
"Shared": false,
"ShareGuid": null,
"IsDropTrailer": null,
"DwellTime": null,
"DocumentCount": 0,
"GeofenceRadiusInFeet": 0
},
{
"ShipmentStopId": 18354223,
"ShipmentId": 14074554,
"FixedLocationId": null,
"LocationCode": null,
"StopScheduledDate": "2018-08-11T00:00:00+00:00",
"StopScheduledEndDate": null,
"StopScheduledDatePart": "2018-08-11T00:00:00",
"StopScheduledEndDatePart": "2018-08-11T00:00:00",
"StopScheduledStartTimePart": null,
"StopScheduledEndTimePart": null,
"StreetAddress1": "4888 Pearl E Cir",
"StreetAddress2": "300W",
"City": "Boulder",
"State": "CO",
"PostalCode": "80301",
"Country": "US",
"Latitude": 50.1234,
"Longitude": -45.1234,
"LocalDateTime": "2018-08-11T00:00:00+00:00",
"NonLocalDateTime": null,
"MatchConfidenceType": 0,
"StopContactName": "Good Buddy",
"StopContactPhoneNumber": "1234567891",
"StopContactEmailAddress": "[email protected]",
"StopContactFaxNumber": "0198765432",
"StopContactPhoneExtension": "887",
"RelatedFixedLocation": null,
"StopSequence": 1,
"StopType": 1,
"StopName": "10-4 Systems",
"StopDescription": "Visibility",
"StopDepartureDate": null,
"StopActualArrivalDate": null,
"StopScheduledEndTime": null,
"StopAppointmentDatePart": "2018-08-11T00:00:00",
"StopAppointmentStartTimePart": "00:15:32",
"StopAppointmentEndDatePart": "2018-08-11T00:00:00",
"StopAppointmentEndTimePart": "17:31:42",
"EstimatedDeliveryDate": null,
"IsCarrierEtaOverride": false,
"DeliveryStatus": 0,
"DeliveryStatusDescription": null,
"AppointmentType": 1,
"Appointment": {
"ShipmentStopId": 0,
"AppointmentType": 0,
"AppointmentDate": null,
"AppointmentDatePart": null,
"AppointmentStartTimePart": null,
"AppointmentEndDate": null,
"AppointmentEndDatePart": null,
"AppointmentEndTimePart": null
},
"StopReference": "1",
"IsCompletedFlag": false,
"ShipmentStopGeography": null,
"ShipmentStopNote": [],
"ShipmentNoteCreationType": 0,
"IsActualArrivalOverride": false,
"IsActualDepartureOverride": false,
"Shared": false,
"ShareGuid": null,
"IsDropTrailer": null,
"DwellTime": null,
"DocumentCount": 0,
"GeofenceRadiusInFeet": 0
},
{
"ShipmentStopId": 18354224,
"ShipmentId": 14074554,
"FixedLocationId": null,
"LocationCode": null,
"StopScheduledDate": "2018-08-12T00:00:00+00:00",
"StopScheduledEndDate": null,
"StopScheduledDatePart": "2018-08-12T00:00:00",
"StopScheduledEndDatePart": "2018-08-12T00:00:00",
"StopScheduledStartTimePart": null,
"StopScheduledEndTimePart": null,
"StreetAddress1": "10368 Westmoor Dr",
"StreetAddress2": null,
"City": "Westminster",
"State": "CO",
"PostalCode": "80021",
"Country": "US",
"Latitude": 51.411,
"Longitude": -42.9803,
"LocalDateTime": "2018-08-12T00:00:00+00:00",
"NonLocalDateTime": null,
"MatchConfidenceType": 0,
"StopContactName": "Bryn Fosburgh",
"StopContactPhoneNumber": "3821194829",
"StopContactEmailAddress": "[email protected]",
"StopContactFaxNumber": "1124492283",
"StopContactPhoneExtension": "127",
"RelatedFixedLocation": null,
"StopSequence": 2,
"StopType": 2,
"StopName": "Trimble",
"StopDescription": "Trimble Westminster",
"StopDepartureDate": null,
"StopActualArrivalDate": null,
"StopScheduledEndTime": null,
"StopAppointmentDatePart": null,
"StopAppointmentStartTimePart": null,
"StopAppointmentEndDatePart": null,
"StopAppointmentEndTimePart": null,
"EstimatedDeliveryDate": null,
"IsCarrierEtaOverride": false,
"DeliveryStatus": 0,
"DeliveryStatusDescription": null,
"AppointmentType": 0,
"Appointment": {
"ShipmentStopId": 0,
"AppointmentType": 0,
"AppointmentDate": null,
"AppointmentDatePart": null,
"AppointmentStartTimePart": null,
"AppointmentEndDate": null,
"AppointmentEndDatePart": null,
"AppointmentEndTimePart": null
},
"StopReference": "2",
"IsCompletedFlag": false,
"ShipmentStopGeography": null,
"ShipmentStopNote": [],
"ShipmentNoteCreationType": 0,
"IsActualArrivalOverride": false,
"IsActualDepartureOverride": false,
"Shared": false,
"ShareGuid": null,
"IsDropTrailer": null,
"DwellTime": null,
"DocumentCount": 0,
"GeofenceRadiusInFeet": 0
}
],
"Links": [
{
"Rel": "full shipment",
"Href": "https://cloud.10-4.com/atlas/frexapi/shipment/CO02IH89",
"Title": "Link to the full shipment details."
},
{
"Rel": "position events",
"Href": "https://cloud.10-4.com/atlas/frexapi/shipment/CO02IH89/positions",
"Title": " Link to the shipment position events."
}
]
}
]Updated about 2 months ago
What’s Next