Drive API (2.0.35)

Last updated: Aug 13th, 2025

Release Notes

2.0.35 2025/08/21

Add serviceability check endpoint for faster validation

2.0.34 2025/08/13

Add ReturnPinCodeVerificationMetadata for create delivery request

2.0.33 2025/07/07

Update action_if_undeliverable for create delivery request

2.0.32 2025/07/06

Move location (lat/lng) inside address object in auto-complete response

2.0.31 2025/06/25

Update address auto-complete endpoint to use POST method

2.0.30 2025/06/24

Add address auto-complete endpoint for address suggestions with location-based search

2.0.29 2025/06/11

Remove regex for Drive V2 ExternalStoreId spec to match current implementation / validations

2.0.28 2025/05/29

Add dropoff_location_metadata field with h3_index support for nested location specification

2.0.27 2025/03/04

Add exact_time and day in Drive V2 as objects

2.0.26 2025/02/25

Add substitute_item_ids_additional_metadata and SubstituteItemMetadata in Drive V2

2.0.25 2025/02/24

Add ShippingLabelMetadata into drive v2 api

2.0.24 2025/02/19

Add customer_expected_sla and expires_by in Drive V2

2.0.23 2025/01/29

Add substitution recommendation API for Dasher Shop

2.0.22 2024/08/20

Add pdf format for shipping_label configuration

2.0.21 2024/08/20

Support drive checkout audit signal in Drive v2

2.0.20 2024/08/06

Add merchant_recommended_substitute_ids to item_options

2.0.19 2024/07/30

Update pin_code feature enablement information to contact DD

2.0.18 2024/07/16

Update pin_code description in proof_of_delivery

2.0.17 2024/06/07

Add "otc" to order contains

2.0.16 2024/05/16

Add "tobacco" and "hemp" to order contains

2.0.15 2024/02/05

Add "catering_setup" to dropoff options

2.0.14 2024/01/25

Add "large_order" to order fulfillment method

2.0.13 2023/12/08

Deprecate 'photo_preferred' from dropoff options

2.0.12 2023/12/06

Deprecate 'catering' from order fulfillment method

2.0.11 2023/09/28

Allow 'dropoff_phone_number' to be updated in the Accept Quote endpoint

2.0.10 2023/08/07

Remove 'dropoff_phone_number' from Accept Quote endpoint

2.0.9 2023/07/26

Update shipping_label sample string

2.0.8 2023/07/10

Update Parcels v2 API external_id description
Update shipping_label example

2.0.7 2023/06/28

Update Drive v2 API errors

2.0.6 2023/06/26

Allow 'dropoff_phone_number' to be updated in the Accept Quote endpoint

2.0.5 2023/06/07

Update printing density enum

2.0.4 2023/06/07

Added shipping_label to Delivery response

2.0.3 2023/06/05

Support Midmile in Drive v2

2.0.2 2023/05/17

Support DSD/DSS in Drive v2

2.0.1 2023/04/25

Removed URL Markdown in patterns (not supported)
Updated numerous descriptions

2.0.0 2023/04/25

Updated numerous descriptions
Reset version to 2.0.0

0.3.3 2023/04/21

Remove currency field from quote, create and update delivery request in Drive v2

0.3.2 2023/04/12

Support barcode in Drive v2

0.3.1 2023/04/11

Updated numerous descriptions

0.3.0 2023/3/02

Support fee and tax breakdown in Drive v2

0.2.6 2023/1/20

Support cash on delivery in Drive v2

0.2.5 2023/1/10

Support promotion ids in Drive v2

0.2.4 2022/10/12

Support items

0.2.3 2022/10/12

Support dasher allowed vehicles

0.2.2 2022/08/15

Support alcohol delivery in drive v2

0.2.1 2022/06/06

Adding pickup external store and external business ID

0.2.0 2022/04/11

Support returnable delivery

0.1.4 2022/04/05

Add dropoff contact given name
Add dropoff contact family name
Add dropoff contact send sms notifications

0.1.3 2022/04/05

Add pickup verification image url
Add dropoff verification image url

0.1.2 2022/01/27

Properly marking all required fields

0.1.1 2022/01/13

Updated contactless flag name
Added parameters to support scheduled deliveries
remove scheduling model

0.0.15 2021/12/07

addded locale

0.0.14 12/03/2021

Added driver_reference_tag

0.0.13 (internal release) 2021/11/24

Added contactless flag
Added tip support
Updated cancellation failure reasons

0.0.12 (internal release) 2021/11/09

removed tracking url/support reference from input
addded explicit "delivery outputs" class

0.0.11 (internal release) 2021/11/05

added authorization errors

0.0.10 (internal release) 2021/11/01

external ID is no longer UUID
add support ID to delivery response
add tracking URL for delivery tracking

0.0.9 (internal release) 2021/10/18

move scheduling_model into it's own subtype

0.0.8 (internal release) 2021/10/16

converted all operations models into types with allOf to mixin values
converted all operations parameters to types

0.0.7 (internal release) 2021/10/15

removed _cents suffix for i18n coolness
removed dropoff/pickup locations from all APIs for now
All addresses are just one string, not nested
Created UUID type
Added optional pickup_business_name/dropoff_business_name

0.0.6 (internal release) 2021/10/14

rename estimates to quote
add accept quote endpoint
match create and quote input and response

0.0.5 (internal release) 2021/10/12

order_value_cents is now optional
removed tips
switch to full addresses instead of address_map {city, zipcode etc)
addded optional place name to address field

0.0.4 (internal release) 2021/10/04

update the estimate & create to have consistent input

0.0.3 (internal release)

combined pickup / dropoff details into Objective type
added optional Location to pickup/dropoff
added new SchedulingModel type (ASAP only for now) to explicitly set scheduling logic

0.0.2 (internal release)

updated statuses logic and enums

0.0.1 (internal release)

initial version

Delivery

Create Quote

Confirm that a delivery is serviceable by DoorDash and what it would cost by creating a quote. Get a quote on delivery fee and validate coverage. Learn how to use this API in the Create & Accept Quotes how-to guide.

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) The language DoorDash should use when sending updates about this delivery. Supported locales : `en-US`, `fr-CA`, `es-US`.
order_fulfillment_method	string (OrderFulfillmentMethod) Enum: "standard" "catering" "shop_stage" "shop_deliver" "parcel" "large_order" "shop_handoff" Type of fulfillment required for Delivery ("shop_stage", "shop_deliver", "shop_handoff" for DSS/DSD/DSH delivery; "parcel" for parcel delivery. "catering" is deprecated.)
origin_facility_id	string (OriginFacilityId) Merchant warehouse id for the midmile
pickup_address	string (PickupAddress) Comma-separated full address, in the order appropriate for your locale. Overridden by store properties if pickup_external_store_id and pickup_external_business_id are used.
pickup_business_name	string (PickupAddressName) Optional name of the place, to help Dashers find the location. Overridden by store properties if pickup_external_store_id and pickup_external_business_id are used.
pickup_phone_number	string (Pickup Phone number) The phone number for the Dasher to call if there are any issues with the pick up. Should include the country code and must match the country of the store for which the delivery is created. Overridden by store properties if pickup_external_store_id and pickup_external_business_id are used. Must adhere to E.164 international phone number standard.
pickup_instructions	string (PickupInstructions) Instructions for the Dasher to follow when picking up the order.
pickup_reference_tag	string (ReferenceTag) A reference that can help Dasher identify the correct delivery item for pick up/drop-off.
pickup_external_business_id	string (ExternalBusinessId) /^[A-Za-z0-9_-]{3,64}$/ The string identifier used to create your business. Used in combination with pickup_external_store_id to select the pick up location. If you provide an pickup_external_business_id, you must also provide an pickup_external_store_id.
pickup_external_store_id	string (ExternalStoreId) The string identifier used to create your store. If you provide an pickup_external_store_id, you must also provide an pickup_external_business_id. If you provide an pickup_external_store_id, the address of the store will override the pickup_address in the request. Some examples would look like this: "ase-243-dzs", "09", "#00012"
	object (PickupVerificationMetadata) Optional pickup verification metadata. Use this to enable order level pickup verification
dropoff_address required	string (DropoffAddress) Comma-separated full address, in the order appropriate for your locale.
dropoff_business_name	string (DropoffAddressName) Optional name of the place, to help Dashers find the location.
	object (Location) [Pre-release field: submit a ticket in the Developer Portal or reach out to your DoorDash contact if you would like to provide precise location information.] The precise location, as latitude and longitude, of the drop-off. If your request includes both location and address, location will be used for Dasher navigation only; address will be used for fee and serviceability checks.
