Quickstart
From quote to tracking in four requests
Walk the whole flow on sample data, or connect a sandbox token and make the real requests. Each step hands its IDs to the next, the same way your integration will.
01Connect
02Get rates
Describe the freight, where it goes and when it's ready. Mothership asks its carriers and answers with a quote ID and every rate it found.
- Freight
- 2 × Pallet, 50 lb each
- From
- Griffith Observatory, Los Angeles, 90027
- To
- LACMA, Los Angeles, 90036
- Ready
- 2024-10-15 at 1000
POST
https://sandbox.api.mothership.com/beta/quotes{
"freight": [
{
"quantity": 2,
"type": "Pallet",
"weight": 50,
"length": 48,
"width": 42,
"height": 46,
"description": "T-shirts"
}
],
"pickup": {
"name": "Griffith Observatory",
"address": {
"street": "2800 E Observatory Rd",
"city": "Los Angeles",
"state": "CA",
"zip": "90027"
},
"accessorials": [
"liftgate"
],
"phoneNumber": "+15555555555",
"emails": [
"logistics@mothership.com"
],
"openTime": "1000",
"closeTime": "2200"
},
"delivery": {
"name": "LACMA",
"address": {
"street": "5905 Wilshire Blvd",
"city": "Los Angeles",
"state": "CA",
"zip": "90036"
},
"accessorials": [
"liftgate",
"residential"
],
"phoneNumber": "+15555555555",
"emails": [
"logistics@mothership.com"
],
"openTime": "1100",
"closeTime": "1700"
},
"pickupReadyDate": {
"date": "2024-10-15",
"time": "1000"
}
}03Choose a rate
The rates from your quote show up here.
04Book
Send the quote ID and the rate you picked. In production this purchases the shipment and charges your organization's default payment source. The sandbox never purchases anything.
POST
https://sandbox.api.mothership.com/beta/shipments{
"quoteId": "…",
"rateId": "…"
}05Track
Follow the shipment by its ID. Each event's status is the new shipment status, or a progress note from the carrier.
GET
https://sandbox.api.mothership.com/beta/tracking/{shipmentId}