(required) For single string, format is : “Street Address, City, State, Zip”
dropoff_name
string
(required) Name of the place where the courier will make the dropoff.
dropoff_phone_number
string
(required) The phone number of the dropoff location.
manifest
string
(required) [SOON TO BE DEPRECATED] ’manifest_items` should be used instead.
manifest_items
Manifestltem[]
(required) List of items being delivered.
pickup_address
string
(required) Pickup address in Street Address, City, State, Zip format.
pickup_name
string
(required) Name of the place where the courier will make the pickup.
pickup_phone_number
string
(required) Name of the place where the courier will make the pickup.
deliverable_action
DeliverableAction
Specify the “happy path” action for the courier to take on a delivery. When used, delivery action can be set to “leave at door” for a contactless delivery. Cannot leave at door when signature or ID verification requirements are applied when creating a delivery. Photo confirmation of delivery will be automatically applied as a requirement to complete dropoff.
dropoff_business_name
string
Business name of the dropoff location.
dropoff_latitude
double
Dropoff latitude coordinate.
dropoff_longitude
double
Dropoff longitude coordinate.
dropoff_notes
string
Additional instructions for the courier at the dropoff location. Max 280 characters.
dropoff_seller_notes
string
Additional instructions provided by the merchant for the dropoff. Max 280 characters.
dropoff_verification
VerificationRequirement
Verification steps (i.e. barcode scanning) that must be taken before the dropoff can be completed.
manifest_reference
string
Reference that identifies the manifest. Use this to connect a delivery to corresponding information in your system.
manifest_total_value
integer
Value (in US cents) of the items in the delivery. i.e.: $10.99=>1099.
pickup_business_name
string
Business name of the pickup location.
pickup_latitude
double
Pickup latitude coordinate.
pickup_longitude
double
Pickup longitude coordinate.
pickup_notes
string
Additional instructions for the courier at the pickup location. Max 280 characters.
pickup_verification
VerificationRequirement
Verification steps (i.e. barcode scanning) that must be taken before the pickup can be completed.
quote_id
string
The ID of a previously generated delivery quote.
undeliverable_action
UndeliverableAction
Specify the “unhappy path” action for the courier to take on a delivery once a normal delivery attempt is made and a customer is not available.
pickup_ready_dt
timestamp (RFC 3339)
Beginning of the window when an order must be picked up. Must be less than 30 days in the future.
pickup_deadline_dt
timestamp (RFC 3339)
End of the window when an order may be picked up. Must be at least 10 mins later than pickup_ready_dt and at least 20 minutes in the future from now.
dropoff_ready_dt
timestamp (RFC 3339)
Beginning of the window when an order must be dropped off. Must be less than or equal to pickup_deadline_dt .
dropoff_deadline_dt
timestamp (RFC 3339)
End of the window when an order must be dropped off. Must be at least 20 mins later than dropoff_ready_dt and must be greater than or equal to pickup_deadline_dt.
requires_dropoff_signature
boolean
[DEPRECATED] Flag to indicate this delivery requires signature capture at dropoff.
requires_id
boolean
Flag to indicate this delivery requires ID check (minimum age) at dropoff
tip
integer
Upfront tip amount. 0.01 of the national currency (cents in US or $0.01 )
idempotency_key
string
A key which is used to avoid duplicate order creation with identical idempotency keys for the same account. The key persists for a set time frame, defaulting to 6 hours
external_store_id
string
(Optional) Unique identifier used by our Partners to reference a Store or Location
return_verification
VerificationRequirement
Verification steps (barcode scanning, picture, or signature) that must be taken before the return can be completed.
Approximate size of item. Specifying xlarge will cause dispatch to only couriers using a car or larger (no walkers/bikes/scooters/etc…).
dimensions
Dimensions
[optional] Struct that contains dimensions
price
integer
[optional] The price of the item. The value passed in should be based on 0.01 unit of the local currency. For example, in the US, a value of 1 would mean a cent ($0.01), and a value of 100 would mean a dollar ($1.00).
must_be_upright
boolean
[optional] Whether the item should be in upright position (box of pizza, bottle of milk etc)
weight
integer
[optional] Weight in grams
perishability
integer
[optional] Perishability represents the number of minutes before an item expires. For example, an ice cream might have a perishability of 15 minutes from pickup
preparation_time
integer
[optional] How long a given item takes to prepare (in minutes)
You can carry it with one hand e.g. bottle of water.
medium
string
You need a tote bag to carry it e.g. retail bag.
large
string
You need two hands to carry it e.g. computer monitor.
xlarge
string
You will need to make multiple trips to/from a vehicle to transport e.g. grocery order. Specifying xlarge will cause dispatch to only couriers using a car or larger (no walkers/bikes/scooters/etc…).
Meet at door delivery. This is the default if DeliverableAction is not set.
deliverable_action_leave_at_door
string
The “happy path” action for the courier to take on a delivery. When used, delivery action can be set to “leave at door” for a contactless delivery. Cannot leave at door when signature or ID verification requirements are applied when creating a delivery. Photo confirmation of delivery will be automatically applied as a requirement to complete drop-off.
§Request Body Parameters - VerificationRequirement
Name
Type
Description
signature
boolean
[DEPRECATED] Flag for if a signature is required at this waypoint. signature_requirement should be used instead.
signature_requirement
SignatureRequirement[]
Signature requirement spec to indicate that a signature must be collected at this waypoint.
barcodes
BarcodeRequirement[]
Barcode values/types that must be scanned at the waypoint. Number of elements in the array is equal to the number of barcodes that must be scanned.
pincode
PincodeRequirement
Pincode requirement spec to indicate a delivery requires pincode confirmation upon delivery
package
PackageRequirement
Package verifications required for this waypoint.
identification
IdentificationRequirement
Identification scanning/verification requirements for this waypoint…
When set to true in POST requests, the delivery will require pincode entry at handoff.
value
string
The pincode that the customer must present at dropoff. This field will be ignored in the CreateDelivery requests, and the pin code is internally generated when this requirement is present.
Specify the “unhappy path” action for the courier to take on a delivery once a normal delivery attempt is made and a customer is not available. Cannot leave at door when signature or ID verification requirements are applied when creating a delivery. Photo confirmation of delivery will be automatically applied as a requirement to complete drop-off.
return
string
Specify the “unhappy path” action for the courier to take on a delivery once a normal delivery attempt is made and a customer is not available. This action requests the courier to return the delivery to the pickup waypoint.
Information about the courier. Only present when a delivery is in progress.
courier_imminent
boolean
Flag indicating if the courier is close to the pickup or dropoff location.
created
timestamp (RFC 3339)
Date/Time at which the delivery was created.
currency
string
Three-letter ISO currency code, in lowercase.
dropoff
WaypointInfo
Dropoff details.
dropoff_deadline
timestamp (RFC 3339)
When a delivery must be dropped off. This is the end of the dropoff window.
dropoff_eta
timestamp (RFC 3339)
Estimated drop-off time.
dropoff_identifier
string
This field identifies who received delivery at the dropoff location.
dropoff_ready
timestamp (RFC 3339)
When a delivery is ready to be dropped off. This is the start of the dropoff window.
external_id
string
An ID for an account as stored in an external system.
fee
integer
Amount in cents that will be charged if this delivery is created.
id
string
Unique identifier for the delivery ( del_ + tokenize(uuid)).
kind
string
The type of object being described. Always “delivery”.
live_mode
boolean
Flag that indicates if this is live mode or test mode.
manifest
ManifestInfo
A detailed description of what the courier will be delivering.
manifest_items
ManifestItem[]
List of items being delivered.
pickup
WaypointInfo
The pickup details for the delivery.
pickup_deadline
timestamp (RFC 3339)
When a delivery must be picked up by. This is the end of the pickup window.
pickup_eta
timestamp (RFC 3339)
Estimated time the courier will arrive at the pickup location.
pickup_ready
timestamp (RFC 3339)
When a delivery is ready to be picked up. This is the start of the pickup window.
quote_id
string
ID for the Delivery Quote if one was provided when creating this Delivery.
related_deliveries
RelatedDelivery[]
A collection describing other jobs that share an association. i.e.: a return delivery.
status
string
The current status of the delivery. ALLOWED VALUES: pending,pickup,pickup_complete,dropoff,delivered,canceled,returned,ongoing
tip
integer
Amount in cents that will be paid to the courier as a tip.
tracking_url
string
This url can be used to track the courier during the delivery (unauthenticated page).
undeliverable_action
string
If a delivery was undeliverable, this field will contain the resulting action taken by the courier.
undeliverable_reason
string
If a delivery was undeliverable, this field will contain the reason why it was undeliverable.
updated
timestamp (RFC 3339)
Date/Time at which the delivery was last updated.
uuid
string
Alternative delivery identifier. “Id” field should be used for any identification purposes. “uuid” field is equally unique but loses contextual information (i.e. nothing in this identifier points out that it relates to a delivery). “uuid” is case-sensitive. Value for the “uuid” field is UUID v4 with ‘-’ characters removed.
| :— | :— | :— |
|ID |Description| Use case|
|External Order ID (optional)| Generated by: Merchant Use your own ID structure|
|UUID |Generated by: Uber. Unique order identifier created for every delivery.| When you need a single unique identifer|
|Abbreviated UUID| Generated by: Uber. Last 5 digits of the UUID.| Shown as “Order ID” in Courier app|
|Tokens |Generated by: Uber. We use three order tokens that track an order through 3 potential stages: Quote, delivery, and return. A token prefixed with dqt_ indicates the order is in the quote stage (A quote has been generated, but a delivery has not been created). del_ indicates the delivery stage (The delivery is in-progress), and ret_ indicates the order is in the return stage (The items are being returned to the merchant). You can track an order through its stages by referencing the same token, but prepending with the token identifier (e.g. dqt_XXXXXXXX becomes del_XXXXXXXX). These tokens are unique. | |
Response Body Parameters - CourierInfo
Name
Type
Description
name
string
Courier’s first name and last initial.
rating
float
[DEPRECATED] Courier’s rating on a scale of 1.0 to 5.0.
vehicle_type
string
The type of vehicle the courier is using. Currently support bicycle, car, van, truck, scooter, motorcycle, and walker.
phone_number
string
The courier’s phone number. This is a masked phone number that can only receive calls or SMS from the dropoff phone number.
location
LatLng
A latitude and longitude indicating courier’s location.
|Name Type| Description|
| :— | :— | :— |
|enabled |boolean| Flag for if a signature is required at this waypoint.|
|collect_signer_name |boolean| Flag for if the signer’s name is required at this waypoint.|
|collect_signer_relationship |boolean| Flag for if the signer’s relationship to the intended recipient is required at this waypoint.|
When set to true in POST requests, the delivery will require pincode entry at handoff.
value
string
The pincode that the customer must present at dropoff. This is a read-only field available in GET requests that will contain the internally generated pincode.
You can carry it with one hand e.g. bottle of water.
medium
string
You need a tote bag to carry it e.g. retail bag.
large
string
You need two hands to carry it e.g. computer monitor.
xlarge
string
You will need to make multiple trips to/from a vehicle to transport e.g. grocery order. Specifying xlarge will cause dispatch to only couriers using a car or larger (no walkers/bikes/scooters/etc…).
Indicating the nature of the delivery identified in related_deliveries. “original” for the forward leg of the trip, and “returned” for the return leg of the trip.