dropoff_phone_number required	string (Drop-off Phone number) The phone number for the Dasher to call if there are any issues with the delivery. Should include the country code. Must adhere to E.164 international phone number standard
dropoff_instructions	string (DropoffInstructions) /^[A-Za-z0-9_-]{3,64}$/ Instructions for the Dasher to follow when picking up the order.
dropoff_contact_given_name	string (GivenName) [^~`@#\$%\^&\*\+=\?;\[{\]\}] Given/first name of the contact.
dropoff_contact_family_name	string (FamilyName) [^~`@#\$%\^&\*\+=\?;\[{\]\}] Family/last name of the contact.
dropoff_contact_send_notifications	boolean (SendNotifications) Whether the contact will receive notifications from DoorDash for this delivery. The default is true.
	object (DropoffOptions) Additional options for drop off
	United States (object) or Canada (object) or Australia (object) or New Zealand (object) (DropoffAddressComponents) The Dropoff address broken down into independent components.
	object (DropoffPinCodeVerificationMetadata) An object that specifies the dropoff pin code verification related details for this order. When "pin_code" is set in "dropoff_options.proof_of_delivery", the object must include relevant pin code data. Conversely, if "pin_code" is not set as "proof_of_delivery", the object should exclude any pin code data. Pin Code can be enabled only for orders that are non-contactless and not unattended deliveries. Please reach out to Doordash to enable this feature for your business.
	object (ReturnPinCodeVerificationMetadata) Specifies the pin code verification details for returns. An object that specifies the dropoff pin code verification related details for this order.
	object (ShoppingOptions) Details about how to shop and pay for the delivery for shop_deliver and shop_stage orders
order_value	integer <int32> (OrderValue) >= 0 The subtotal for all items in the order, excluding tax/tip, in the lowest currency denomination (e.g. cents). i.e. $19.99 = 1999.
	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 (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 (pickup_window_start_time , pickup_window_end_time , dropoff_window_start_time , dropoff_window_end_time) are provided.
	Day (object) or Time_Stamp (object) (CustomerExpectedSla) The expected delivery time or date shown to the customer.
	Day (object) or Time_Stamp (object) (ExpiresBy) The last time or date the order can be delivered before expiration
	object (ShippingLabelMetadata) A JSON document that allows adding metadata about the shipping label such as sort_code, etc. Please reach out to Doordash to enable this feature for your business.
contactless_dropoff	boolean (Contactless) Whether the delivery should be contactless, which prompts a Dasher to take a picture of the delivery at drop-off.
action_if_undeliverable	string (ActionIfUndeliverable) Enum: "return_to_pickup" "dispose" What the Dasher should do if the delivery is undeliverable. If left blank, the order will be treated as contactless. See Create return to pickup deliveries for more information.
tip	integer <int32> (Tip) >= 0 The tip amount. Use cents or the equivalent lowest currency denomination (e.g. $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. The default is "car".
dropoff_requires_signature	boolean (SignatureRequired) Whether the delivery requires signature verification during drop-off.
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 `fee` will be adjusted according to the details of the promotion. Create a support ticket to setup a promotion or if your promotion ID isn't working.
dropoff_cash_on_delivery	integer <int32> >= 0 The cash to collect when this order is dropped off, value in the lowest currency denomination (e.g. cents). i.e. $19.99 = 1999. [Pre-release field: Submit a ticket or reach out to your DoorDash contact if you would like to accept cash on delivery.]
order_route_type	string (OrderRouteType) Value: "roundtrip" Type of route required for the delivery ("roundtrip" for deliveries that require the Dasher to return to the pickup location after dropoff). If this field is not specified, the default type is the standard point to point delivery.
order_route_items	Array of strings (OrderRouteItems) Items Enum: "check" "cash" "pizza_bag"

Responses

Request samples

Payload

Content type

application/json

{"external_delivery_id": "D-1763",
"locale": "en-US, fr-CA, es-US",
"order_fulfillment_method": "standard",
"origin_facility_id": "MERCHANTA-CA-1",
"pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"pickup_business_name": "Wells Fargo SF Downtown",
"pickup_phone_number": "+16505555555",
"pickup_instructions": "Go to the bar for pick up.",
"pickup_reference_tag": "Order number 61",
"pickup_external_business_id": "ase-243-dzs",
"pickup_external_store_id": "ase-243-dzs",
"pickup_verification_metadata": {"verification_type": "SCAN_BARCODE",
"verification_code": "12345",
"verification_format": "CODE_39"
},
"dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"dropoff_business_name": "The Avery Condominium",
"dropoff_location": {"lat": 123.1312343,
"lng": -37.2144343
},
"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,
"dropoff_options": {"signature": "required",
"id_verification": "required",
"proof_of_delivery": "photo_required",
"catering_setup": "required"
},
"dropoff_address_components": {"street_address": "901 Market Street",
"sub_premise": "Apt. 121",
"city": "San Francisco",
"state": "CA",
"zip_code": 94103,
"country": "US"
},
"dropoff_pin_code_verification_metadata": {"pin_code_type": "customer_phone_number",
"pin_code_value": "1234"
},
"return_dropoff_pin_code_verification_metadata": {"pin_code_type": "merchant_provided_number",
"pin_code_value": "1234"
},
"shopping_options": {"payment_method": "red_card",
"payment_barcode": "12345",
"payment_gift_cards": ["123443434",
"123443435"
],
"ready_for_pickup_by": "2018-08-22T17:20:28Z",
"dropoff_contact_loyalty_number": "1234-5678-9876-5432-1"
},
"order_value": 1999,
"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",
"external_instance_id": 12,
"volume": 5.3,
"weight": 2.8,
"length": 2.8,
"width": 2.8,
"height": 2.8,
"price": 1000,
"barcode": 12342830041,
"special_instructions": "Only Ripen Bananas",
"item_options": {"substitute_item_ids": ["123443434",
"123443435"
],
"merchant_recommended_substitute_item_ids": ["543443434",
"543443435"
],
"substitute_item_ids_additional_metadata": [{"id": "123443434",
"quantity": 1,
"weight": 2.5,
"weight_unit": "lbs"
},
{"id": "123443435",
"quantity": 2
}
],
"weight_unit": "oz",
"substitution_preference": "refund"
},
"adjustment_details": {"addition_source": "dasher"
}
}
],
"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"
},
"customer_expected_sla": {"day": "2018-08-22"
},
"expires_by": {"day": "2018-08-22"
},
"shipping_label_metadata": {"internal_location_id": "DoordashLocID"
},
"contactless_dropoff": false,
"action_if_undeliverable": "return_to_pickup",
"tip": 599,
"order_contains": {"alcohol": false,
"pharmacy_items": false,
"age_restricted_pharmacy_items": false,
"tobacco": false,
"hemp": false,
"otc": false
},
"dasher_allowed_vehicles": ["car",
"bicycle",
"walking"
],
"dropoff_requires_signature": false,
"promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c",
"dropoff_cash_on_delivery": 1999,
"order_route_type": "roundtrip",
"order_route_items": ["check"
]
}

Response samples

Content type

application/json

{"external_delivery_id": "D-1763",
"locale": "en-US, fr-CA, es-US",
"order_fulfillment_method": "standard",
"origin_facility_id": "MERCHANTA-CA-1",
"pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"pickup_business_name": "Wells Fargo SF Downtown",
"pickup_phone_number": "+16505555555",
"pickup_instructions": "Go to the bar for pick up.",
"pickup_reference_tag": "Order number 61",
"pickup_external_business_id": "ase-243-dzs",
"pickup_external_store_id": "ase-243-dzs",
"pickup_verification_metadata": {"verification_type": "SCAN_BARCODE",
"verification_code": "12345",
"verification_format": "CODE_39"
},
"dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"dropoff_business_name": "The Avery Condominium",
"dropoff_location": {"lat": 123.1312343,
"lng": -37.2144343
},
"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,
"dropoff_options": {"signature": "required",
"id_verification": "required",
"proof_of_delivery": "photo_required",
"catering_setup": "required"
},
"dropoff_address_components": {"street_address": "901 Market Street",
"sub_premise": "Apt. 121",
"city": "San Francisco",
"state": "CA",
"zip_code": 94103,
"country": "US"
},
"dropoff_pin_code_verification_metadata": {"pin_code_type": "customer_phone_number",
"pin_code_value": "1234"
},
"return_dropoff_pin_code_verification_metadata": {"pin_code_type": "merchant_provided_number",
"pin_code_value": "1234"
},
"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",
"external_instance_id": 12,
"volume": 5.3,
"weight": 2.8,
"length": 2.8,
"width": 2.8,
"height": 2.8,
"price": 1000,
"barcode": 12342830041,
"special_instructions": "Only Ripen Bananas",
"item_options": {"substitute_item_ids": ["123443434",
"123443435"
],
"merchant_recommended_substitute_item_ids": ["543443434",
"543443435"
],
"substitute_item_ids_additional_metadata": [{"id": "123443434",
"quantity": 1,
"weight": 2.5,
"weight_unit": "lbs"
},
{"id": "123443435",
"quantity": 2
}
],
"weight_unit": "oz",
"substitution_preference": "refund"
},
"adjustment_details": {"addition_source": "dasher"
}
}
],
"shopped_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",
"external_instance_id": 12,
"weight": 2.8,
"weight_components": [0
],
"weight_unit": "oz",
"requested_item_external_id": "123-123443434b",
"substitution_source": "dasher",
"scanned_code": 1234567890128,
"addition_source": "dasher",
"requested_item_external_instance_id": 12,
"scanned_data_list": [{"format": "upc-a",
"is_variable_measure": false,
"indicator_digit": 1,
"product_code": 200,
"check_digit": 1,
"country_code": 4,
"manufacturer_code": 41303,
"number_system": 0,
"plu_check_digit": 5,
"company_prefix": 12345,
"item_reference": 67890,
"scanned_code_sans_check_digit": 4130300200
}
],
"fulfilled_substitution_type": "no_substitution",
"is_unknown": false,
"price": 1000
}
],
"shopping_options": {"payment_method": "red_card",
"payment_barcode": "12345",
"payment_gift_cards": ["123443434",
"123443435"
],
"ready_for_pickup_by": "2018-08-22T17:20:28Z",
"dropoff_contact_loyalty_number": "1234-5678-9876-5432-1"
},
"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,
"fee_components": [{"type": "distance_based_fee",
"amount": 1900
}
],
"tax": 520,
"tax_components": [{"type": "gst_hst",
"amount": 520
}
],
"support_reference": "86313",
"tracking_url": "https://doordash.com/tracking?id=",
"dropoff_verification_image_url": "https://doordash-static.s3...",
"pickup_verification_image_url": "https://doordash-static.s3...",
"dropoff_signature_image_url": "https://doordash-static.s3...",
"shipping_label": {"label_format": "zpl",
"label_size": "4x6",
"print_density": "203dpi",
"label_string": "XlhBCl5DRjAsNjAKXkZPNTAsNTBeRkRTdG9yZU5hbWVeRlMKXkNGMCwzMApeRk81MCwxMTVeRkRTaGlwcGVkIDAxLzE2LzIwMjNeRlMKXkZPNjUwLDYwXkZENS4zIGxic15GUwpeRk82NTAsMTAwXkZEQ0hJLTJeRlMKXkZPNTAsMTcwXkdCNzAwLDMsM15GUwpeQ0YwLDgwCl5GTzUwLDIyNV5GREpvaG4gRG9lXkZTCl5DRkEsMzYKXkZPNTAsMzMwXkZENnRoIEZsb29yXkZTCl5GTzUwLDM4NV5GRDkwMSBNYXJrZXQgU3RyZWV0XkZTCl5GTzUwLDQ0MF5GRFNhbiBGcmFuY2lzY28sIENBIDk0MTAzXkZTCl5GTzUwLDUyMF5HQjcwMCwzLDNeRlMKXkJZMiwzLDIwMApeRk81MCw1NzVeQkNeRkRKM0Q0VE5HUU1QR0FLSE5VNlZSSlA4RjkyRDE3WV5GUwpeQlFOLDIsNwpeRk81NzUsNzc1XkZEUUEsSjNENFROR1FNUEdBS0hOVTZWUkpQOEY5MkQxN1leRlMKXkNGQSwyNApeRk81MCw4NTBeRkRSZWYjIDEyMy0xMjM0NDM0MzRiXkZTCl5DRkEsMzZeRk81MCwxMDUwXkZERGVsaXZlcmVkXkZTCl5DRkIsMzZeRk81MCwxMTAwXkZEQnkgRGFzaExpbmteRlMKXlha=="
},
"dropped_items": [{"external_id": "1011902870",
"type": "main_item",
"reason": "item_not_found_in_catalog"
}
],
"contactless_dropoff": false,
"action_if_undeliverable": "return_to_pickup",
"tip": 599,
"order_contains": {"alcohol": false,
"pharmacy_items": false,
"age_restricted_pharmacy_items": false,
"tobacco": false,
"hemp": false,
"otc": false
},
"dasher_allowed_vehicles": ["car",
"bicycle",
"walking"
],
"dropoff_requires_signature": false,
"promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c",
"dropoff_cash_on_delivery": 1999,
"order_route_type": "roundtrip",
"order_route_items": ["check"
],
"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 Quote

