Webhook-Felder
API: Drive (classic)
In diesem Dokument wird die Drive (classic)-API behandelt. Wenn du die Drive-API verwendest, lies das Referenzhandbuch für Drive-Webhooks.
Wenn du Aktualisierungen zu verschiedenen Phasen einer Lieferung benötigst, teile dem DoorDash-Team bitte einen URL-Endpunkt mit, für den du Webhook-Ereignisse erhalten möchtest. Es wird nur ein einziger URL-Endpunkt unterstützt.
Alle Webhook-Ereignisse enthalten einen Autorisierungs-Header mit einem konfigurierten Wert.
Konfigurieren deiner Webhook-URL und deines Autorisierungs-Headers
Über das DoorDash-Entwicklerportal kannst du deinen Webhook-Endpunkt und den Autorisierungs-Header konfigurieren, der mit jeder Webhook-Anfrage verknüpft ist.
Hinweis: Du musst Zugang zur Produktionsumgebung beantragen, um den Webhook-Endpunkt für die Produktion konfigurieren zu können.
Webhook-Ereignisse
Wir verschicken die folgenden Ereignisse: Beschreibung des Ereignisses
delivery_created: Wenn eine Lieferung erstellt wird.dasher_confirmed: Der:die Kurier:in hat bestätigt, die Lieferung durchzuführen.driver_batched: Der:die Kurier:in hat zusätzlich zu dieser aktuellen Bestellung eine weitere Bestellung erhalten.dasher_confirmed_store_arrival: Der:die Kurier:in hat die Ankunft am Abholort bestätigt.dasher_picked_up: Der:die Kurier:in hat die Artikel aus der Bestellung abgeholt.dasher_confirmed_consumer_arrival: Der:die Kurier:in hat bestätigt, dass er/sie am Abgabeort angekommen ist.dasher_dropped_off: Der:die Kurier:in hat die Lieferung am Zielort abgegeben.delivery_pending_return: Für diese Bestellung wurde eine Rückgabe eingeleitet.dasher_confirmed_return_arrival: Der:die Kurier:in ist am Rückgabeort angekommen.dasher_dropped_off_return: Der:die Kurier:in hat die Retoure geliefert.delivery_cancelled: Die Lieferung wurde storniert.delivery_attempted: Der:die Kurier:in hat versucht, mit dem:der Kund:in Kontakt aufzunehmen, der:die Kund:in stand nicht für ein Treffen mit dem:der Kurier:in zur Verfügung.
Die folgenden Ereignisse werden nur gesendet, wenn sie für dein Unternehmen aktiviert sind:
dasher_supplied_parking_details: Details zum Parkplatz, die der:die Kurier:in bei der Abholung einer Bestellung oder Rückgabe einer Retoure beim Anbieter angibt.delivery_post_tip_received: Nach der Lieferung erhaltenes Trinkgeld.dasher_enroute_to_pickup: Der:die Kurier:in ist auf dem Weg zur Abholung der Bestellung.dasher_enroute_to_dropoff: Der:die Kurier:in ist auf dem Weg zum Abgabeort.dasher_enroute_to_return: Der:die Kurier:in ist auf dem Weg zurück zum Abholort, um die Artikel zurückzugeben.delivery_refunded: Bestellung wurde rückerstattet Der Erstattungsbetrag ist in der Payload angegeben.
Hinweis: Bei Bestellungen, die über den Lieferungssimulator erstellt werden, werden nicht alle Ereignisse versendet. Weitere Einzelheiten findest du im Abschnitt über den Lieferungssimulator.
Häufigkeit von Webhook-Ereignissen
Streckenbezogene Webhook-Ereignisse treten alle 30 Sekunden ein, beginnend 15 Minuten vor der Abholung oder Abgabe. Alle anderen Webhook-Ereignisse treten ein, sobald das Ereignis eintritt.
| Webhook event_category | delivery.status | delivery.dasher_status | event_data |
|---|---|---|---|
| delivery_created | scheduled | unassigned | |
| dasher_confirmed | assigned | accepted enroute_to_pickup | |
| driver_batched | assigned picked_up delivered pending_return | accepted enroute_to_pickup arrived_at_store picked_up enroute_to_dropoff arrived_at_consumer dropped_off enroute_to_return arrived_at_return | |
| dasher_enroute_to_pickup | assigned | enroute_to_pickup | |
| dasher_confirmed_store_arrival | assigned | arrived_at_store | |
| dasher_picked_up | picked_up | picked_up enroute_to_dropoff | |
| dasher_enroute_to_dropoff | picked_up | enroute_to_dropoff | |
| dasher_confirmed_consumer_arrival | picked_up | arrived_at_consumer | |
| dasher_dropped_off | delivered | dropped_off | |
| delivery_pending_return | pending_return | pending_return | |
| dasher_enroute_to_return | pending_return | enroute_to_return | |
| dasher_confirmed_return_arrival | pending_return | arrived_at_return | |
| dasher_dropped_off_return | returned | dropped_off_return | |
| delivery_cancelled | cancelled | unassigned | reason reason_comments |
| delivery_attempted | could_not_deliver | could_not_deliver | |
| dasher_supplied_parking_details | assigned | arrived_at_store | |
| delivery_post_tip_received | delivered | dropped_off | post_tip_amount post_tip_received_time |
| delivery_refunded | all statuses applicable | all statuses applicable | reason reason_comments amount currency code amount details |
Rückerstattungsgründe
Grund und reason_comments werden als String gesendet
| Grund | Kommentare zum Grund |
|---|---|
| canceled_order_by_doordash | Von DoorDash stornierte Bestellung |
| canceled_order_by_merchant_request | Vom Anbieter stornierte Bestellung |
| canceled_order_by_customer_request | Von dem:der Kund:in stornierte Bestellung |
| delivered_late | Bestellung verspätet geliefert |
| delivered_early | Bestellung wurde früher geliefert |
| never_delivered | Bestellung ist nicht angekommen |
| missing_or_incorrect_items | Die Bestellung weist fehlende oder falsche Artikel auf |
| poor_food_quality | Schlechte Qualität des Essens |
| delivery_quality | Die Lieferqualität entspricht nicht den Erwartungen der:des Kund:in |
| health_safety_concern | Die Lieferqualität entspricht nicht den Erwartungen der:des Kund:in |
| adjust_tip | Vom Kunden angepasstes Trinkgeld |
| special_instructions_not_followed | Besondere Anweisungen wurde nicht befolgt |
| other | Sonstiges |
Ländercode und Währungszuordnung
| Land | Währung |
|---|---|
| USA | USD |
| Kanada | CAD |
| Australien | AUD |
Beispiel-Payload
{
"event_category": "dasher_dropped_off",
"delivery": {
"id": 34290434,
"status": "delivered",
"dasher_status": "dropped_off",
"driver_reference_tag": "ff8b6480-8b07-4eda-9a5f-209044884a6d",
"quoted_delivery_time": "2018-01-17T19:57:07Z",
"fee": 0,
"rating": null,
"pickup_window_start_time": "2018-01-17T20:45:00.000000Z",
"actual_pickup_time": "2018-01-17T20:50:04.918981Z",
"quoted_pickup_time": "2018-01-17T19:42:07Z",
"estimated_pickup_time": "2018-01-03T23:23:05Z",
"dropoff_address": {
"city": "Fremont",
"state": "CA",
"street": "43514 Christy Street",
"unit": "",
"zip_code": "94538",
"dasher_parking_details": "Parking Stall 1234"
},
"external_delivery_id": null,
"actual_delivery_time": "2018-01-17T20:50:43.380171Z",
"actual_return_time": "2018-01-17T21:02:43.380171Z",
"delivery_verification_image_url": "imageurl/image.jpg",
"delivery_window_start_time": null,
"return_delivery_id": null,
"parent_delivery_id": null,
"items": [],
"cash_on_delivery": null,
"route_id": null,
"quantity": 1,
"pickup_window_end_time": null,
"submit_platform": "drive_api",
"store_point": null,
"delivery_window_end_time": null,
"barcode_scanning_required": false,
"tip": 0,
"order_volume": 3,
"allow_unattended_delivery": true,
"contains_alcohol": false,
"signature_required": false,
"signature_image_url": null,
"delivery_tracking_url": null,
"updated_at": "2018-01-17T20:49:33.442377Z",
"team_lift_required": false,
"external_store_id": "8685",
"is_return_delivery": false,
"batch_id": null,
"estimated_return_time": null,
"currency": "USD",
"dropoff_instructions": "Dropoff instructions",
"pickup_address": {
"city": "Palo Alto",
"state": "CA",
"street": "470 Olive Ave",
"unit": "",
"zip_code": "",
"dasher_parking_details": "Parking Stall 4567",
"external_pickup_zone_id"
},
"dasher": {
"phone_number": "+16505555555",
"first_name": "Ada",
"last_name": "Lovelace",
"id": 7897789,
"profile_image_url": null,
"dasher_phone_number_for_customer": "+16505555556",
"vehicle": {
"license_plate_number": "PLATENO",
"color": "Blue",
"make": "Toyota",
"model": "Corolla",
"year": "2006"
},
"location": {
"lat": 123.45,
"lng": -37.91
}
},
"order_value": 199,
"pickup_instructions": "Pickup instructions",
"customer": {
"phone_number": "+16505555555",
"first_name": "Jane",
"last_name": "Smith",
"email": "[email protected]"
}
},
"created_at": "2018-05-03T22:11:17.042353Z",
"event_data": {
"reason": "delivered_late",
"reason_comments": "Order delivered late"
}
}