This is an object representing delivery requests.
Delivery requests
Delivery requests are simply a created intent to perform a delivery via the API. They must include the pickup and dropoff locations, as well as items to be delivered and information about them.
Cancelling a single delivery request will cancel all deliveries associated with it.
Delivery request object fields
| Field | Data type | Description | Type |
|---|---|---|---|
| id | string | unique id of delivery request | required |
| business_id | string | reference to unique id of business making request | required |
| selected_quote_id | string | reference to unique id of delivery quote that delivery was initiated with | optional |
| completed | boolean | indicates if the delivery request has been completed or not | required |
| status | enum | tracks the different status that the delivery request may have based on its constituent deliveries | required |
| pickup_point_id | string | reference to unique id of delivery point for pick up | required |
| dropoff_point_id | string | reference to unique id of delivery point for drop off | required |
| expires_at | date time | specific date time when the delivery request will expire and will need to be refreshed | required |
| deliveries | array | collection of deliveries that will take place for the entire delivery request to be successful | required |
| quotes | array | collection of options you have to make the delivery based on variable costs and delivery durations | required |
| requires_id_verification | boolean | specifies if an identification verification is required at the dropoff point (defaults to false) | required |
| requires_dropoff_signature | boolean | specifies if a receiver's signature is required at the dropoff point (defaults to false) | required |
Delivery quotes
For every delivery request made, delivery quotes are returned. These are simply the different costs and options you can use to make the delivery.
At the moment, we only return a single quote after our algorithms have optimized the delivery for the lowest delivery fee.
Delivery quote object fields
| Field | Data type | Description |
|---|---|---|
| id | string | unique id of delivery quote |
| delivery_request_id | string | reference to unique id of delivery request |
| delivery_duration | integer | estimated length of time to complete delivery if initiated with this quote |
| fee | integer | cost of delivery |
| currency | string | currency of fee |