When you’re happy with the quote you created, start the delivery process by accepting the quote. Learn how to use this API in the Create & Accept Quotes how-to guide.

path Parameters

external_delivery_id

required

string/[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. Use cents or the equivalent lowest currency denomination (e.g. $5.99 = 599).
dropoff_phone_number	string (Drop-off Phone number) The phone number for the Dasher to call if there are any issues with the delivery. Should include the country code. Must adhere to E.164 international phone number standard

Responses

Request samples

Payload

Content type

application/json

{"tip": 599,
"dropoff_phone_number": "+16505555555"
}

Response samples

Content type

application/json

{"external_delivery_id": "D-1763",
"locale": "en-US, fr-CA, es-US",
"order_fulfillment_method": "standard",
"origin_facility_id": "MERCHANTA-CA-1",
"pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"pickup_business_name": "Wells Fargo SF Downtown",
"pickup_phone_number": "+16505555555",
"pickup_instructions": "Go to the bar for pick up.",
"pickup_reference_tag": "Order number 61",
"pickup_external_business_id": "ase-243-dzs",
"pickup_external_store_id": "ase-243-dzs",
"pickup_verification_metadata": {"verification_type": "SCAN_BARCODE",
"verification_code": "12345",
"verification_format": "CODE_39"
},
"dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"dropoff_business_name": "The Avery Condominium",
"dropoff_location": {"lat": 123.1312343,
"lng": -37.2144343
},
"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,
"dropoff_options": {"signature": "required",
"id_verification": "required",
"proof_of_delivery": "photo_required",
"catering_setup": "required"
},
"dropoff_address_components": {"street_address": "901 Market Street",
"sub_premise": "Apt. 121",
"city": "San Francisco",
"state": "CA",
"zip_code": 94103,
"country": "US"
},
"dropoff_pin_code_verification_metadata": {"pin_code_type": "customer_phone_number",
"pin_code_value": "1234"
},
"return_dropoff_pin_code_verification_metadata": {"pin_code_type": "merchant_provided_number",
"pin_code_value": "1234"
},
"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",
"external_instance_id": 12,
"volume": 5.3,
"weight": 2.8,
"length": 2.8,
"width": 2.8,
"height": 2.8,
"price": 1000,
"barcode": 12342830041,
"special_instructions": "Only Ripen Bananas",
"item_options": {"substitute_item_ids": ["123443434",
"123443435"
],
"merchant_recommended_substitute_item_ids": ["543443434",
"543443435"
],
"substitute_item_ids_additional_metadata": [{"id": "123443434",
"quantity": 1,
"weight": 2.5,
"weight_unit": "lbs"
},
{"id": "123443435",
"quantity": 2
}
],
"weight_unit": "oz",
"substitution_preference": "refund"
},
"adjustment_details": {"addition_source": "dasher"
}
}
],
"shopped_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",
"external_instance_id": 12,
"weight": 2.8,
"weight_components": [0
],
"weight_unit": "oz",
"requested_item_external_id": "123-123443434b",
"substitution_source": "dasher",
"scanned_code": 1234567890128,
"addition_source": "dasher",
"requested_item_external_instance_id": 12,
"scanned_data_list": [{"format": "upc-a",
"is_variable_measure": false,
"indicator_digit": 1,
"product_code": 200,
"check_digit": 1,
"country_code": 4,
"manufacturer_code": 41303,
"number_system": 0,
"plu_check_digit": 5,
"company_prefix": 12345,
"item_reference": 67890,
"scanned_code_sans_check_digit": 4130300200
}
],
"fulfilled_substitution_type": "no_substitution",
"is_unknown": false,
"price": 1000
}
],
"shopping_options": {"payment_method": "red_card",
"payment_barcode": "12345",
"payment_gift_cards": ["123443434",
"123443435"
],
"ready_for_pickup_by": "2018-08-22T17:20:28Z",
"dropoff_contact_loyalty_number": "1234-5678-9876-5432-1"
},
"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,
"fee_components": [{"type": "distance_based_fee",
"amount": 1900
}
],
"tax": 520,
"tax_components": [{"type": "gst_hst",
"amount": 520
}
],
"support_reference": "86313",
"tracking_url": "https://doordash.com/tracking?id=",
"dropoff_verification_image_url": "https://doordash-static.s3...",
"pickup_verification_image_url": "https://doordash-static.s3...",
"dropoff_signature_image_url": "https://doordash-static.s3...",
"shipping_label": {"label_format": "zpl",
"label_size": "4x6",
"print_density": "203dpi",
"label_string": "XlhBCl5DRjAsNjAKXkZPNTAsNTBeRkRTdG9yZU5hbWVeRlMKXkNGMCwzMApeRk81MCwxMTVeRkRTaGlwcGVkIDAxLzE2LzIwMjNeRlMKXkZPNjUwLDYwXkZENS4zIGxic15GUwpeRk82NTAsMTAwXkZEQ0hJLTJeRlMKXkZPNTAsMTcwXkdCNzAwLDMsM15GUwpeQ0YwLDgwCl5GTzUwLDIyNV5GREpvaG4gRG9lXkZTCl5DRkEsMzYKXkZPNTAsMzMwXkZENnRoIEZsb29yXkZTCl5GTzUwLDM4NV5GRDkwMSBNYXJrZXQgU3RyZWV0XkZTCl5GTzUwLDQ0MF5GRFNhbiBGcmFuY2lzY28sIENBIDk0MTAzXkZTCl5GTzUwLDUyMF5HQjcwMCwzLDNeRlMKXkJZMiwzLDIwMApeRk81MCw1NzVeQkNeRkRKM0Q0VE5HUU1QR0FLSE5VNlZSSlA4RjkyRDE3WV5GUwpeQlFOLDIsNwpeRk81NzUsNzc1XkZEUUEsSjNENFROR1FNUEdBS0hOVTZWUkpQOEY5MkQxN1leRlMKXkNGQSwyNApeRk81MCw4NTBeRkRSZWYjIDEyMy0xMjM0NDM0MzRiXkZTCl5DRkEsMzZeRk81MCwxMDUwXkZERGVsaXZlcmVkXkZTCl5DRkIsMzZeRk81MCwxMTAwXkZEQnkgRGFzaExpbmteRlMKXlha=="
},
"dropped_items": [{"external_id": "1011902870",
"type": "main_item",
"reason": "item_not_found_in_catalog"
}
],
"contactless_dropoff": false,
"action_if_undeliverable": "return_to_pickup",
"tip": 599,
"order_contains": {"alcohol": false,
"pharmacy_items": false,
"age_restricted_pharmacy_items": false,
"tobacco": false,
"hemp": false,
"otc": false
},
"dasher_allowed_vehicles": ["car",
"bicycle",
"walking"
],
"dropoff_requires_signature": false,
"promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c",
"dropoff_cash_on_delivery": 1999,
"order_route_type": "roundtrip",
"order_route_items": ["check"
],
"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. Learn how to use this API in one of our tutorials: call the API directly from any language or tool, create deliveries using our Node.js SDK, or use Postman to call the APIs.

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) The language DoorDash should use when sending updates about this delivery. Supported locales : `en-US`, `fr-CA`, `es-US`.
order_fulfillment_method	string (OrderFulfillmentMethod) Enum: "standard" "catering" "shop_stage" "shop_deliver" "parcel" "large_order" "shop_handoff" Type of fulfillment required for Delivery ("shop_stage", "shop_deliver", "shop_handoff" for DSS/DSD/DSH delivery; "parcel" for parcel delivery. "catering" is deprecated.)
origin_facility_id	string (OriginFacilityId) Merchant warehouse id for the midmile
pickup_address	string (PickupAddress) Comma-separated full address, in the order appropriate for your locale. Overridden by store properties if pickup_external_store_id and pickup_external_business_id are used.
pickup_business_name	string (PickupAddressName) Optional name of the place, to help Dashers find the location. Overridden by store properties if pickup_external_store_id and pickup_external_business_id are used.
pickup_phone_number	string (Pickup Phone number) The phone number for the Dasher to call if there are any issues with the pick up. Should include the country code and must match the country of the store for which the delivery is created. Overridden by store properties if pickup_external_store_id and pickup_external_business_id are used. Must adhere to E.164 international phone number standard.
pickup_instructions	string (PickupInstructions) Instructions for the Dasher to follow when picking up the order.
pickup_reference_tag	string (ReferenceTag) A reference that can help Dasher identify the correct delivery item for pick up/drop-off.
pickup_external_business_id	string (ExternalBusinessId) /^[A-Za-z0-9_-]{3,64}$/ The string identifier used to create your business. Used in combination with pickup_external_store_id to select the pick up location. If you provide an pickup_external_business_id, you must also provide an pickup_external_store_id.
pickup_external_store_id	string (ExternalStoreId) The string identifier used to create your store. If you provide an pickup_external_store_id, you must also provide an pickup_external_business_id. If you provide an pickup_external_store_id, the address of the store will override the pickup_address in the request. Some examples would look like this: "ase-243-dzs", "09", "#00012"
	object (PickupVerificationMetadata) Optional pickup verification metadata. Use this to enable order level pickup verification
