Skip to content
MothershipDevelopers

API referenceTracking

Track a shipment

Lists the tracking events for a shipment.

GET/tracking/{shipmentId}
Environment
https://sandbox.api.mothership.com/beta
curl --request GET \
  --url 'https://sandbox.api.mothership.com/beta/tracking/MS5016101' \
  --header "Authorization: Bearer $MOTHERSHIP_API_TOKEN" \
  --header 'Accept: application/json'
Reads your token from $MOTHERSHIP_API_TOKEN
Response
{
: {
: [
{
: "shipmentBooked",
: "MS5016101",
: "2019-03-19T17:03:24.542Z",
: "Unallocated",
: "Shipment booked and awaiting carrier assignment",
: "America/Los_Angeles"
},
{
: "statusUpdated",
: "MS5016101",
: "1234567890",
: "2019-03-19T18:12:40.310Z",
: "DriverAllocated",
: "Carrier assigned",
: "America/Los_Angeles"
},
{
: "statusUpdated",
: "MS5016101",
: "1234567890",
: "2019-03-19T19:31:11.124Z",
: "EnrouteToPickup",
: "Carrier is en route to the pickup location",
: "Los Angeles",
: "CA",
: "Griffith Observatory",
: "America/Los_Angeles"
}
]
}
}

Hover a key to see what it means. Click it to jump to the field.

Each result is one tracking event. proNumber appears once a carrier is assigned, and city and state when the carrier reports a location. See Getting tracking information for when to check for updates.

Authorization

Authorization: Bearer <token>

Your sandbox API token. See Authentication.

Path parameters

  • shipmentIdstringRequired

    ID of the shipment to track.

Responses

    • dataobject
      • resultsarray of objectsRequired

What's next

POSTCreate a webhook configuration

Subscribe to shipment.status.updated instead of polling.

Shipment statuses

What each status means and the order they usually come in.