The Delivery entity is the VIP resident of the WumDrop system. Let's go over what each record of that kind includes.
Upon submission and/or retrieval of Deliveries, the following fields may be available:
| Field | Format | Description |
|---|---|---|
| pickup_address | String. | This is the address at which the WumDrop driver needs to pick up the parcel. Example: "4 Darters Rd, Gardens, Cape Town, South Africa". |
| pickup_contact_name | String. | Name of the person/entity from which the parcel is to be picked up. Examples: "Hattori Hanzo", or "Google, Inc". |
| pickup_contact_phone | String. | 10-digit SA phone number of the person/entity from which the parcel is to be picked up. Examples: "0871234567", or "0212345678". |
| pickup_remarks (optional) | String. | To be filled if you think the driver might require additional information to pick up the parcel. Example: "Ask the receptionist for the package from flat 402". |
| dropoff_address | String. | This is the address at which the WumDrop driver needs to deliver the parcel. Example: "4 Darters Rd, Gardens, Cape Town, South Africa". |
| dropoff_contact_name | String. | Name of the person/entity to which the parcel is to be delivered. Examples: "Hattori Hanzo", or "Google, Inc". |
| dropoff_contact_phone | String. | 10-digit SA phone number of the person/entity to which the parcel is to be delivered. Examples: "0871234567", or "0212345678". |
| dropoff_remarks (optional) | String. | To be filled if you think the driver might require additional information to pick up the parcel. Example: "Ask the receptionist for the package from flat 402". |
| city | String. | (can be set to 'CPT' or 'JHB') Defaults to CPT. |
| state (for GET requests only) | String. | Not made available during the process of placing a delivery, but can be queried after the WumDrop API has accepted your submission - and changes as the task progresses through different phases. Possible states are: "PENDING PICKUP", "PENDING DROPOFF", "DELIVERED", and "CANCELLED". |
| id (for GET requests only) | String. | Unique string that identifies each delivery. You can store this, it will not change. |
| confirmation_image_url (for GET requests only) | String. | Photographic proof of accomplished delivery. |
| time_estimate | String. | How long we think we might take from pickup to dropoff, in seconds. |
| distance_estimate | String. | How far the driver will have to travel from pickup to dropoff, in metres. |
| last_known_location | String. | The last known coordinates of the parcel (lat, lng). |
| customer_identifier | String. | Your internal customer identifier. Use this if you'd like to group orders by customer. Can be used to look to look up a series of deliveries with a corresponding customer_identifier. |
| order_reference | String. | Your internal order id. Handy if you don't want to store ours. Can be used to look up a delivery. |