dropoff_address required	string (DropoffAddress) Comma-separated full address, in the order appropriate for your locale.
dropoff_business_name	string (DropoffAddressName) Optional name of the place, to help Dashers find the location.
	object (Location) [Pre-release field: submit a ticket in the Developer Portal or reach out to your DoorDash contact if you would like to provide precise location information.] The precise location, as latitude and longitude, of the drop-off. If your request includes both location and address, location will be used for Dasher navigation only; address will be used for fee and serviceability checks.
dropoff_phone_number required	string (Drop-off Phone number) The phone number for the Dasher to call if there are any issues with the delivery. Should include the country code. Must adhere to E.164 international phone number standard
dropoff_instructions	string (DropoffInstructions) /^[A-Za-z0-9_-]{3,64}$/ Instructions for the Dasher to follow when picking up the order.
dropoff_contact_given_name	string (GivenName) [^~`@#\$%\^&\*\+=\?;\[{\]\}] Given/first name of the contact.
dropoff_contact_family_name	string (FamilyName) [^~`@#\$%\^&\*\+=\?;\[{\]\}] Family/last name of the contact.
dropoff_contact_send_notifications	boolean (SendNotifications) Whether the contact will receive notifications from DoorDash for this delivery. The default is true.
	object (DropoffOptions) Additional options for drop off
	United States (object) or Canada (object) or Australia (object) or New Zealand (object) (DropoffAddressComponents) The Dropoff address broken down into independent components.
	object (DropoffPinCodeVerificationMetadata) An object that specifies the dropoff pin code verification related details for this order. When "pin_code" is set in "dropoff_options.proof_of_delivery", the object must include relevant pin code data. Conversely, if "pin_code" is not set as "proof_of_delivery", the object should exclude any pin code data. Pin Code can be enabled only for orders that are non-contactless and not unattended deliveries. Please reach out to Doordash to enable this feature for your business.
	object (ReturnPinCodeVerificationMetadata) Specifies the pin code verification details for returns. An object that specifies the dropoff pin code verification related details for this order.
	object (ShoppingOptions) Details about how to shop and pay for the delivery for shop_deliver and shop_stage orders
order_value	integer <int32> (OrderValue) >= 0 The subtotal for all items in the order, excluding tax/tip, in the lowest currency denomination (e.g. cents). i.e. $19.99 = 1999.
	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 (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 (pickup_window_start_time , pickup_window_end_time , dropoff_window_start_time , dropoff_window_end_time) are provided.
	Day (object) or Time_Stamp (object) (CustomerExpectedSla) The expected delivery time or date shown to the customer.
	Day (object) or Time_Stamp (object) (ExpiresBy) The last time or date the order can be delivered before expiration
	object (ShippingLabelMetadata) A JSON document that allows adding metadata about the shipping label such as sort_code, etc. Please reach out to Doordash to enable this feature for your business.
contactless_dropoff	boolean (Contactless) Whether the delivery should be contactless, which prompts a Dasher to take a picture of the delivery at drop-off.
action_if_undeliverable	string (ActionIfUndeliverable) Enum: "return_to_pickup" "dispose" What the Dasher should do if the delivery is undeliverable. If left blank, the order will be treated as contactless. See Create return to pickup deliveries for more information.
tip	integer <int32> (Tip) >= 0 The tip amount. Use cents or the equivalent lowest currency denomination (e.g. $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. The default is "car".
dropoff_requires_signature	boolean (SignatureRequired) Whether the delivery requires signature verification during drop-off.
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 `fee` will be adjusted according to the details of the promotion. Create a support ticket to setup a promotion or if your promotion ID isn't working.
dropoff_cash_on_delivery	integer <int32> >= 0 The cash to collect when this order is dropped off, value in the lowest currency denomination (e.g. cents). i.e. $19.99 = 1999. [Pre-release field: Submit a ticket or reach out to your DoorDash contact if you would like to accept cash on delivery.]
order_route_type	string (OrderRouteType) Value: "roundtrip" Type of route required for the delivery ("roundtrip" for deliveries that require the Dasher to return to the pickup location after dropoff). If this field is not specified, the default type is the standard point to point delivery.
order_route_items	Array of strings (OrderRouteItems) Items Enum: "check" "cash" "pizza_bag"

Responses

Request samples

Payload

Content type

application/json

{"external_delivery_id": "D-1763",
"locale": "en-US, fr-CA, es-US",
"order_fulfillment_method": "standard",
"origin_facility_id": "MERCHANTA-CA-1",
"pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"pickup_business_name": "Wells Fargo SF Downtown",
"pickup_phone_number": "+16505555555",
"pickup_instructions": "Go to the bar for pick up.",
"pickup_reference_tag": "Order number 61",
"pickup_external_business_id": "ase-243-dzs",
"pickup_external_store_id": "ase-243-dzs",
"pickup_verification_metadata": {"verification_type": "SCAN_BARCODE",
"verification_code": "12345",
"verification_format": "CODE_39"
},
"dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"dropoff_business_name": "The Avery Condominium",
"dropoff_location": {"lat": 123.1312343,
"lng": -37.2144343
},
"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,
"dropoff_options": {"signature": "required",
"id_verification": "required",
"proof_of_delivery": "photo_required",
"catering_setup": "required"
},
"dropoff_address_components": {"street_address": "901 Market Street",
"sub_premise": "Apt. 121",
"city": "San Francisco",
"state": "CA",
"zip_code": 94103,
"country": "US"
},
"dropoff_pin_code_verification_metadata": {"pin_code_type": "customer_phone_number",
"pin_code_value": "1234"
},
"return_dropoff_pin_code_verification_metadata": {"pin_code_type": "merchant_provided_number",
"pin_code_value": "1234"
},
"shopping_options": {"payment_method": "red_card",
"payment_barcode": "12345",
"payment_gift_cards": ["123443434",
"123443435"
],
"ready_for_pickup_by": "2018-08-22T17:20:28Z",
"dropoff_contact_loyalty_number": "1234-5678-9876-5432-1"
},
"order_value": 1999,
"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",
"external_instance_id": 12,
"volume": 5.3,
"weight": 2.8,
"length": 2.8,
"width": 2.8,
"height": 2.8,
"price": 1000,
"barcode": 12342830041,
"special_instructions": "Only Ripen Bananas",
"item_options": {"substitute_item_ids": ["123443434",
"123443435"
],
"merchant_recommended_substitute_item_ids": ["543443434",
"543443435"
],
"substitute_item_ids_additional_metadata": [{"id": "123443434",
"quantity": 1,
"weight": 2.5,
"weight_unit": "lbs"
},
{"id": "123443435",
"quantity": 2
}
],
"weight_unit": "oz",
"substitution_preference": "refund"
},
"adjustment_details": {"addition_source": "dasher"
}
}
],
"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"
},
"customer_expected_sla": {"day": "2018-08-22"
},
"expires_by": {"day": "2018-08-22"
},
"shipping_label_metadata": {"internal_location_id": "DoordashLocID"
},
"contactless_dropoff": false,
"action_if_undeliverable": "return_to_pickup",
"tip": 599,
"order_contains": {"alcohol": false,
"pharmacy_items": false,
"age_restricted_pharmacy_items": false,
"tobacco": false,
"hemp": false,
"otc": false
},
"dasher_allowed_vehicles": ["car",
"bicycle",
"walking"
],
"dropoff_requires_signature": false,
"promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c",
"dropoff_cash_on_delivery": 1999,
"order_route_type": "roundtrip",
"order_route_items": ["check"
]
}

Response samples

Content type

application/json

