Allows to place a new delivery.
Placing orders using only street addresses
We strive to continuously make our platform resolve street addresses optimally, however there are outside factors that make this task extremely difficult. (E.g. 2 or more streets with the same name in a single suburb, etc).
TL;DR: Please provide the coordinates for both locations, whenever possible.
Field: customer_identifier
The purpose of this field is to group (and later query) a list of deliveries by a certain ID internal to your system.
For example, if you have a Customer record with id:123, and wish to group orders you place on their behalf, you can include that in the customer_identifier field.
(Conceivably, you could use this field to do any sort of grouping at all - it does not have to be a customer Id.)
To learn how you can query our system for all deliveries you have placed using a customer_id, see: /deliveries/customer/:customer_id
Field: order_reference
Setting this field to the corresponding order ID from your system will enable you to query our API for Deliveries without having to store the Delivery:id returned on placement.
Uniqueness is enforced for this field: trying to submit two deliveries with the same order_reference is considered an error and will result in a negative server response.
Units
You'll notice the fields 'distance_estimate' and 'time_estimate' in the above server response.
By default, the API uses SI base units to communicate time and distance.
(metres and seconds).
Example Request:
curl -X POST -H "Content-Type: application/json" -u YourAPIKeyHere: -d '{ "pickup_address":"66 Albert Road, Woodstock, Cape Town, South Africa","pickup_contact_name":"Hattori Hanzo","pickup_contact_phone":"0872310223", "pickup_remarks":"The sword will be at the reception.", "dropoff_address":"55 Albert Road, Woodstock, Cape Town, South Africa","dropoff_contact_name":"Bill","dropoff_contact_phone":"0212011122","dropoff_remarks":"Make sure Bill knows you are coming", "pickup_coordinates":"-33.926401, 18.444876", "dropoff_coordinates":"-33.944912, 18.472792" }' https://api.wumdrop.com/v1/deliveries