get https://sandbox.api.mothership.com/beta/shipments
This endpoint allows a user to list all shipments booked by his/her organization.
This endpoint returns an array of shipments stored in the response body's results property.
Pagination behavior can be controlled by providing page and perPage query parameters. If none are provided, page will default to 1, and perPage will default to 25. perPage cannot exceed 100.
The hasMore property in the response payload indicates if there are additional shipments that can be fetched by incrementing the page query parameter.
{
"data": {
"results": [
{
"id": "72I2W1",
"createdAt": "2019-03-19T17:03:24.542Z",
"price": 79,
"earliestPickupDate": "2019-03-19T17:15:55.000Z",
"estimatedDeliveryDate": "2019-03-20T05:00:55.000Z",
"status": "Unallocated",
"estimatedLocation": {
"latitude": 34.1184341,
"longitude": -118.3003935
},
"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",
"coordinates": {
"latitude": 34.1184341,
"longitude": -118.3003935
},
"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",
"coordinates": {
"latitude": 34.0639323,
"longitude": -118.3592293
},
"accessorials": [
"liftgate",
"residential"
],
"phoneNumber": "+15555555555",
"openTime": "1000",
"closeTime": "2200",
"emails": [
]
}
}
],
"hasMore": false,
"perPage": 20,
"page": 2
}
}
curl -X GET \
https://sandbox.api.mothership.com/beta/shipments?perPage=20&page=2 \
-H 'Authorization: Bearer {YOUR_API_TOKEN}'