{"external_delivery_id": "D-1763",
"locale": "en-US, fr-CA, es-US",
"order_fulfillment_method": "standard",
"origin_facility_id": "MERCHANTA-CA-1",
"pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"pickup_business_name": "Wells Fargo SF Downtown",
"pickup_phone_number": "+16505555555",
"pickup_instructions": "Go to the bar for pick up.",
"pickup_reference_tag": "Order number 61",
"pickup_external_business_id": "ase-243-dzs",
"pickup_external_store_id": "ase-243-dzs",
"pickup_verification_metadata": {"verification_type": "SCAN_BARCODE",
"verification_code": "12345",
"verification_format": "CODE_39"
},
"dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"dropoff_business_name": "The Avery Condominium",
"dropoff_location": {"lat": 123.1312343,
"lng": -37.2144343
},
"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,
"dropoff_options": {"signature": "required",
"id_verification": "required",
"proof_of_delivery": "photo_required",
"catering_setup": "required"
},
"dropoff_address_components": {"street_address": "901 Market Street",
"sub_premise": "Apt. 121",
"city": "San Francisco",
"state": "CA",
"zip_code": 94103,
"country": "US"
},
"dropoff_pin_code_verification_metadata": {"pin_code_type": "customer_phone_number",
"pin_code_value": "1234"
},
"return_dropoff_pin_code_verification_metadata": {"pin_code_type": "merchant_provided_number",
"pin_code_value": "1234"
},
"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",
"external_instance_id": 12,
"volume": 5.3,
"weight": 2.8,
"length": 2.8,
"width": 2.8,
"height": 2.8,
"price": 1000,
"barcode": 12342830041,
"special_instructions": "Only Ripen Bananas",
"item_options": {"substitute_item_ids": ["123443434",
"123443435"
],
"merchant_recommended_substitute_item_ids": ["543443434",
"543443435"
],
"substitute_item_ids_additional_metadata": [{"id": "123443434",
"quantity": 1,
"weight": 2.5,
"weight_unit": "lbs"
},
{"id": "123443435",
"quantity": 2
}
],
"weight_unit": "oz",
"substitution_preference": "refund"
},
"adjustment_details": {"addition_source": "dasher"
}
}
],
"shopped_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",
"external_instance_id": 12,
"weight": 2.8,
"weight_components": [0
],
"weight_unit": "oz",
"requested_item_external_id": "123-123443434b",
"substitution_source": "dasher",
"scanned_code": 1234567890128,
"addition_source": "dasher",
"requested_item_external_instance_id": 12,
"scanned_data_list": [{"format": "upc-a",
"is_variable_measure": false,
"indicator_digit": 1,
"product_code": 200,
"check_digit": 1,
"country_code": 4,
"manufacturer_code": 41303,
"number_system": 0,
"plu_check_digit": 5,
"company_prefix": 12345,
"item_reference": 67890,
"scanned_code_sans_check_digit": 4130300200
}
],
"fulfilled_substitution_type": "no_substitution",
"is_unknown": false,
"price": 1000
}
],
"shopping_options": {"payment_method": "red_card",
"payment_barcode": "12345",
"payment_gift_cards": ["123443434",
"123443435"
],
"ready_for_pickup_by": "2018-08-22T17:20:28Z",
"dropoff_contact_loyalty_number": "1234-5678-9876-5432-1"
},
"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,
"fee_components": [{"type": "distance_based_fee",
"amount": 1900
}
],
"tax": 520,
"tax_components": [{"type": "gst_hst",
"amount": 520
}
],
"support_reference": "86313",
"tracking_url": "https://doordash.com/tracking?id=",
"dropoff_verification_image_url": "https://doordash-static.s3...",
"pickup_verification_image_url": "https://doordash-static.s3...",
"dropoff_signature_image_url": "https://doordash-static.s3...",
"shipping_label": {"label_format": "zpl",
"label_size": "4x6",
"print_density": "203dpi",
"label_string": "XlhBCl5DRjAsNjAKXkZPNTAsNTBeRkRTdG9yZU5hbWVeRlMKXkNGMCwzMApeRk81MCwxMTVeRkRTaGlwcGVkIDAxLzE2LzIwMjNeRlMKXkZPNjUwLDYwXkZENS4zIGxic15GUwpeRk82NTAsMTAwXkZEQ0hJLTJeRlMKXkZPNTAsMTcwXkdCNzAwLDMsM15GUwpeQ0YwLDgwCl5GTzUwLDIyNV5GREpvaG4gRG9lXkZTCl5DRkEsMzYKXkZPNTAsMzMwXkZENnRoIEZsb29yXkZTCl5GTzUwLDM4NV5GRDkwMSBNYXJrZXQgU3RyZWV0XkZTCl5GTzUwLDQ0MF5GRFNhbiBGcmFuY2lzY28sIENBIDk0MTAzXkZTCl5GTzUwLDUyMF5HQjcwMCwzLDNeRlMKXkJZMiwzLDIwMApeRk81MCw1NzVeQkNeRkRKM0Q0VE5HUU1QR0FLSE5VNlZSSlA4RjkyRDE3WV5GUwpeQlFOLDIsNwpeRk81NzUsNzc1XkZEUUEsSjNENFROR1FNUEdBS0hOVTZWUkpQOEY5MkQxN1leRlMKXkNGQSwyNApeRk81MCw4NTBeRkRSZWYjIDEyMy0xMjM0NDM0MzRiXkZTCl5DRkEsMzZeRk81MCwxMDUwXkZERGVsaXZlcmVkXkZTCl5DRkIsMzZeRk81MCwxMTAwXkZEQnkgRGFzaExpbmteRlMKXlha=="
},
"dropped_items": [{"external_id": "1011902870",
"type": "main_item",
"reason": "item_not_found_in_catalog"
}
],
"contactless_dropoff": false,
"action_if_undeliverable": "return_to_pickup",
"tip": 599,
"order_contains": {"alcohol": false,
"pharmacy_items": false,
"age_restricted_pharmacy_items": false,
"tobacco": false,
"hemp": false,
"otc": false
},
"dasher_allowed_vehicles": ["car",
"bicycle",
"walking"
],
"dropoff_requires_signature": false,
"promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c",
"dropoff_cash_on_delivery": 1999,
"order_route_type": "roundtrip",
"order_route_items": ["check"
],
"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

Get the status and details of a delivery that you created. If you want to proactively receive updates about your delivery, set up webhooks using the webhooks how-to guide.

path Parameters

external_delivery_id

required

string/[a-zA-Z0-9-._~]+/

Example: D-1763

Unique (per developer) ID of the delivery.

Responses

Response samples

Content type

application/json

{"external_delivery_id": "D-1763",
"locale": "en-US, fr-CA, es-US",
"order_fulfillment_method": "standard",
"origin_facility_id": "MERCHANTA-CA-1",
"pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"pickup_business_name": "Wells Fargo SF Downtown",
"pickup_phone_number": "+16505555555",
"pickup_instructions": "Go to the bar for pick up.",
"pickup_reference_tag": "Order number 61",
"pickup_external_business_id": "ase-243-dzs",
"pickup_external_store_id": "ase-243-dzs",
"pickup_verification_metadata": {"verification_type": "SCAN_BARCODE",
"verification_code": "12345",
"verification_format": "CODE_39"
},
"dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"dropoff_business_name": "The Avery Condominium",
"dropoff_location": {"lat": 123.1312343,
"lng": -37.2144343
},
"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,
"dropoff_options": {"signature": "required",
"id_verification": "required",
"proof_of_delivery": "photo_required",
"catering_setup": "required"
},
"dropoff_address_components": {"street_address": "901 Market Street",
"sub_premise": "Apt. 121",
"city": "San Francisco",
"state": "CA",
"zip_code": 94103,
"country": "US"
},
"dropoff_pin_code_verification_metadata": {"pin_code_type": "customer_phone_number",
"pin_code_value": "1234"
},
"return_dropoff_pin_code_verification_metadata": {"pin_code_type": "merchant_provided_number",
"pin_code_value": "1234"
},
"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",
"external_instance_id": 12,
"volume": 5.3,
"weight": 2.8,
"length": 2.8,
"width": 2.8,
"height": 2.8,
"price": 1000,
"barcode": 12342830041,
"special_instructions": "Only Ripen Bananas",
"item_options": {"substitute_item_ids": ["123443434",
"123443435"
],
"merchant_recommended_substitute_item_ids": ["543443434",
"543443435"
],
"substitute_item_ids_additional_metadata": [{"id": "123443434",
"quantity": 1,
"weight": 2.5,
"weight_unit": "lbs"
},
{"id": "123443435",
"quantity": 2
}
],
"weight_unit": "oz",
"substitution_preference": "refund"
},
"adjustment_details": {"addition_source": "dasher"
}
}
],
"shopped_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",
"external_instance_id": 12,
"weight": 2.8,
"weight_components": [0
],
"weight_unit": "oz",
"requested_item_external_id": "123-123443434b",
"substitution_source": "dasher",
"scanned_code": 1234567890128,
"addition_source": "dasher",
"requested_item_external_instance_id": 12,
"scanned_data_list": [{"format": "upc-a",
"is_variable_measure": false,
"indicator_digit": 1,
"product_code": 200,
"check_digit": 1,
"country_code": 4,
"manufacturer_code": 41303,
"number_system": 0,
"plu_check_digit": 5,
"company_prefix": 12345,
"item_reference": 67890,
"scanned_code_sans_check_digit": 4130300200
}
],
"fulfilled_substitution_type": "no_substitution",
"is_unknown": false,
"price": 1000
}
],
"shopping_options": {"payment_method": "red_card",
"payment_barcode": "12345",
"payment_gift_cards": ["123443434",
"123443435"
],
"ready_for_pickup_by": "2018-08-22T17:20:28Z",
"dropoff_contact_loyalty_number": "1234-5678-9876-5432-1"
},
"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,
"fee_components": [{"type": "distance_based_fee",
"amount": 1900
}
],
"tax": 520,
"tax_components": [{"type": "gst_hst",
"amount": 520
}
],
"support_reference": "86313",
"tracking_url": "https://doordash.com/tracking?id=",
"dropoff_verification_image_url": "https://doordash-static.s3...",
"pickup_verification_image_url": "https://doordash-static.s3...",
"dropoff_signature_image_url": "https://doordash-static.s3...",
"shipping_label": {"label_format": "zpl",
"label_size": "4x6",
"print_density": "203dpi",
"label_string": "XlhBCl5DRjAsNjAKXkZPNTAsNTBeRkRTdG9yZU5hbWVeRlMKXkNGMCwzMApeRk81MCwxMTVeRkRTaGlwcGVkIDAxLzE2LzIwMjNeRlMKXkZPNjUwLDYwXkZENS4zIGxic15GUwpeRk82NTAsMTAwXkZEQ0hJLTJeRlMKXkZPNTAsMTcwXkdCNzAwLDMsM15GUwpeQ0YwLDgwCl5GTzUwLDIyNV5GREpvaG4gRG9lXkZTCl5DRkEsMzYKXkZPNTAsMzMwXkZENnRoIEZsb29yXkZTCl5GTzUwLDM4NV5GRDkwMSBNYXJrZXQgU3RyZWV0XkZTCl5GTzUwLDQ0MF5GRFNhbiBGcmFuY2lzY28sIENBIDk0MTAzXkZTCl5GTzUwLDUyMF5HQjcwMCwzLDNeRlMKXkJZMiwzLDIwMApeRk81MCw1NzVeQkNeRkRKM0Q0VE5HUU1QR0FLSE5VNlZSSlA4RjkyRDE3WV5GUwpeQlFOLDIsNwpeRk81NzUsNzc1XkZEUUEsSjNENFROR1FNUEdBS0hOVTZWUkpQOEY5MkQxN1leRlMKXkNGQSwyNApeRk81MCw4NTBeRkRSZWYjIDEyMy0xMjM0NDM0MzRiXkZTCl5DRkEsMzZeRk81MCwxMDUwXkZERGVsaXZlcmVkXkZTCl5DRkIsMzZeRk81MCwxMTAwXkZEQnkgRGFzaExpbmteRlMKXlha=="
},
"dropped_items": [{"external_id": "1011902870",
"type": "main_item",
"reason": "item_not_found_in_catalog"
}
],
"contactless_dropoff": false,
"action_if_undeliverable": "return_to_pickup",
"tip": 599,
"order_contains": {"alcohol": false,
"pharmacy_items": false,
"age_restricted_pharmacy_items": false,
"tobacco": false,
"hemp": false,
"otc": false
},
"dasher_allowed_vehicles": ["car",
"bicycle",
"walking"
],
"dropoff_requires_signature": false,
"promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c",
"dropoff_cash_on_delivery": 1999,
"order_route_type": "roundtrip",
"order_route_items": ["check"
],
"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 details of a delivery. Only the fields listed below can be updated; to update other fields, you need to cancel the delivery and then create a new one.

