Champs de points d’ancrage Web
API: Drive (classic)
Ce document traite de l’API Drive (classique). Si vous utilisez l’API Drive, consultez le guide de référence des points d’ancrage Web Drive.
Si vous avez besoin de mises à jour sur les différentes étapes d'une livraison, veuillez fournir à l'équipe DoorDash une adresse URL de point de terminaison avec laquelle vous souhaitez recevoir les événements de point d'ancrage Web. Un seul point de terminaison d'URL est pris en charge.
Tous les événements de point d'ancrage Web auront un en-tête d'autorisation avec une valeur configurée.
Configuration de l'URL de votre point d'ancrage Web et de l'en-tête d'autorisation
À l'aide du portail des développeurs DoorDash, vous pouvez configurer votre point de terminaison de point d'ancrage Web et l'en-tête d'autorisation qui accompagne chaque demande de point d'ancrage Web.
Remarque : Vous devez demander un accès à la production avant de pouvoir configurer le point de terminaison du point d'ancrage Web de production.
Événements de points d'ancrage Web
Nous envoyons les événements suivants : Description de l’événement
delivery_created: Lorsqu’une livraison est créée.dasher_confirmed: Le Dasher a confirmé la livraison.driver_batched: En plus de la commande en cours, une autre commande a été assignée au Dasher.dasher_confirmed_store_arrival: Le Dasher a confirmé qu’il était arrivé au lieu de ramassage.dasher_picked_up: Le Dasher a ramassé les articles à livrer.dasher_confirmed_consumer_arrival: Le Dasher a confirmé qu’il était arrivé au lieu de livraison.dasher_dropped_off: Le Dasher avait déposé la livraison à destination.delivery_pending_return: Un retour a été initié pour cette livraisondasher_confirmed_return_arrival: Le Dasher est arrivé à l’emplacement de retour.dasher_dropped_off_return: Le Dasher a déposé le retour de livraisondelivery_cancelled: La livraison a été annulée.delivery_attempted: Le Dasher a essayé d'entrer en contact avec le client; le client n'était pas disponible pour rencontrer le Dasher.
Les événements suivants ne sont envoyés que s'ils sont activés pour votre entreprise :
dasher_supplied_parking_details: Détails du stationnement fournis par le Dasher lorsqu'il se trouve au commerce pour ramasser une commande ou déposer un retour.delivery_post_tip_received: Publier le pourboire reçu pour la livraison.dasher_enroute_to_pickup: Le Dasher est en route pour ramasser la livraison.dasher_enroute_to_dropoff: Le Dasher est en route vers le lieu de dépôt.dasher_enroute_to_return: Le Dasher est en route vers le lieu de ramassage pour retourner les articles.delivery_refunded: La commande a été remboursée. Le montant du remboursement est indiqué dans la charge utile.
Remarque : certains événements ne peuvent pas être attribués aux livraisons créées par le simulateur de livraison. Veuillez consulter la section sur le simulateur de livraison pour plus de détails.
Fréquence des événements de points d'ancrage Web
Les événements de points d'ancrage Web de type « enroute » sont générés aux 30 secondes à partir de 15 minutes avant le ramassage ou le dépôt. Tous les autres événements de points d'ancrage Web se produisent dès que l'événement a lieu.
| Catégories d’événements de point d’ancrage Web (Webhook.event_category) | État de livraison (delivery.status) | État du Dasher de la livraison (delivery.dasher_status) | Données de l’événement (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 | tous les états applicables | tous les états applicables | reason reason_comments amount currency code amount details |
Raisons du remboursement
La raison et le commentaire sur la raison sont envoyés sous forme de chaîne
| Raison | Commentaires sur la raison |
|---|---|
| canceled_order_by_doordash | Commande annulée par DoorDash |
| canceled_order_by_merchant_request | Commande annulée par le commerçant |
| canceled_order_by_customer_request | Commande annulée par le client |
| delivered_late | Commande livrée en retard |
| delivered_early | Commande livrée en avance |
| never_delivered | La commande n'est pas arrivée |
| missing_or_incorrect_items | Il manque des articles à la commande ou certains articles sont incorrects |
| poor_food_quality | Mauvaise qualité de la nourriture |
| delivery_quality | La qualité de la livraison ne correspond pas aux attentes des clients |
| health_safety_concern | La qualité de la livraison ne correspond pas aux attentes des clients |
| adjust_tip | Pourboire ajusté par le client |
| special_instructions_not_followed | Instructions spéciales non suivies |
| other | Autre |
Carte des codes de pays et des devises
| Pays | Devise |
|---|---|
| États-Unis | USD |
| Canada | CAD |
| Australie | AUD |
Exemple de charge utile
{
"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"
}
}