post https://sandbox.api.mothership.com/beta/quotes
This endpoint allows a user to pass in shipment details and create a quote. This response will return the available rates with respective prices, and also return a quote ID that can be used in the Create Shipment endpoint.
{
"data": {
"id": "-LawNN52lCcvj6T5qiEp",
"expiresAt": "2019-03-26T23:51:40.485Z",
"rates": [
{
"id": "VDWLA0",
"creditsApplied": 0,
"estimatedPickupDate": "2019-03-26T23:45:40.000Z",
"estimatedDeliveryDate": "2019-03-28T05:00:40.000Z",
"price": 79,
"provider": "mothership",
"providerScac": "mhpg",
"services": [],
"transitDays": {
"minimum": 1,
"maximum": 1
},
"truck": {
"equipment": "straightTruck",
"specialty": "dryVan"
},
"warnings": []
},
{
"id": "G6EMET",
"creditsApplied": 0,
"estimatedPickupDate": "2019-03-26T23:45:40.000Z",
"estimatedDeliveryDate": "2019-03-27T05:00:40.000Z",
"price": 108,
"provider": "mothership",
"providerScac": "mhpg",
"services": [
"guaranteed"
],
"transitDays": {
"minimum": 0,
"maximum": 0
},
"truck": {
"equipment": "straightTruck",
"specialty": "dryVan"
},
"warnings": []
},
{
"id": "W7MG4A",
"creditsApplied": 0,
"estimatedPickupDate": "2019-03-26T23:45:40.000Z",
"estimatedDeliveryDate": "2019-03-28T05:00:40.000Z",
"price": 279,
"provider": "mothership",
"providerScac": "mhpg",
"services": [
"dedicated"
],
"transitDays": {
"minimum": 1,
"maximum": 1
},
"truck": {
"equipment": "any",
"specialty": "dryVan"
},
"warnings": []
},
{
"id": "6FFQO0",
"creditsApplied": 0,
"estimatedPickupDate": "2019-03-26T23:45:40.000Z",
"estimatedDeliveryDate": "2019-03-27T05:00:40.000Z",
"price": 358,
"provider": "mothership",
"services": [
"dedicated",
"guaranteed"
],
"transitDays": {
"minimum": 0,
"maximum": 0
},
"truck": {
"equipment": "any",
"specialty": "dryVan"
},
"warnings": []
}
],
"freight": [
{
"quantity": 2,
"type": "Pallet",
"weight": 50,
"length": 48,
"width": 42,
"height": 46,
"description": "T-shirts"
}
],
"pickup": {
"placeId": "ChIJywjU6WG_woAR3NrWwrEH_3M",
"name": "Griffith Observatory",
"street": "2800 East Observatory Road",
"city": "Los Angeles",
"state": "CA",
"zip": "90027",
"accessorials": [
"liftgate"
],
"phoneNumber": "+15555555555",
"openTime": "1000",
"closeTime": "2200",
"emails": [
"[email protected]"
]
},
"delivery": {
"placeId": "ChIJsXqcyjy5woARNz6sOh0ZmwA",
"name": "LACMA",
"street": "5905 Wilshire Boulevard",
"city": "Los Angeles",
"state": "CA",
"zip": "90036",
"accessorials": [
"liftgate",
"residential"
],
"phoneNumber": "+15555555555",
"openTime": "1000",
"closeTime": "2200",
"emails": []
},
"metadata": {
"purchasable": true,
"invalidFieldsRequiredForPurchase": []
}
}
}
curl -X POST \
https://sandbox.api.mothership.com/beta/quotes \
-H 'Authorization: Bearer {YOUR_API_TOKEN}' \
-H 'Content-Type: application/json' \
-d '{
"freight": [{
"quantity": 2,
"type": "Pallet",
"weight": 50,
"length": 48,
"width": 42,
"height": 46,
"description": "T-shirts"
}],
"pickup": {
"name": "Griffith Observatory",
"placeId": "ChIJywjU6WG_woAR3NrWwrEH_3M",
"accessorials": ["liftgate"],
"phoneNumber": "+15555555555",
"emails": ["[email protected]"],
"openTime": "1000",
"closeTime": "2200"
},
"delivery": {
"name": "LACMA",
"placeId": "ChIJsXqcyjy5woARNz6sOh0ZmwA",
"accessorials": ["liftgate", "residential"],
"phoneNumber": "+15555555555",
"emails": ["[email protected]"],
"openTime": "1100",
"closeTime": "1700"
},
"pickupReadyDate": {
"date": "2019-03-19",
"time": "0800"
}
}'
Purchasable Metadata
In the response, there is a metadata field that indicates if the given quote is purchasable or if it is missing any required fields.
We require minimal information for creating quotes (such as only providing zip codes for locations or leaving out contact phone numbers). However, in order to actually book a shipment, we must have a specific location, a description of the freight, and valid contact information for both the pickup and delivery locations.