path Parameters

external_delivery_id

required

string/[a-zA-Z0-9-._~]+/

Example: D-1763

Unique (per developer) ID of the delivery.

Request Body schema: application/json

pickup_address	string (PickupAddress) Comma-separated full address, in the order appropriate for your locale. Overridden by store properties if pickup_external_store_id and pickup_external_business_id are used.
pickup_business_name	string (PickupAddressName) Optional name of the place, to help Dashers find the location. Overridden by store properties if pickup_external_store_id and pickup_external_business_id are used.
pickup_phone_number	string (Pickup Phone number) The phone number for the Dasher to call if there are any issues with the pick up. Should include the country code and must match the country of the store for which the delivery is created. Overridden by store properties if pickup_external_store_id and pickup_external_business_id are used. Must adhere to E.164 international phone number standard.
pickup_instructions	string (PickupInstructions) Instructions for the Dasher to follow when picking up the order.
pickup_reference_tag	string (ReferenceTag) A reference that can help Dasher identify the correct delivery item for pick up/drop-off.
pickup_external_business_id	string (ExternalBusinessId) /^[A-Za-z0-9_-]{3,64}$/ The string identifier used to create your business. Used in combination with pickup_external_store_id to select the pick up location. If you provide an pickup_external_business_id, you must also provide an pickup_external_store_id.
pickup_external_store_id	string (ExternalStoreId) The string identifier used to create your store. If you provide an pickup_external_store_id, you must also provide an pickup_external_business_id. If you provide an pickup_external_store_id, the address of the store will override the pickup_address in the request. Some examples would look like this: "ase-243-dzs", "09", "#00012"
	object (PickupVerificationMetadata) Optional pickup verification metadata. Use this to enable order level pickup verification
dropoff_address	string (DropoffAddress) Comma-separated full address, in the order appropriate for your locale.
dropoff_business_name	string (DropoffAddressName) Optional name of the place, to help Dashers find the location.
	object (Location) [Pre-release field: submit a ticket in the Developer Portal or reach out to your DoorDash contact if you would like to provide precise location information.] The precise location, as latitude and longitude, of the drop-off. If your request includes both location and address, location will be used for Dasher navigation only; address will be used for fee and serviceability checks.
dropoff_phone_number	string (Drop-off Phone number) The phone number for the Dasher to call if there are any issues with the delivery. Should include the country code. Must adhere to E.164 international phone number standard
dropoff_instructions	string (DropoffInstructions) /^[A-Za-z0-9_-]{3,64}$/ Instructions for the Dasher to follow when picking up the order.
dropoff_contact_given_name	string (GivenName) [^~`@#\$%\^&\*\+=\?;\[{\]\}] Given/first name of the contact.
dropoff_contact_family_name	string (FamilyName) [^~`@#\$%\^&\*\+=\?;\[{\]\}] Family/last name of the contact.
dropoff_contact_send_notifications	boolean (SendNotifications) Whether the contact will receive notifications from DoorDash for this delivery. The default is true.
	object (DropoffOptions) Additional options for drop off
	United States (object) or Canada (object) or Australia (object) or New Zealand (object) (DropoffAddressComponents) The Dropoff address broken down into independent components.
	object (DropoffPinCodeVerificationMetadata) An object that specifies the dropoff pin code verification related details for this order. When "pin_code" is set in "dropoff_options.proof_of_delivery", the object must include relevant pin code data. Conversely, if "pin_code" is not set as "proof_of_delivery", the object should exclude any pin code data. Pin Code can be enabled only for orders that are non-contactless and not unattended deliveries. Please reach out to Doordash to enable this feature for your business.
	object (ReturnPinCodeVerificationMetadata) Specifies the pin code verification details for returns. An object that specifies the dropoff pin code verification related details for this order.
contactless_dropoff	boolean (Contactless) Whether the delivery should be contactless, which prompts a Dasher to take a picture of the delivery at drop-off.
action_if_undeliverable	string (ActionIfUndeliverable) Enum: "return_to_pickup" "dispose" What the Dasher should do if the delivery is undeliverable. If left blank, the order will be treated as contactless. See Create return to pickup deliveries for more information.
tip	integer <int32> (Tip) >= 0 The tip amount. Use cents or the equivalent lowest currency denomination (e.g. $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. The default is "car".
dropoff_requires_signature	boolean (SignatureRequired) Whether the delivery requires signature verification during drop-off.
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 `fee` will be adjusted according to the details of the promotion. Create a support ticket to setup a promotion or if your promotion ID isn't working.
dropoff_cash_on_delivery	integer <int32> >= 0 The cash to collect when this order is dropped off, value in the lowest currency denomination (e.g. cents). i.e. $19.99 = 1999. [Pre-release field: Submit a ticket or reach out to your DoorDash contact if you would like to accept cash on delivery.]
order_route_type	string (OrderRouteType) Value: "roundtrip" Type of route required for the delivery ("roundtrip" for deliveries that require the Dasher to return to the pickup location after dropoff). If this field is not specified, the default type is the standard point to point delivery.
order_route_items	Array of strings (OrderRouteItems) Items Enum: "check" "cash" "pizza_bag"
order_value	integer <int32> (OrderValue) >= 0 The subtotal for all items in the order, excluding tax/tip, in the lowest currency denomination (e.g. cents). i.e. $19.99 = 1999.
	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 (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 (pickup_window_start_time , pickup_window_end_time , dropoff_window_start_time , dropoff_window_end_time) are provided.
	Day (object) or Time_Stamp (object) (CustomerExpectedSla) The expected delivery time or date shown to the customer.
	Day (object) or Time_Stamp (object) (ExpiresBy) The last time or date the order can be delivered before expiration
	object (ShippingLabelMetadata) A JSON document that allows adding metadata about the shipping label such as sort_code, etc. Please reach out to Doordash to enable this feature for your business.

Responses

Request samples

Payload

Content type

application/json

{"pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"pickup_business_name": "Wells Fargo SF Downtown",
"pickup_phone_number": "+16505555555",
"pickup_instructions": "Go to the bar for pick up.",
"pickup_reference_tag": "Order number 61",
"pickup_external_business_id": "ase-243-dzs",
"pickup_external_store_id": "ase-243-dzs",
"pickup_verification_metadata": {"verification_type": "SCAN_BARCODE",
"verification_code": "12345",
"verification_format": "CODE_39"
},
"dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"dropoff_business_name": "The Avery Condominium",
"dropoff_location": {"lat": 123.1312343,
"lng": -37.2144343
},
"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,
"dropoff_options": {"signature": "required",
"id_verification": "required",
"proof_of_delivery": "photo_required",
"catering_setup": "required"
},
"dropoff_address_components": {"street_address": "901 Market Street",
"sub_premise": "Apt. 121",
"city": "San Francisco",
"state": "CA",
"zip_code": 94103,
"country": "US"
},
"dropoff_pin_code_verification_metadata": {"pin_code_type": "customer_phone_number",
"pin_code_value": "1234"
},
"return_dropoff_pin_code_verification_metadata": {"pin_code_type": "merchant_provided_number",
"pin_code_value": "1234"
},
"contactless_dropoff": false,
"action_if_undeliverable": "return_to_pickup",
"tip": 599,
"order_contains": {"alcohol": false,
"pharmacy_items": false,
"age_restricted_pharmacy_items": false,
"tobacco": false,
"hemp": false,
"otc": false
},
"dasher_allowed_vehicles": ["car",
"bicycle",
"walking"
],
"dropoff_requires_signature": false,
"promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c",
"dropoff_cash_on_delivery": 1999,
"order_route_type": "roundtrip",
"order_route_items": ["check"
],
"order_value": 1999,
"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",
"external_instance_id": 12,
"volume": 5.3,
"weight": 2.8,
"length": 2.8,
"width": 2.8,
"height": 2.8,
"price": 1000,
"barcode": 12342830041,
"special_instructions": "Only Ripen Bananas",
"item_options": {"substitute_item_ids": ["123443434",
"123443435"
],
"merchant_recommended_substitute_item_ids": ["543443434",
"543443435"
],
"substitute_item_ids_additional_metadata": [{"id": "123443434",
"quantity": 1,
"weight": 2.5,
"weight_unit": "lbs"
},
{"id": "123443435",
"quantity": 2
}
],
"weight_unit": "oz",
"substitution_preference": "refund"
},
"adjustment_details": {"addition_source": "dasher"
}
}
],
"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"
},
"customer_expected_sla": {"day": "2018-08-22"
},
"expires_by": {"day": "2018-08-22"
},
"shipping_label_metadata": {"internal_location_id": "DoordashLocID"
}
}

