Allows to retrieve the list of all deliveries belonging to the user identified by the provided API key.
Pagniation
Each call to this endpoint will return a "page" of up to 50 records, organised by date of creation, in descending order. If there are any more, the 'next_page' parameter will contain the url at which you can return the query.
Please note that these URLs are temporary and after several hours, they may expire.
Delivery States
Not sure what the possible states are? Check the Deliveries: Overview page
This resource is used to retrieve the list of deliveries that have been placed by the user identified by the API key. Please see section on authentication for details on how that works.
Example request:
The cURL command below will return the first 50 results.
curl -u YourApiKey: https://api.wumdrop.com/v1/deliveries
The results will also include a parameter named 'next_page' that will be set to null if there are no more records to show, otherwise it will contain the url at which it is possible to resume the query.
{
'deliveries': [
{
'id':'DeliveryId1',
'state':'PENDING PICKUP'
},
{
'id':'DeliveryId2',
'state':'COMPLETED'
},
...
{
'id':'DeliveryId50',
'state':'DELIVERED'
},
],
'next_page':'https://api.wumdrop.com/v1/deliveries?p=UniqueIdForTheFollowingPage'
}
You can feed that URL straight back to cURL,
curl -u YourApiKey: https://api.wumdrop.com/v1/deliveries?p=UniqueIdForTheFollowingPage
... and up to 50 more results will be returned. If there are any more records to show, 'next_page' will, again, contain a URL - otherwise it will be null.
{
'deliveries': [
{
'id':'DeliveryId51',
'state':'PENDING DROPOFF'
},
{
'id':'DeliveryId52',
'state':'DELIVERED'
},
{
'id':'DeliveryId53',
'state':'CANCELLED'
}
],
'next_page':null
}