Use this endpoint to return the status of an LTL shipment according to a given identifier value. Note that this endpoint may return multiple shipments if the identifier is used for multiple shipments such as with a pickup number.
OK
Invalid request
Invalid or missing credentials
User not authorized to perform this operation
{- "infoMessages": [
- {
- "severity": "ERROR",
- "message": "string",
- "diagnostic": "string",
- "source": "SYSTEM"
}
], - "shipmentStatuses": [
- {
- "imageReferences": [
- {
- "documentType": "BILL_OF_LADING",
- "imageFormat": "PDF",
- "imageUrl": "string"
}
], - "infoMessages": [
- {
- "severity": "ERROR",
- "message": "string",
- "diagnostic": "string",
- "source": "SYSTEM"
}
], - "latestStatusUpdate": {
- "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "exceptionDetailCode": "APPOINTMENT_SET",
- "exceptionSummaryCode": "APPOINTMENT_ISSUE",
- "retrievalDateTime": "string",
- "statusCode": "IN_TRANSIT",
- "statusReason": {
- "code": "PICKUP_INFO",
- "description": "string"
}, - "stopId": 0,
- "stopNumber": 0,
- "stopType": "ORIGIN",
- "timestamp": {
- "date": "2019-08-24",
- "time": "15:00:00",
- "timeZoneOffset": "-0500"
}
}, - "latestStopStatuses": [
- {
- "arrivalCode": "UNKNOWN",
- "arrivalDateTime": {
- "date": "2019-08-24",
- "time": "15:00:00",
- "timeZoneOffset": "-0500"
}, - "arrivalEstimate": {
- "estimatedArrivalWindow": {
- "startDateTime": {
- "date": null,
- "time": null,
- "timeZoneOffset": null
}, - "endDateTime": {
- "date": null,
- "time": null,
- "timeZoneOffset": null
}
}
}, - "departureDateTime": {
- "date": "2019-08-24",
- "time": "15:00:00",
- "timeZoneOffset": "-0500"
}, - "statusCode": "UNKNOWN",
- "stopId": 0,
- "stopNumber": 0,
- "stopType": "ORIGIN",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
], - "mapUrl": "string",
- "shipment": {
- "apiConfiguration": {
- "fallBackToDefaultAccountGroup": true
}, - "capacityProviderAccountGroup": {
- "code": "string",
- "accounts": [
- {
- "code": "string"
}
]
}, - "id": 0,
- "ltlLegId": "005b127f-bb88-444f-8788-e084b7eeceb3",
- "masterShipmentId": "2e04ec4a-749a-4ef4-a452-b7dc8cca16aa",
- "shipmentAttributes": [
- {
- "name": "string",
- "values": [
- "string"
]
}
], - "shipmentIdentifiers": [
- {
- "type": "PRO",
- "value": "string",
- "primaryForType": true,
- "source": "CUSTOMER"
}
], - "shipmentStops": [
- {
- "additionalAppointmentWindows": [
- {
- "type": null,
- "appointmentWindow": null,
- "appointmentStatus": null,
- "identifiers": [ ]
}
], - "appointmentWindow": {
- "startDateTime": "2019-08-24T14:15:22Z",
- "endDateTime": "2019-08-24T14:15:22Z",
- "localTimeZoneIdentifier": "string"
}, - "geoCoordinates": {
- "latitude": -90,
- "longitude": -180
}, - "id": 0,
- "involvedParties": [
- {
- "partyIdentifiers": [ ]
}
], - "location": {
- "address": {
- "postalCode": null,
- "addressLines": [ ],
- "city": null,
- "state": null,
- "country": null
}, - "contact": {
- "companyName": null,
- "contactName": null,
- "phoneNumber": null,
- "phoneNumberCountryCode": null,
- "phoneNumber2": null,
- "phoneNumber2CountryCode": null,
- "email": null,
- "faxNumber": null,
- "faxNumberCountryCode": null
}
}, - "locationIdentifiers": [
- {
- "type": null,
- "value": null
}
], - "stopDescription": "string",
- "stopName": "string",
- "stopNumber": 0,
- "stopType": "ORIGIN",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
]
}, - "statusUpdates": [
- {
- "address": {
- "postalCode": "string",
- "addressLines": [
- "str"
], - "city": "string",
- "state": "string",
- "country": "US"
}, - "exceptionDetailCode": "APPOINTMENT_SET",
- "exceptionSummaryCode": "APPOINTMENT_ISSUE",
- "retrievalDateTime": "string",
- "statusCode": "IN_TRANSIT",
- "statusReason": {
- "code": "PICKUP_INFO",
- "description": "string"
}, - "stopId": 0,
- "stopNumber": 0,
- "stopType": "ORIGIN",
- "timestamp": {
- "date": "2019-08-24",
- "time": "15:00:00",
- "timeZoneOffset": "-0500"
}
}
]
}
]
}