Response samples

Content type

application/json

{"external_delivery_id": "D-1763",
"locale": "en-US, fr-CA, es-US",
"order_fulfillment_method": "standard",
"origin_facility_id": "MERCHANTA-CA-1",
"pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"pickup_business_name": "Wells Fargo SF Downtown",
"pickup_phone_number": "+16505555555",
"pickup_instructions": "Go to the bar for pick up.",
"pickup_reference_tag": "Order number 61",
"pickup_external_business_id": "ase-243-dzs",
"pickup_external_store_id": "ase-243-dzs",
"pickup_verification_metadata": {"verification_type": "SCAN_BARCODE",
"verification_code": "12345",
"verification_format": "CODE_39"
},
"dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"dropoff_business_name": "The Avery Condominium",
"dropoff_location": {"lat": 123.1312343,
"lng": -37.2144343
},
"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,
"dropoff_options": {"signature": "required",
"id_verification": "required",
"proof_of_delivery": "photo_required",
"catering_setup": "required"
},
"dropoff_address_components": {"street_address": "901 Market Street",
"sub_premise": "Apt. 121",
"city": "San Francisco",
"state": "CA",
"zip_code": 94103,
"country": "US"
},
"dropoff_pin_code_verification_metadata": {"pin_code_type": "customer_phone_number",
"pin_code_value": "1234"
},
"return_dropoff_pin_code_verification_metadata": {"pin_code_type": "merchant_provided_number",
"pin_code_value": "1234"
},
"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",
"external_instance_id": 12,
"volume": 5.3,
"weight": 2.8,
"length": 2.8,
"width": 2.8,
"height": 2.8,
"price": 1000,
"barcode": 12342830041,
"special_instructions": "Only Ripen Bananas",
"item_options": {"substitute_item_ids": ["123443434",
"123443435"
],
"merchant_recommended_substitute_item_ids": ["543443434",
"543443435"
],
"substitute_item_ids_additional_metadata": [{"id": "123443434",
"quantity": 1,
"weight": 2.5,
"weight_unit": "lbs"
},
{"id": "123443435",
"quantity": 2
}
],
"weight_unit": "oz",
"substitution_preference": "refund"
},
"adjustment_details": {"addition_source": "dasher"
}
}
],
"shopped_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",
"external_instance_id": 12,
"weight": 2.8,
"weight_components": [0
],
"weight_unit": "oz",
"requested_item_external_id": "123-123443434b",
"substitution_source": "dasher",
"scanned_code": 1234567890128,
"addition_source": "dasher",
"requested_item_external_instance_id": 12,
"scanned_data_list": [{"format": "upc-a",
"is_variable_measure": false,
"indicator_digit": 1,
"product_code": 200,
"check_digit": 1,
"country_code": 4,
"manufacturer_code": 41303,
"number_system": 0,
"plu_check_digit": 5,
"company_prefix": 12345,
"item_reference": 67890,
"scanned_code_sans_check_digit": 4130300200
}
],
"fulfilled_substitution_type": "no_substitution",
"is_unknown": false,
"price": 1000
}
],
"shopping_options": {"payment_method": "red_card",
"payment_barcode": "12345",
"payment_gift_cards": ["123443434",
"123443435"
],
"ready_for_pickup_by": "2018-08-22T17:20:28Z",
"dropoff_contact_loyalty_number": "1234-5678-9876-5432-1"
},
"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,
"fee_components": [{"type": "distance_based_fee",
"amount": 1900
}
],
"tax": 520,
"tax_components": [{"type": "gst_hst",
"amount": 520
}
],
"support_reference": "86313",
"tracking_url": "https://doordash.com/tracking?id=",
"dropoff_verification_image_url": "https://doordash-static.s3...",
"pickup_verification_image_url": "https://doordash-static.s3...",
"dropoff_signature_image_url": "https://doordash-static.s3...",
"shipping_label": {"label_format": "zpl",
"label_size": "4x6",
"print_density": "203dpi",
"label_string": "XlhBCl5DRjAsNjAKXkZPNTAsNTBeRkRTdG9yZU5hbWVeRlMKXkNGMCwzMApeRk81MCwxMTVeRkRTaGlwcGVkIDAxLzE2LzIwMjNeRlMKXkZPNjUwLDYwXkZENS4zIGxic15GUwpeRk82NTAsMTAwXkZEQ0hJLTJeRlMKXkZPNTAsMTcwXkdCNzAwLDMsM15GUwpeQ0YwLDgwCl5GTzUwLDIyNV5GREpvaG4gRG9lXkZTCl5DRkEsMzYKXkZPNTAsMzMwXkZENnRoIEZsb29yXkZTCl5GTzUwLDM4NV5GRDkwMSBNYXJrZXQgU3RyZWV0XkZTCl5GTzUwLDQ0MF5GRFNhbiBGcmFuY2lzY28sIENBIDk0MTAzXkZTCl5GTzUwLDUyMF5HQjcwMCwzLDNeRlMKXkJZMiwzLDIwMApeRk81MCw1NzVeQkNeRkRKM0Q0VE5HUU1QR0FLSE5VNlZSSlA4RjkyRDE3WV5GUwpeQlFOLDIsNwpeRk81NzUsNzc1XkZEUUEsSjNENFROR1FNUEdBS0hOVTZWUkpQOEY5MkQxN1leRlMKXkNGQSwyNApeRk81MCw4NTBeRkRSZWYjIDEyMy0xMjM0NDM0MzRiXkZTCl5DRkEsMzZeRk81MCwxMDUwXkZERGVsaXZlcmVkXkZTCl5DRkIsMzZeRk81MCwxMTAwXkZEQnkgRGFzaExpbmteRlMKXlha=="
},
"dropped_items": [{"external_id": "1011902870",
"type": "main_item",
"reason": "item_not_found_in_catalog"
}
],
"contactless_dropoff": false,
"action_if_undeliverable": "return_to_pickup",
"tip": 599,
"order_contains": {"alcohol": false,
"pharmacy_items": false,
"age_restricted_pharmacy_items": false,
"tobacco": false,
"hemp": false,
"otc": false
},
"dasher_allowed_vehicles": ["car",
"bicycle",
"walking"
],
"dropoff_requires_signature": false,
"promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c",
"dropoff_cash_on_delivery": 1999,
"order_route_type": "roundtrip",
"order_route_items": ["check"
],
"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 a delivery. Deliveries can't be cancelled after a Dasher is assigned.

path Parameters

external_delivery_id

required

string/[a-zA-Z0-9-._~]+/

Example: D-1763

Unique (per developer) ID of the delivery.

Responses

Response samples

Content type

application/json

