Drive API Specification (0.2.5)
Delivery Quote
Get a quote on delivery fee and validate coverage.
Request Body schema: application/json
external_delivery_id required | string (ExternalDeliveryId) /[a-zA-Z0-9-._~]+/ Unique ID generated by the caller for the delivery. |
locale | string (Locale) IETF BCP 47 compliant string representing a user's language preference, for the purpose of communication, e.g. |
pickup_address | string (Address) Comma separated full address, in the order appropriate for your locale. Overridden by store properties if external_store_id and external_business_id are used. |
pickup_business_name | string (AddressName) Optional name of the place, to help dashers find the location. Overridden by store properties if external_store_id and external_business_id are used. |
pickup_phone_number | string (Phone number) The phone number for the Dasher to call, including country code, if there are any issues with the pick up. The phone number must be a valid US phone number. Overridden by store properties if external_store_id and external_business_id are used. |
pickup_instructions | string (Instructions) Instructions for the Dasher to follow upon pickup of the order. |
pickup_reference_tag | string (ReferenceTag) A reference that can help dasher identify the correct delivery item for pickup/dropoff |
pickup_external_business_id | string (ExternalBusinessId) The string identifier used to create your business. Used in combination with external_store_id to select pickup store by ID. If you provide an external_business_id, you must also provide an external_store_id. This field is validated using the following regular expression: /^[A-Za-z0-9_-]{3,64}$/ |
pickup_external_store_id | string (ExternalStoreId) The string identifier used to create your store. If you provide an external_store_id, you must also provide an external_business_id. If you provide an external_store_id, the address of the store will override the pickup_address in the request. This field is validated using the following regular expression: /^[A-Za-z0-9_-]{3,64}$/ . |
dropoff_address required | string (Address) Comma separated full address, in the order appropriate for your locale. Overridden by store properties if external_store_id and external_business_id are used. |
dropoff_business_name | string (AddressName) Optional name of the place, to help dashers find the location. Overridden by store properties if external_store_id and external_business_id are used. |
dropoff_phone_number required | string (Phone number) The phone number for the Dasher to call, including country code, if there are any issues with the pick up. The phone number must be a valid US phone number. Overridden by store properties if external_store_id and external_business_id are used. |
dropoff_instructions | string (Instructions) Instructions for the Dasher to follow upon pickup of the order. |
dropoff_contact_given_name | string (GivenName) Given/first name of the contact; cannot contain ~, `, @, #, $, %, ^, &, *, +, =, ?, ;, [, {, ], } |
dropoff_contact_family_name | string (FamilyName) Family/last name of the contact; cannot contain ~, `, @, #, $, %, ^, &, *, +, =, ?, ;, [, {, ], } |
dropoff_contact_send_notifications | boolean (SendNotifications) Whether the contact will receive notifications from DoorDash for this delivery. The default is false. Cannot be updated. |
order_value | integer <int32> >= 0 The subtotal for all items in the order, excluding tax/tip, in cents. i.e. $19.99 = 1999 |
currency | string Currency of the order |
Array of objects (DeliveryItem) The items included in the order. | |
pickup_time | string (TimeDetails) Time details in ISO-8601 format. |
dropoff_time | string (TimeDetails) Time details in ISO-8601 format. |
object (TimeWindowDetails) The UTC date-time (in ISO-8601 format) overrides dropoff_time and pickup_time when all four parameters of the time window (i.e. pickup_window_start_time , pickup_window_end_time , dropoff_window_start_time , dropoff_window_end_time ) are provided. | |
object (TimeWindowDetails) The UTC date-time (in ISO-8601 format) overrides dropoff_time and pickup_time when all four parameters of the time window (i.e. pickup_window_start_time , pickup_window_end_time , dropoff_window_start_time , dropoff_window_end_time ) are provided. | |
contactless_dropoff | boolean (Contactless) Flag to specify if the delivery should be Contactless |
action_if_undeliverable | string (ActionIfUndeliverable) Enum: "return_to_pickup" "dispose" Enum to specify what should the dasher do if the delivery is undeliverable. The default is "dispose". |
tip | integer <int32> (Tip) >= 0 The tip amount in the lowest currency denomination (e.g. cents). i.e. $5.99 = 599 |
object (OrderContains) An object that specifies the restricted item(s) contained in this order | |
dasher_allowed_vehicles | Array of strings (DasherAllowedVehicles) Items Enum: "car" "bicycle" "walking" The vehicle type(s) that a Dasher can use to complete this delivery. Choose from 'car', 'bicycle' and/or 'walking'. |
dropoff_requires_signature | boolean (SignatureRequired) Flag to specify if the delivery requires signature verification during dropoff |
promotion_id | string (PromotionId) The ID of the promotion that you want to apply to the delivery. If the promotion ID is valid and the promotion is active, the response |
Responses
Request samples
- Payload
{- "external_delivery_id": "D-1763",
- "locale": "en-US",
- "pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "pickup_business_name": "Wells Fargo SF Downtown",
- "pickup_phone_number": "+16505555555",
- "pickup_instructions": "Enter gate code 1234 on the callbox.",
- "pickup_reference_tag": "Order number 61",
- "pickup_external_business_id": "ase-243-dzs",
- "pickup_external_store_id": "ase-243-dzs",
- "dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "dropoff_business_name": "Wells Fargo SF Downtown",
- "dropoff_phone_number": "+16505555555",
- "dropoff_instructions": "Enter gate code 1234 on the callbox.",
- "dropoff_contact_given_name": "John",
- "dropoff_contact_family_name": "Doe",
- "dropoff_contact_send_notifications": true,
- "order_value": 1999,
- "currency": "USD",
- "items": [
- {
- "name": "Mega Bean and Cheese Burrito",
- "description": "Mega Burrito contains the biggest beans of the land with extra cheese.",
- "quantity": 2,
- "external_id": "123-123443434b",
- "volume": 5.3,
- "weight": 2.8,
- "price": 1000
}
], - "pickup_time": "2018-08-22T17:20:28Z",
- "dropoff_time": "2018-08-22T17:20:28Z",
- "pickup_window": {
- "start_time": "2018-08-22T17:20:28Z",
- "end_time": "2018-08-22T17:20:28Z"
}, - "dropoff_window": {
- "start_time": "2018-08-22T17:20:28Z",
- "end_time": "2018-08-22T17:20:28Z"
}, - "contactless_dropoff": false,
- "action_if_undeliverable": "return_to_pickup",
- "tip": 599,
- "order_contains": {
- "alcohol": false
}, - "dasher_allowed_vehicles": [
- "car",
- "bicycle",
- "walking"
], - "dropoff_requires_signature": false,
- "promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c"
}
Response samples
- 200
- 400
- 403
- 409
- 422
- 500
{- "external_delivery_id": "D-1763",
- "locale": "en-US",
- "pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "pickup_business_name": "Wells Fargo SF Downtown",
- "pickup_phone_number": "+16505555555",
- "pickup_instructions": "Enter gate code 1234 on the callbox.",
- "pickup_reference_tag": "Order number 61",
- "pickup_external_business_id": "ase-243-dzs",
- "pickup_external_store_id": "ase-243-dzs",
- "dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "dropoff_business_name": "Wells Fargo SF Downtown",
- "dropoff_phone_number": "+16505555555",
- "dropoff_instructions": "Enter gate code 1234 on the callbox.",
- "dropoff_contact_given_name": "John",
- "dropoff_contact_family_name": "Doe",
- "dropoff_contact_send_notifications": true,
- "order_value": 1999,
- "currency": "USD",
- "items": [
- {
- "name": "Mega Bean and Cheese Burrito",
- "description": "Mega Burrito contains the biggest beans of the land with extra cheese.",
- "quantity": 2,
- "external_id": "123-123443434b",
- "volume": 5.3,
- "weight": 2.8,
- "price": 1000
}
], - "delivery_status": "quote",
- "cancellation_reason": "cancelled_by_creator",
- "updated_at": "2018-08-22T17:20:28Z",
- "pickup_time_estimated": "2018-08-22T17:20:28Z",
- "pickup_time_actual": "2018-08-22T17:20:28Z",
- "dropoff_time_estimated": "2018-08-22T17:20:28Z",
- "dropoff_time_actual": "2018-08-22T17:20:28Z",
- "return_time_estimated": "2018-08-22T17:20:28Z",
- "return_time_actual": "2018-08-22T17:20:28Z",
- "return_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "fee": 1900,
- "support_reference": "86313",
- "contactless_dropoff": false,
- "action_if_undeliverable": "return_to_pickup",
- "tip": 599,
- "order_contains": {
- "alcohol": false
}, - "dasher_allowed_vehicles": [
- "car",
- "bicycle",
- "walking"
], - "dropoff_requires_signature": false,
- "promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c",
- "dasher_id": 1232142,
- "dasher_name": "John D.",
- "dasher_dropoff_phone_number": "+15555555555",
- "dasher_pickup_phone_number": "+14444444444",
- "dasher_location": {
- "lat": 123.1312343,
- "lng": -37.2144343
}, - "dasher_vehicle_make": "Toyota",
- "dasher_vehicle_model": "Corolla",
- "dasher_vehicle_year": "2006"
}
Accept Delivery Quote
Accept Delivery Quote
path Parameters
external_delivery_id required | string (ExternalDeliveryId) /[a-zA-Z0-9-._~]+/ Example: D-1763 Unique (per developer) ID of the delivery. |
Request Body schema: application/json
tip | integer <int32> (Tip) >= 0 The tip amount in the lowest currency denomination (e.g. cents). i.e. $5.99 = 599 |
Responses
Request samples
- Payload
{- "tip": 599
}
Response samples
- 200
- 400
- 403
- 404
- 500
{- "external_delivery_id": "D-1763",
- "locale": "en-US",
- "pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "pickup_business_name": "Wells Fargo SF Downtown",
- "pickup_phone_number": "+16505555555",
- "pickup_instructions": "Enter gate code 1234 on the callbox.",
- "pickup_reference_tag": "Order number 61",
- "pickup_external_business_id": "ase-243-dzs",
- "pickup_external_store_id": "ase-243-dzs",
- "dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "dropoff_business_name": "Wells Fargo SF Downtown",
- "dropoff_phone_number": "+16505555555",
- "dropoff_instructions": "Enter gate code 1234 on the callbox.",
- "dropoff_contact_given_name": "John",
- "dropoff_contact_family_name": "Doe",
- "dropoff_contact_send_notifications": true,
- "order_value": 1999,
- "currency": "USD",
- "items": [
- {
- "name": "Mega Bean and Cheese Burrito",
- "description": "Mega Burrito contains the biggest beans of the land with extra cheese.",
- "quantity": 2,
- "external_id": "123-123443434b",
- "volume": 5.3,
- "weight": 2.8,
- "price": 1000
}
], - "delivery_status": "quote",
- "cancellation_reason": "cancelled_by_creator",
- "updated_at": "2018-08-22T17:20:28Z",
- "pickup_time_estimated": "2018-08-22T17:20:28Z",
- "pickup_time_actual": "2018-08-22T17:20:28Z",
- "dropoff_time_estimated": "2018-08-22T17:20:28Z",
- "dropoff_time_actual": "2018-08-22T17:20:28Z",
- "return_time_estimated": "2018-08-22T17:20:28Z",
- "return_time_actual": "2018-08-22T17:20:28Z",
- "return_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "fee": 1900,
- "support_reference": "86313",
- "contactless_dropoff": false,
- "action_if_undeliverable": "return_to_pickup",
- "tip": 599,
- "order_contains": {
- "alcohol": false
}, - "dasher_allowed_vehicles": [
- "car",
- "bicycle",
- "walking"
], - "dropoff_requires_signature": false,
- "promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c",
- "dasher_id": 1232142,
- "dasher_name": "John D.",
- "dasher_dropoff_phone_number": "+15555555555",
- "dasher_pickup_phone_number": "+14444444444",
- "dasher_location": {
- "lat": 123.1312343,
- "lng": -37.2144343
}, - "dasher_vehicle_make": "Toyota",
- "dasher_vehicle_model": "Corolla",
- "dasher_vehicle_year": "2006"
}
Create Delivery
Create a delivery
Request Body schema: application/json
external_delivery_id required | string (ExternalDeliveryId) /[a-zA-Z0-9-._~]+/ Unique ID generated by the caller for the delivery. |
locale | string (Locale) IETF BCP 47 compliant string representing a user's language preference, for the purpose of communication, e.g. |
pickup_address | string (Address) Comma separated full address, in the order appropriate for your locale. Overridden by store properties if external_store_id and external_business_id are used. |
pickup_business_name | string (AddressName) Optional name of the place, to help dashers find the location. Overridden by store properties if external_store_id and external_business_id are used. |
pickup_phone_number | string (Phone number) The phone number for the Dasher to call, including country code, if there are any issues with the pick up. The phone number must be a valid US phone number. Overridden by store properties if external_store_id and external_business_id are used. |
pickup_instructions | string (Instructions) Instructions for the Dasher to follow upon pickup of the order. |
pickup_reference_tag | string (ReferenceTag) A reference that can help dasher identify the correct delivery item for pickup/dropoff |
pickup_external_business_id | string (ExternalBusinessId) The string identifier used to create your business. Used in combination with external_store_id to select pickup store by ID. If you provide an external_business_id, you must also provide an external_store_id. This field is validated using the following regular expression: /^[A-Za-z0-9_-]{3,64}$/ |
pickup_external_store_id | string (ExternalStoreId) The string identifier used to create your store. If you provide an external_store_id, you must also provide an external_business_id. If you provide an external_store_id, the address of the store will override the pickup_address in the request. This field is validated using the following regular expression: /^[A-Za-z0-9_-]{3,64}$/ . |
dropoff_address required | string (Address) Comma separated full address, in the order appropriate for your locale. Overridden by store properties if external_store_id and external_business_id are used. |
dropoff_business_name | string (AddressName) Optional name of the place, to help dashers find the location. Overridden by store properties if external_store_id and external_business_id are used. |
dropoff_phone_number required | string (Phone number) The phone number for the Dasher to call, including country code, if there are any issues with the pick up. The phone number must be a valid US phone number. Overridden by store properties if external_store_id and external_business_id are used. |
dropoff_instructions | string (Instructions) Instructions for the Dasher to follow upon pickup of the order. |
dropoff_contact_given_name | string (GivenName) Given/first name of the contact; cannot contain ~, `, @, #, $, %, ^, &, *, +, =, ?, ;, [, {, ], } |
dropoff_contact_family_name | string (FamilyName) Family/last name of the contact; cannot contain ~, `, @, #, $, %, ^, &, *, +, =, ?, ;, [, {, ], } |
dropoff_contact_send_notifications | boolean (SendNotifications) Whether the contact will receive notifications from DoorDash for this delivery. The default is false. Cannot be updated. |
order_value | integer <int32> >= 0 The subtotal for all items in the order, excluding tax/tip, in cents. i.e. $19.99 = 1999 |
currency | string Currency of the order |
Array of objects (DeliveryItem) The items included in the order. | |
pickup_time | string (TimeDetails) Time details in ISO-8601 format. |
dropoff_time | string (TimeDetails) Time details in ISO-8601 format. |
object (TimeWindowDetails) The UTC date-time (in ISO-8601 format) overrides dropoff_time and pickup_time when all four parameters of the time window (i.e. pickup_window_start_time , pickup_window_end_time , dropoff_window_start_time , dropoff_window_end_time ) are provided. | |
object (TimeWindowDetails) The UTC date-time (in ISO-8601 format) overrides dropoff_time and pickup_time when all four parameters of the time window (i.e. pickup_window_start_time , pickup_window_end_time , dropoff_window_start_time , dropoff_window_end_time ) are provided. | |
contactless_dropoff | boolean (Contactless) Flag to specify if the delivery should be Contactless |
action_if_undeliverable | string (ActionIfUndeliverable) Enum: "return_to_pickup" "dispose" Enum to specify what should the dasher do if the delivery is undeliverable. The default is "dispose". |
tip | integer <int32> (Tip) >= 0 The tip amount in the lowest currency denomination (e.g. cents). i.e. $5.99 = 599 |
object (OrderContains) An object that specifies the restricted item(s) contained in this order | |
dasher_allowed_vehicles | Array of strings (DasherAllowedVehicles) Items Enum: "car" "bicycle" "walking" The vehicle type(s) that a Dasher can use to complete this delivery. Choose from 'car', 'bicycle' and/or 'walking'. |
dropoff_requires_signature | boolean (SignatureRequired) Flag to specify if the delivery requires signature verification during dropoff |
promotion_id | string (PromotionId) The ID of the promotion that you want to apply to the delivery. If the promotion ID is valid and the promotion is active, the response |
Responses
Request samples
- Payload
{- "external_delivery_id": "D-1763",
- "locale": "en-US",
- "pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "pickup_business_name": "Wells Fargo SF Downtown",
- "pickup_phone_number": "+16505555555",
- "pickup_instructions": "Enter gate code 1234 on the callbox.",
- "pickup_reference_tag": "Order number 61",
- "pickup_external_business_id": "ase-243-dzs",
- "pickup_external_store_id": "ase-243-dzs",
- "dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "dropoff_business_name": "Wells Fargo SF Downtown",
- "dropoff_phone_number": "+16505555555",
- "dropoff_instructions": "Enter gate code 1234 on the callbox.",
- "dropoff_contact_given_name": "John",
- "dropoff_contact_family_name": "Doe",
- "dropoff_contact_send_notifications": true,
- "order_value": 1999,
- "currency": "USD",
- "items": [
- {
- "name": "Mega Bean and Cheese Burrito",
- "description": "Mega Burrito contains the biggest beans of the land with extra cheese.",
- "quantity": 2,
- "external_id": "123-123443434b",
- "volume": 5.3,
- "weight": 2.8,
- "price": 1000
}
], - "pickup_time": "2018-08-22T17:20:28Z",
- "dropoff_time": "2018-08-22T17:20:28Z",
- "pickup_window": {
- "start_time": "2018-08-22T17:20:28Z",
- "end_time": "2018-08-22T17:20:28Z"
}, - "dropoff_window": {
- "start_time": "2018-08-22T17:20:28Z",
- "end_time": "2018-08-22T17:20:28Z"
}, - "contactless_dropoff": false,
- "action_if_undeliverable": "return_to_pickup",
- "tip": 599,
- "order_contains": {
- "alcohol": false
}, - "dasher_allowed_vehicles": [
- "car",
- "bicycle",
- "walking"
], - "dropoff_requires_signature": false,
- "promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c"
}
Response samples
- 200
- 400
- 403
- 409
- 422
- 500
{- "external_delivery_id": "D-1763",
- "locale": "en-US",
- "pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "pickup_business_name": "Wells Fargo SF Downtown",
- "pickup_phone_number": "+16505555555",
- "pickup_instructions": "Enter gate code 1234 on the callbox.",
- "pickup_reference_tag": "Order number 61",
- "pickup_external_business_id": "ase-243-dzs",
- "pickup_external_store_id": "ase-243-dzs",
- "dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "dropoff_business_name": "Wells Fargo SF Downtown",
- "dropoff_phone_number": "+16505555555",
- "dropoff_instructions": "Enter gate code 1234 on the callbox.",
- "dropoff_contact_given_name": "John",
- "dropoff_contact_family_name": "Doe",
- "dropoff_contact_send_notifications": true,
- "order_value": 1999,
- "currency": "USD",
- "items": [
- {
- "name": "Mega Bean and Cheese Burrito",
- "description": "Mega Burrito contains the biggest beans of the land with extra cheese.",
- "quantity": 2,
- "external_id": "123-123443434b",
- "volume": 5.3,
- "weight": 2.8,
- "price": 1000
}
], - "delivery_status": "quote",
- "cancellation_reason": "cancelled_by_creator",
- "updated_at": "2018-08-22T17:20:28Z",
- "pickup_time_estimated": "2018-08-22T17:20:28Z",
- "pickup_time_actual": "2018-08-22T17:20:28Z",
- "dropoff_time_estimated": "2018-08-22T17:20:28Z",
- "dropoff_time_actual": "2018-08-22T17:20:28Z",
- "return_time_estimated": "2018-08-22T17:20:28Z",
- "return_time_actual": "2018-08-22T17:20:28Z",
- "return_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "fee": 1900,
- "support_reference": "86313",
- "contactless_dropoff": false,
- "action_if_undeliverable": "return_to_pickup",
- "tip": 599,
- "order_contains": {
- "alcohol": false
}, - "dasher_allowed_vehicles": [
- "car",
- "bicycle",
- "walking"
], - "dropoff_requires_signature": false,
- "promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c",
- "dasher_id": 1232142,
- "dasher_name": "John D.",
- "dasher_dropoff_phone_number": "+15555555555",
- "dasher_pickup_phone_number": "+14444444444",
- "dasher_location": {
- "lat": 123.1312343,
- "lng": -37.2144343
}, - "dasher_vehicle_make": "Toyota",
- "dasher_vehicle_model": "Corolla",
- "dasher_vehicle_year": "2006"
}
Get Delivery Status
Get delivery status and details
path Parameters
external_delivery_id required | string (ExternalDeliveryId) /[a-zA-Z0-9-._~]+/ Example: D-1763 Unique (per developer) ID of the delivery. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 500
{- "external_delivery_id": "D-1763",
- "locale": "en-US",
- "pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "pickup_business_name": "Wells Fargo SF Downtown",
- "pickup_phone_number": "+16505555555",
- "pickup_instructions": "Enter gate code 1234 on the callbox.",
- "pickup_reference_tag": "Order number 61",
- "pickup_external_business_id": "ase-243-dzs",
- "pickup_external_store_id": "ase-243-dzs",
- "dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "dropoff_business_name": "Wells Fargo SF Downtown",
- "dropoff_phone_number": "+16505555555",
- "dropoff_instructions": "Enter gate code 1234 on the callbox.",
- "dropoff_contact_given_name": "John",
- "dropoff_contact_family_name": "Doe",
- "dropoff_contact_send_notifications": true,
- "order_value": 1999,
- "currency": "USD",
- "items": [
- {
- "name": "Mega Bean and Cheese Burrito",
- "description": "Mega Burrito contains the biggest beans of the land with extra cheese.",
- "quantity": 2,
- "external_id": "123-123443434b",
- "volume": 5.3,
- "weight": 2.8,
- "price": 1000
}
], - "delivery_status": "quote",
- "cancellation_reason": "cancelled_by_creator",
- "updated_at": "2018-08-22T17:20:28Z",
- "pickup_time_estimated": "2018-08-22T17:20:28Z",
- "pickup_time_actual": "2018-08-22T17:20:28Z",
- "dropoff_time_estimated": "2018-08-22T17:20:28Z",
- "dropoff_time_actual": "2018-08-22T17:20:28Z",
- "return_time_estimated": "2018-08-22T17:20:28Z",
- "return_time_actual": "2018-08-22T17:20:28Z",
- "return_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "fee": 1900,
- "support_reference": "86313",
- "contactless_dropoff": false,
- "action_if_undeliverable": "return_to_pickup",
- "tip": 599,
- "order_contains": {
- "alcohol": false
}, - "dasher_allowed_vehicles": [
- "car",
- "bicycle",
- "walking"
], - "dropoff_requires_signature": false,
- "promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c",
- "dasher_id": 1232142,
- "dasher_name": "John D.",
- "dasher_dropoff_phone_number": "+15555555555",
- "dasher_pickup_phone_number": "+14444444444",
- "dasher_location": {
- "lat": 123.1312343,
- "lng": -37.2144343
}, - "dasher_vehicle_make": "Toyota",
- "dasher_vehicle_model": "Corolla",
- "dasher_vehicle_year": "2006"
}
Update Delivery
Update the time or address for a delivery
path Parameters
external_delivery_id required | string (ExternalDeliveryId) /[a-zA-Z0-9-._~]+/ Example: D-1763 Unique (per developer) ID of the delivery. |
Request Body schema: application/json
pickup_address | string (Address) Comma separated full address, in the order appropriate for your locale. Overridden by store properties if external_store_id and external_business_id are used. |
pickup_business_name | string (AddressName) Optional name of the place, to help dashers find the location. Overridden by store properties if external_store_id and external_business_id are used. |
pickup_phone_number | string (Phone number) The phone number for the Dasher to call, including country code, if there are any issues with the pick up. The phone number must be a valid US phone number. Overridden by store properties if external_store_id and external_business_id are used. |
pickup_instructions | string (Instructions) Instructions for the Dasher to follow upon pickup of the order. |
pickup_reference_tag | string (ReferenceTag) A reference that can help dasher identify the correct delivery item for pickup/dropoff |
pickup_external_business_id | string (ExternalBusinessId) The string identifier used to create your business. Used in combination with external_store_id to select pickup store by ID. If you provide an external_business_id, you must also provide an external_store_id. This field is validated using the following regular expression: /^[A-Za-z0-9_-]{3,64}$/ |
pickup_external_store_id | string (ExternalStoreId) The string identifier used to create your store. If you provide an external_store_id, you must also provide an external_business_id. If you provide an external_store_id, the address of the store will override the pickup_address in the request. This field is validated using the following regular expression: /^[A-Za-z0-9_-]{3,64}$/ . |
dropoff_address | string (Address) Comma separated full address, in the order appropriate for your locale. Overridden by store properties if external_store_id and external_business_id are used. |
dropoff_business_name | string (AddressName) Optional name of the place, to help dashers find the location. Overridden by store properties if external_store_id and external_business_id are used. |
dropoff_phone_number | string (Phone number) The phone number for the Dasher to call, including country code, if there are any issues with the pick up. The phone number must be a valid US phone number. Overridden by store properties if external_store_id and external_business_id are used. |
dropoff_instructions | string (Instructions) Instructions for the Dasher to follow upon pickup of the order. |
dropoff_contact_given_name | string (GivenName) Given/first name of the contact; cannot contain ~, `, @, #, $, %, ^, &, *, +, =, ?, ;, [, {, ], } |
dropoff_contact_family_name | string (FamilyName) Family/last name of the contact; cannot contain ~, `, @, #, $, %, ^, &, *, +, =, ?, ;, [, {, ], } |
dropoff_contact_send_notifications | boolean (SendNotifications) Whether the contact will receive notifications from DoorDash for this delivery. The default is false. Cannot be updated. |
contactless_dropoff | boolean (Contactless) Flag to specify if the delivery should be Contactless |
action_if_undeliverable | string (ActionIfUndeliverable) Enum: "return_to_pickup" "dispose" Enum to specify what should the dasher do if the delivery is undeliverable. The default is "dispose". |
tip | integer <int32> (Tip) >= 0 The tip amount in the lowest currency denomination (e.g. cents). i.e. $5.99 = 599 |
object (OrderContains) An object that specifies the restricted item(s) contained in this order | |
dasher_allowed_vehicles | Array of strings (DasherAllowedVehicles) Items Enum: "car" "bicycle" "walking" The vehicle type(s) that a Dasher can use to complete this delivery. Choose from 'car', 'bicycle' and/or 'walking'. |
dropoff_requires_signature | boolean (SignatureRequired) Flag to specify if the delivery requires signature verification during dropoff |
promotion_id | string (PromotionId) The ID of the promotion that you want to apply to the delivery. If the promotion ID is valid and the promotion is active, the response |
order_value | integer <int32> >= 0 The subtotal for all items in the order, excluding tax/tip, in cents. i.e. $19.99 = 1999 |
currency | string Currency of the order |
Array of objects (DeliveryItem) The items included in the order. | |
pickup_time | string (TimeDetails) Time details in ISO-8601 format. |
dropoff_time | string (TimeDetails) Time details in ISO-8601 format. |
object (TimeWindowDetails) The UTC date-time (in ISO-8601 format) overrides dropoff_time and pickup_time when all four parameters of the time window (i.e. pickup_window_start_time , pickup_window_end_time , dropoff_window_start_time , dropoff_window_end_time ) are provided. | |
object (TimeWindowDetails) The UTC date-time (in ISO-8601 format) overrides dropoff_time and pickup_time when all four parameters of the time window (i.e. pickup_window_start_time , pickup_window_end_time , dropoff_window_start_time , dropoff_window_end_time ) are provided. |
Responses
Request samples
- Payload
{- "pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "pickup_business_name": "Wells Fargo SF Downtown",
- "pickup_phone_number": "+16505555555",
- "pickup_instructions": "Enter gate code 1234 on the callbox.",
- "pickup_reference_tag": "Order number 61",
- "pickup_external_business_id": "ase-243-dzs",
- "pickup_external_store_id": "ase-243-dzs",
- "dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "dropoff_business_name": "Wells Fargo SF Downtown",
- "dropoff_phone_number": "+16505555555",
- "dropoff_instructions": "Enter gate code 1234 on the callbox.",
- "dropoff_contact_given_name": "John",
- "dropoff_contact_family_name": "Doe",
- "dropoff_contact_send_notifications": true,
- "contactless_dropoff": false,
- "action_if_undeliverable": "return_to_pickup",
- "tip": 599,
- "order_contains": {
- "alcohol": false
}, - "dasher_allowed_vehicles": [
- "car",
- "bicycle",
- "walking"
], - "dropoff_requires_signature": false,
- "promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c",
- "order_value": 1999,
- "currency": "USD",
- "items": [
- {
- "name": "Mega Bean and Cheese Burrito",
- "description": "Mega Burrito contains the biggest beans of the land with extra cheese.",
- "quantity": 2,
- "external_id": "123-123443434b",
- "volume": 5.3,
- "weight": 2.8,
- "price": 1000
}
], - "pickup_time": "2018-08-22T17:20:28Z",
- "dropoff_time": "2018-08-22T17:20:28Z",
- "pickup_window": {
- "start_time": "2018-08-22T17:20:28Z",
- "end_time": "2018-08-22T17:20:28Z"
}, - "dropoff_window": {
- "start_time": "2018-08-22T17:20:28Z",
- "end_time": "2018-08-22T17:20:28Z"
}
}
Response samples
- 200
- 400
- 403
- 404
- 409
- 422
- 500
{- "external_delivery_id": "D-1763",
- "locale": "en-US",
- "pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "pickup_business_name": "Wells Fargo SF Downtown",
- "pickup_phone_number": "+16505555555",
- "pickup_instructions": "Enter gate code 1234 on the callbox.",
- "pickup_reference_tag": "Order number 61",
- "pickup_external_business_id": "ase-243-dzs",
- "pickup_external_store_id": "ase-243-dzs",
- "dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "dropoff_business_name": "Wells Fargo SF Downtown",
- "dropoff_phone_number": "+16505555555",
- "dropoff_instructions": "Enter gate code 1234 on the callbox.",
- "dropoff_contact_given_name": "John",
- "dropoff_contact_family_name": "Doe",
- "dropoff_contact_send_notifications": true,
- "order_value": 1999,
- "currency": "USD",
- "items": [
- {
- "name": "Mega Bean and Cheese Burrito",
- "description": "Mega Burrito contains the biggest beans of the land with extra cheese.",
- "quantity": 2,
- "external_id": "123-123443434b",
- "volume": 5.3,
- "weight": 2.8,
- "price": 1000
}
], - "delivery_status": "quote",
- "cancellation_reason": "cancelled_by_creator",
- "updated_at": "2018-08-22T17:20:28Z",
- "pickup_time_estimated": "2018-08-22T17:20:28Z",
- "pickup_time_actual": "2018-08-22T17:20:28Z",
- "dropoff_time_estimated": "2018-08-22T17:20:28Z",
- "dropoff_time_actual": "2018-08-22T17:20:28Z",
- "return_time_estimated": "2018-08-22T17:20:28Z",
- "return_time_actual": "2018-08-22T17:20:28Z",
- "return_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "fee": 1900,
- "support_reference": "86313",
- "contactless_dropoff": false,
- "action_if_undeliverable": "return_to_pickup",
- "tip": 599,
- "order_contains": {
- "alcohol": false
}, - "dasher_allowed_vehicles": [
- "car",
- "bicycle",
- "walking"
], - "dropoff_requires_signature": false,
- "promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c",
- "dasher_id": 1232142,
- "dasher_name": "John D.",
- "dasher_dropoff_phone_number": "+15555555555",
- "dasher_pickup_phone_number": "+14444444444",
- "dasher_location": {
- "lat": 123.1312343,
- "lng": -37.2144343
}, - "dasher_vehicle_make": "Toyota",
- "dasher_vehicle_model": "Corolla",
- "dasher_vehicle_year": "2006"
}
Cancel Delivery
Cancel delivery
path Parameters
external_delivery_id required | string (ExternalDeliveryId) /[a-zA-Z0-9-._~]+/ Example: D-1763 Unique (per developer) ID of the delivery. |
Responses
Response samples
- 200
- 400
- 403
- 404
- 409
- 500
{- "external_delivery_id": "D-1763",
- "locale": "en-US",
- "pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "pickup_business_name": "Wells Fargo SF Downtown",
- "pickup_phone_number": "+16505555555",
- "pickup_instructions": "Enter gate code 1234 on the callbox.",
- "pickup_reference_tag": "Order number 61",
- "pickup_external_business_id": "ase-243-dzs",
- "pickup_external_store_id": "ase-243-dzs",
- "dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "dropoff_business_name": "Wells Fargo SF Downtown",
- "dropoff_phone_number": "+16505555555",
- "dropoff_instructions": "Enter gate code 1234 on the callbox.",
- "dropoff_contact_given_name": "John",
- "dropoff_contact_family_name": "Doe",
- "dropoff_contact_send_notifications": true,
- "order_value": 1999,
- "currency": "USD",
- "items": [
- {
- "name": "Mega Bean and Cheese Burrito",
- "description": "Mega Burrito contains the biggest beans of the land with extra cheese.",
- "quantity": 2,
- "external_id": "123-123443434b",
- "volume": 5.3,
- "weight": 2.8,
- "price": 1000
}
], - "delivery_status": "quote",
- "cancellation_reason": "cancelled_by_creator",
- "updated_at": "2018-08-22T17:20:28Z",
- "pickup_time_estimated": "2018-08-22T17:20:28Z",
- "pickup_time_actual": "2018-08-22T17:20:28Z",
- "dropoff_time_estimated": "2018-08-22T17:20:28Z",
- "dropoff_time_actual": "2018-08-22T17:20:28Z",
- "return_time_estimated": "2018-08-22T17:20:28Z",
- "return_time_actual": "2018-08-22T17:20:28Z",
- "return_address": "901 Market Street 6th Floor San Francisco, CA 94103",
- "fee": 1900,
- "support_reference": "86313",
- "contactless_dropoff": false,
- "action_if_undeliverable": "return_to_pickup",
- "tip": 599,
- "order_contains": {
- "alcohol": false
}, - "dasher_allowed_vehicles": [
- "car",
- "bicycle",
- "walking"
], - "dropoff_requires_signature": false,
- "promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c",
- "dasher_id": 1232142,
- "dasher_name": "John D.",
- "dasher_dropoff_phone_number": "+15555555555",
- "dasher_pickup_phone_number": "+14444444444",
- "dasher_location": {
- "lat": 123.1312343,
- "lng": -37.2144343
}, - "dasher_vehicle_make": "Toyota",
- "dasher_vehicle_model": "Corolla",
- "dasher_vehicle_year": "2006"
}
Create Business
Create a Drive business.
Request Body schema: application/json
external_business_id required | string (business_ExternalBusinessId) /^[A-Za-z0-9_-]{3,64}$/ Unique, caller-selected ID of the business. |
name required | string (Business Name) Any non empty string Human readable name for the business. Used when the details of a business are shown to a customer, Dasher, merchant, or support agent. |
description | string (BusinessDescription) Any non empty string Short description of the business. Used in the DoorDash Merchant Portal. Maximum length of description is 100 characters |
activation_status | string (BusinessActivationStatus) Enum: "initiated" "pending_external_activation" "pending_legal_agreement" "abandoned" "failed" "active" "inactive" Activation status of the business. Used primarily for the automatic self-serve onboarding flow. |
Responses
Request samples
- Payload
{- "external_business_id": "a0720d55-7cbe-41ce-8185-58285b7985cd",
- "name": "Neighborhood Deli",
- "description": "A neighborhood deli serving many tasty sandwiches and soups.",
- "activation_status": "active"
}
Response samples
- 200
- 400
- 403
- 500
{- "name": "Neighborhood Deli",
- "description": "A neighborhood deli serving many tasty sandwiches and soups.",
- "external_business_id": "a0720d55-7cbe-41ce-8185-58285b7985cd",
- "activation_status": "active",
- "created_at": "2022-04-25T17:21:43Z",
- "last_updated_at": "2022-04-25T17:21:43Z",
- "is_test": false,
- "external_metadata": {
- "number_of_stores": 10,
- "client_phone_number": "+12065551212"
}
}
List Businesses
List the businesses owned by a developer.
query Parameters
activationStatus | string (BusinessActivationStatus) Enum: "initiated" "pending_external_activation" "pending_legal_agreement" "abandoned" "failed" "active" "inactive" Example: activationStatus="active" Activation status of the business. Used primarily for the automatic self-serve onboarding flow. |
continuationToken | string |
Responses
Response samples
- 200
- 400
- 403
- 500
{- "result": [
- {
- "name": "Neighborhood Deli",
- "description": "A neighborhood deli serving many tasty sandwiches and soups.",
- "external_business_id": "a0720d55-7cbe-41ce-8185-58285b7985cd",
- "activation_status": "active",
- "created_at": "2022-04-25T17:21:43Z",
- "last_updated_at": "2022-04-25T17:21:43Z",
- "is_test": false,
- "external_metadata": {
- "number_of_stores": 10,
- "client_phone_number": "+12065551212"
}
}
], - "continuation_token": "string",
- "result_count": 0
}
Get Business
Get the details of a business.
path Parameters
external_business_id required | string Unique, caller-selected ID of the business. Validated using the following regular expression: |
Responses
Response samples
- 200
- 400
- 403
- 404
- 500
{- "name": "Neighborhood Deli",
- "description": "A neighborhood deli serving many tasty sandwiches and soups.",
- "external_business_id": "a0720d55-7cbe-41ce-8185-58285b7985cd",
- "activation_status": "active",
- "created_at": "2022-04-25T17:21:43Z",
- "last_updated_at": "2022-04-25T17:21:43Z",
- "is_test": false,
- "external_metadata": {
- "number_of_stores": 10,
- "client_phone_number": "+12065551212"
}
}
Update Business
Update the attributes of a business.
path Parameters
external_business_id required | string Unique, caller-selected ID of the business. Validated using the following regular expression: |
Request Body schema: application/json
name | string (Business Name) Any non empty string Human readable name for the business. Used when the details of a business are shown to a customer, Dasher, merchant, or support agent. |
description | string (BusinessDescription) Any non empty string Short description of the business. Used in the DoorDash Merchant Portal. Maximum length of description is 100 characters |
activation_status | string (BusinessActivationStatus) Enum: "initiated" "pending_external_activation" "pending_legal_agreement" "abandoned" "failed" "active" "inactive" Activation status of the business. Used primarily for the automatic self-serve onboarding flow. |
Responses
Request samples
- Payload
{- "name": "Neighborhood Deli",
- "description": "A neighborhood deli serving many tasty sandwiches and soups.",
- "activation_status": "active"
}
Response samples
- 200
- 400
- 403
- 404
- 500
{- "name": "Neighborhood Deli",
- "description": "A neighborhood deli serving many tasty sandwiches and soups.",
- "external_business_id": "a0720d55-7cbe-41ce-8185-58285b7985cd",
- "activation_status": "active",
- "created_at": "2022-04-25T17:21:43Z",
- "last_updated_at": "2022-04-25T17:21:43Z",
- "is_test": false,
- "external_metadata": {
- "number_of_stores": 10,
- "client_phone_number": "+12065551212"
}
}
Create Store
Create a Drive store.
path Parameters
external_business_id required | string Unique, caller-selected ID of the business. Validated using the following regular expression: |
Request Body schema: application/json
external_store_id required | string (store_ExternalStoreId) /^[A-Za-z0-9_-]{3,64}$/ A unique ID for the store, selected or generated by the API caller. |
name required | string (Store Name) Any non empty string The name of the store. |
phone_number | string (store_PhoneNumber) Any non empty string, validated by country Phone number of the store. Used when a customer, Dasher, or support agent needs to contact the store. |
address required | string (store_Address) Any non empty string The full address of the store, in the order appropriate for your locale, with each element separated by a comma. |
Responses
Request samples
- Payload
{- "external_store_id": "ed178ef3-b486-4ce8-8baa-5bc9f0f3fa4a",
- "name": "Neighborhood Deli #10",
- "phone_number": "+12065551212",
- "address": "901 Market Street, 6th Floor, San Francisco, CA, 94103"
}
Response samples
- 200
- 400
- 403
- 404
- 500
{- "name": "Neighborhood Deli #10",
- "external_business_id": "a0720d55-7cbe-41ce-8185-58285b7985cd",
- "external_store_id": "ed178ef3-b486-4ce8-8baa-5bc9f0f3fa4a",
- "phone_number": "+12065551212",
- "address": "901 Market Street, 6th Floor, San Francisco, CA, 94103",
- "status": "active",
- "is_test": false,
- "created_at": "2022-04-25T17:21:43Z",
- "last_updated_at": "2022-04-25T17:21:43Z"
}
List Stores
List the stores under a business.
path Parameters
external_business_id required | string Unique, caller-selected ID of the business. Validated using the following regular expression: |
query Parameters
activationStatus | string (StoreActivationStatus) Enum: "active" "inactive" Activation status of the store. |
continuationToken | string |
Responses
Response samples
- 200
- 400
- 403
- 404
- 500
{- "result": [
- {
- "name": "Neighborhood Deli #10",
- "external_business_id": "a0720d55-7cbe-41ce-8185-58285b7985cd",
- "external_store_id": "ed178ef3-b486-4ce8-8baa-5bc9f0f3fa4a",
- "phone_number": "+12065551212",
- "address": "901 Market Street, 6th Floor, San Francisco, CA, 94103",
- "status": "active",
- "is_test": false,
- "created_at": "2022-04-25T17:21:43Z",
- "last_updated_at": "2022-04-25T17:21:43Z"
}
], - "continuation_token": "string",
- "result_count": 0
}
Get Store
Get the details of a store.
path Parameters
external_business_id required | string Unique, caller-selected ID of the business. Validated using the following regular expression: |
external_store_id required | string Unique, caller-selected ID for the store. Validated using the following regular expression: |
Responses
Response samples
- 200
- 400
- 403
- 404
- 500
{- "name": "Neighborhood Deli #10",
- "external_business_id": "a0720d55-7cbe-41ce-8185-58285b7985cd",
- "external_store_id": "ed178ef3-b486-4ce8-8baa-5bc9f0f3fa4a",
- "phone_number": "+12065551212",
- "address": "901 Market Street, 6th Floor, San Francisco, CA, 94103",
- "status": "active",
- "is_test": false,
- "created_at": "2022-04-25T17:21:43Z",
- "last_updated_at": "2022-04-25T17:21:43Z"
}
Update Store
Update the attributes of a store.
path Parameters
external_business_id required | string Unique, caller-selected ID of the business. Validated using the following regular expression: |
external_store_id required | string Unique, caller-selected ID for the store. Validated using the following regular expression: |
Request Body schema: application/json
name | string (Store Name) Any non empty string The name of the store. |
phone_number | string (store_PhoneNumber) Any non empty string, validated by country Phone number of the store. Used when a customer, Dasher, or support agent needs to contact the store. |
address | string (store_Address) Any non empty string The full address of the store, in the order appropriate for your locale, with each element separated by a comma. |
Responses
Request samples
- Payload
{- "name": "Neighborhood Deli #10",
- "phone_number": "+12065551212",
- "address": "901 Market Street, 6th Floor, San Francisco, CA, 94103"
}
Response samples
- 200
- 400
- 403
- 404
- 500
{- "name": "Neighborhood Deli #10",
- "external_business_id": "a0720d55-7cbe-41ce-8185-58285b7985cd",
- "external_store_id": "ed178ef3-b486-4ce8-8baa-5bc9f0f3fa4a",
- "phone_number": "+12065551212",
- "address": "901 Market Street, 6th Floor, San Francisco, CA, 94103",
- "status": "active",
- "is_test": false,
- "created_at": "2022-04-25T17:21:43Z",
- "last_updated_at": "2022-04-25T17:21:43Z"
}