latestOpenAPI 3.0.02026-08-08163663.9 KB
4aa7f4326443
Shipper
Returns a shipment with status info
get/shipments/status
Query parameters
shipmentReferencestring required
Shipment Id
Response
Status Code 200: Successful Response - the request was successful!
Example response
{
"shipments": [
{
"shipmentId": "61f468826a139d5cfe58f0a2",
"shipmentReference": "TES-1296",
"status": "in_progress",
"stops": [
{
"stopId": "61f468806a139d5cfe58f098",
"locationName": "Walmart",
"locationAddress": "228 Main St Venice CA 90291 USA",
"windowStart": "2022-03-28T19:00:00.000Z",
"windowEnd": "2022-03-28T23:00:00.000Z",
"sequence": 2
}
],
"carrierId": "5eab53242668e30019713c87",
"driver": {
"_id": "5c7df5fd5b65270029523f74",
"_type": "Driver",
"first_name": "testGPSDriverFirst",
"last_name": "testGPSDriverLast 1"
}
}
]
}