{"external_delivery_id": "D-1763",
"locale": "en-US, fr-CA, es-US",
"order_fulfillment_method": "standard",
"origin_facility_id": "MERCHANTA-CA-1",
"pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"pickup_business_name": "Wells Fargo SF Downtown",
"pickup_phone_number": "+16505555555",
"pickup_instructions": "Go to the bar for pick up.",
"pickup_reference_tag": "Order number 61",
"pickup_external_business_id": "ase-243-dzs",
"pickup_external_store_id": "ase-243-dzs",
"pickup_verification_metadata": {"verification_type": "SCAN_BARCODE",
"verification_code": "12345",
"verification_format": "CODE_39"
},
"dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"dropoff_business_name": "The Avery Condominium",
"dropoff_location": {"lat": 123.1312343,
"lng": -37.2144343
},
"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,
"dropoff_options": {"signature": "required",
"id_verification": "required",
"proof_of_delivery": "photo_required",
"catering_setup": "required"
},
"dropoff_address_components": {"street_address": "901 Market Street",
"sub_premise": "Apt. 121",
"city": "San Francisco",
"state": "CA",
"zip_code": 94103,
"country": "US"
},
"dropoff_pin_code_verification_metadata": {"pin_code_type": "customer_phone_number",
"pin_code_value": "1234"
},
"return_dropoff_pin_code_verification_metadata": {"pin_code_type": "merchant_provided_number",
"pin_code_value": "1234"
},
"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",
"external_instance_id": 12,
"volume": 5.3,
"weight": 2.8,
"length": 2.8,
"width": 2.8,
"height": 2.8,
"price": 1000,
"barcode": 12342830041,
"special_instructions": "Only Ripen Bananas",
"item_options": {"substitute_item_ids": ["123443434",
"123443435"
],
"merchant_recommended_substitute_item_ids": ["543443434",
"543443435"
],
"substitute_item_ids_additional_metadata": [{"id": "123443434",
"quantity": 1,
"weight": 2.5,
"weight_unit": "lbs"
},
{"id": "123443435",
"quantity": 2
}
],
"weight_unit": "oz",
"substitution_preference": "refund"
},
"adjustment_details": {"addition_source": "dasher"
}
}
],
"shopped_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",
"external_instance_id": 12,
"weight": 2.8,
"weight_components": [0
],
"weight_unit": "oz",
"requested_item_external_id": "123-123443434b",
"substitution_source": "dasher",
"scanned_code": 1234567890128,
"addition_source": "dasher",
"requested_item_external_instance_id": 12,
"scanned_data_list": [{"format": "upc-a",
"is_variable_measure": false,
"indicator_digit": 1,
"product_code": 200,
"check_digit": 1,
"country_code": 4,
"manufacturer_code": 41303,
"number_system": 0,
"plu_check_digit": 5,
"company_prefix": 12345,
"item_reference": 67890,
"scanned_code_sans_check_digit": 4130300200
}
],
"fulfilled_substitution_type": "no_substitution",
"is_unknown": false,
"price": 1000
}
],
"shopping_options": {"payment_method": "red_card",
"payment_barcode": "12345",
"payment_gift_cards": ["123443434",
"123443435"
],
"ready_for_pickup_by": "2018-08-22T17:20:28Z",
"dropoff_contact_loyalty_number": "1234-5678-9876-5432-1"
},
"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,
"fee_components": [{"type": "distance_based_fee",
"amount": 1900
}
],
"tax": 520,
"tax_components": [{"type": "gst_hst",
"amount": 520
}
],
"support_reference": "86313",
"tracking_url": "https://doordash.com/tracking?id=",
"dropoff_verification_image_url": "https://doordash-static.s3...",
"pickup_verification_image_url": "https://doordash-static.s3...",
"dropoff_signature_image_url": "https://doordash-static.s3...",
"shipping_label": {"label_format": "zpl",
"label_size": "4x6",
"print_density": "203dpi",
"label_string": "XlhBCl5DRjAsNjAKXkZPNTAsNTBeRkRTdG9yZU5hbWVeRlMKXkNGMCwzMApeRk81MCwxMTVeRkRTaGlwcGVkIDAxLzE2LzIwMjNeRlMKXkZPNjUwLDYwXkZENS4zIGxic15GUwpeRk82NTAsMTAwXkZEQ0hJLTJeRlMKXkZPNTAsMTcwXkdCNzAwLDMsM15GUwpeQ0YwLDgwCl5GTzUwLDIyNV5GREpvaG4gRG9lXkZTCl5DRkEsMzYKXkZPNTAsMzMwXkZENnRoIEZsb29yXkZTCl5GTzUwLDM4NV5GRDkwMSBNYXJrZXQgU3RyZWV0XkZTCl5GTzUwLDQ0MF5GRFNhbiBGcmFuY2lzY28sIENBIDk0MTAzXkZTCl5GTzUwLDUyMF5HQjcwMCwzLDNeRlMKXkJZMiwzLDIwMApeRk81MCw1NzVeQkNeRkRKM0Q0VE5HUU1QR0FLSE5VNlZSSlA4RjkyRDE3WV5GUwpeQlFOLDIsNwpeRk81NzUsNzc1XkZEUUEsSjNENFROR1FNUEdBS0hOVTZWUkpQOEY5MkQxN1leRlMKXkNGQSwyNApeRk81MCw4NTBeRkRSZWYjIDEyMy0xMjM0NDM0MzRiXkZTCl5DRkEsMzZeRk81MCwxMDUwXkZERGVsaXZlcmVkXkZTCl5DRkIsMzZeRk81MCwxMTAwXkZEQnkgRGFzaExpbmteRlMKXlha=="
},
"dropped_items": [{"external_id": "1011902870",
"type": "main_item",
"reason": "item_not_found_in_catalog"
}
],
"contactless_dropoff": false,
"action_if_undeliverable": "return_to_pickup",
"tip": 599,
"order_contains": {"alcohol": false,
"pharmacy_items": false,
"age_restricted_pharmacy_items": false,
"tobacco": false,
"hemp": false,
"otc": false
},
"dasher_allowed_vehicles": ["car",
"bicycle",
"walking"
],
"dropoff_requires_signature": false,
"promotion_id": "ee680b87-0016-496e-ac3c-d3f33ab54c1c",
"dropoff_cash_on_delivery": 1999,
"order_route_type": "roundtrip",
"order_route_items": ["check"
],
"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 Items Substitution Recommendation

For Dasher Shop orders, get a list of recommended substitutions for a given list of items

Request Body schema: application/json

pickup_external_business_id required	string (ExternalBusinessId) /^[A-Za-z0-9_-]{3,64}$/ The string identifier used to create your business. Used in combination with pickup_external_store_id to select the pick up location. If you provide an pickup_external_business_id, you must also provide an pickup_external_store_id.
pickup_external_store_id required	string (ExternalStoreId) The string identifier used to create your store. If you provide an pickup_external_store_id, you must also provide an pickup_external_business_id. If you provide an pickup_external_store_id, the address of the store will override the pickup_address in the request. Some examples would look like this: "ase-243-dzs", "09", "#00012"
required	Array of objects (DeliveryItemForSubsRecommendationRequest) The items used to request substitution recommendations.
	object optional customer information to be used for substitution recommendation

Responses

Request samples

Payload

Content type

application/json

{"pickup_external_business_id": "ase-243-dzs",
"pickup_external_store_id": "ase-243-dzs",
"items": [{"external_id": 123443434
}
],
"customer": {"dropoff_contact_loyalty_number": "1234-5678-9876-5432-1"
}
}

Response samples

Content type

application/json

{"items": [{"external_id": 123443434,
"name": "Regular Banana",
"substitutions": [{"external_id": 123443435,
"name": "Organic Banana"
}
]
}
]
}

Check Serviceability

Check if delivery is serviceable for a given pickup and dropoff location combination

Request Body schema: application/json

pickup_address required	string (PickupAddress) Comma-separated full address, in the order appropriate for your locale. Overridden by store properties if pickup_external_store_id and pickup_external_business_id are used.
dropoff_address required	string (DropoffAddress) Comma-separated full address, in the order appropriate for your locale.
pickup_external_business_id	string (ExternalBusinessId) /^[A-Za-z0-9_-]{3,64}$/ The string identifier used to create your business. Used in combination with pickup_external_store_id to select the pick up location. If you provide an pickup_external_business_id, you must also provide an pickup_external_store_id.
pickup_external_store_id	string (ExternalStoreId) The string identifier used to create your store. If you provide an pickup_external_store_id, you must also provide an pickup_external_business_id. If you provide an pickup_external_store_id, the address of the store will override the pickup_address in the request. Some examples would look like this: "ase-243-dzs", "09", "#00012"
	United States (object) or Canada (object) or Australia (object) or New Zealand (object) (DropoffAddressComponents) The Dropoff address broken down into independent components.

Responses

Request samples

Payload

Content type

application/json

{"pickup_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"dropoff_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"pickup_external_business_id": "ase-243-dzs",
"pickup_external_store_id": "ase-243-dzs",
"dropoff_address_components": {"street_address": "901 Market Street",
"sub_premise": "Apt. 121",
"city": "San Francisco",
"state": "CA",
"zip_code": 94103,
"country": "US"
}
}

Response samples

Content type

application/json

{"is_serviceable": true,
"reasons_not_serviceable": ["string"
]
}

Audit

Create Checkout Audit Signal

Create a new audit signal for virtual checkout for a specified 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.
is_audit_successful	boolean (IsAuditSuccessful) Whether the audit for the specified delivery passed or failed.
	object (AuditPeriod) An object that specifies the audit period start and end time, if audit is completed on the Merchants side.
requested_audit_item_count	integer <int32> (RequestedAuditItemCount) The count of the items requested for audit
audited_item_count	integer <int32> (AuditedItemCount) The count of the items that is audited by the Merchant
	Array of objects (DriveSuccessfulAuditedItem) The items that successfuly passed the audit process.
	Array of objects (DriveFailedAuditedItem) The items that failed the audit process.
checkout_audit_status	string (CheckoutAuditStatus) Enum: "passed" "failed" "skipped" An enum that specifies the overal audit status of the order. Must be sent for failed_audit_items and not successful_audit_items."

Responses

Request samples

Payload

Content type

application/json

{"external_delivery_id": "D-1763",
"is_audit_successful": "false",
"audit_period": {"start_time": "2018-08-22T17:20:28Z",
"end_time": "2018-08-22T17:20:28Z"
},
"requested_audit_item_count": 2,
"audited_item_count": 2,
"successful_audit_items": [{"external_item_id": "item-id-1",
"upc_scanned": "1234575757"
}
],
"failed_audit_items": [{"external_item_id": "item-id-1",
"upc_scanned": "1234575757",
"failed_reason": "scan_mismatch"
}
],
"checkout_audit_status": "passed"
}

Response samples

Content type

application/json

{"signal_received": "false"
}

Address

Get Autocompleted Address

Get address auto-completion suggestions based on partial address input and optional location coordinates

Request Body schema: application/json

input_address required	string Partial address input to search for
	object (Location) Near-real-time location of the Dasher.
search_radius_meter	integer Default: 1000 Search radius in meters from the provided location
max_results	integer [ 1 .. 5 ] Default: 3 Maximum number of results to return
country	string^[A-Z]{2}$ Country code to limit search results

Responses

Request samples

Payload

Content type

application/json

{"input_address": "1600 Amphitheatre",
"location": {"lat": 123.1312343,
"lng": -37.2144343
},
"search_radius_meter": 1000,
"max_results": 3,
"country": "US"
}

Response samples

Content type

application/json

{"results": [{"address": {"formatted_address": "901 Market Street 6th Floor San Francisco, CA 94103",
"location": {"lat": 123.1312343,
"lng": -37.2144343
},
"street": "1600 Amphitheatre Parkway",
"unit": "Suite #600",
"city": "Mountain View",
"state": "CA",
"zip_code": "94043",
"country": "US"
}
}
]
}