Saltar al contenido principal

Recibir actualizaciones de entrega a través del webhook

API: Drive (classic)

Este documento cubre la API de Drive (Classic). Si utilizas la API de Drive, consulta la guía práctica para los webhooks de Drive.

Si necesitas actualizaciones sobre diferentes etapas de una entrega, proporciona al equipo de DoorDash un punto de conexión de la URL en el que te gustaría recibir eventos del webhook. Solo se admite un único punto de conexión de la URL.

Todos los eventos del webhook tendrán un encabezado de Authorization con un valor configurado.

Página del webhook

Configura la URL del webhook y el encabezado de Authorization

Con el Portal para desarrolladores de DoorDash, puedes configurar tu punto de conexión del webhook y el encabezado de Authorization que viene con cada solicitud de webhook.

 Nota: Debes solicitar acceso a producción antes de poder configurar el punto de conexión del webhook de producción.

Página del webhook

Eventos del webhook

Enviamos los siguientes eventos: Descripción del evento

  • delivery_created: cuando se crea una entrega.
  • dasher_confirmed: el Dasher confirmó que hará la entrega.
  • driver_batched: se asignó otra orden al Dasher además de la orden actual.
  • dasher_confirmed_store_arrival: el Dasher confirmó que ha llegado al lugar de retiro.
  • dasher_picked_up: el Dasher retiró los artículos de la entrega.
  • dasher_confirmed_consumer_arrival: el Dasher confirmó que llegó a la ubicación de entrega.
  • dasher_dropped_off: el Dasher había realizado la entrega en el destino.
  • delivery_pending_return: se inició una devolución para esta entrega.
  • dasher_confirmed_return_arrival: el Dasher llegó a la ubicación de devolución.
  • dasher_dropped_off_return: el Dasher regresó a la tienda para devolver la entrega.
  • delivery_cancelled: Se canceló la entrega.
  • delivery_attempted: el Dasher intentó ponerse en contacto con el cliente, pero este no estaba disponible para encontrarse con el Dasher.

Los siguientes eventos solo se envían si están habilitados para tu negocio:

  • dasher_supplied_parking_details: detalles sobre el estacionamiento proporcionados por el Dasher cuando está en la tienda para retirar una orden o entregar una devolución.
  • delivery_post_tip_received: propina recibida posterior a la entrega.
  • dasher_enroute_to_pickup: el Dasher está en camino a retirar la entrega.
  • dasher_enroute_to_dropoff: el Dasher está en camino a la ubicación de entrega.
  • dasher_enroute_to_return: el Dasher está regresando al lugar de retiro para devolver los artículos.
  • delivery_refunded: la orden se reembolsó. El monto de reembolso está especificado en la carga.

Importante: no todos los eventos se envían a las entregas creadas a través del Simulador de entregas. Consulta la sección Simulador de entregas para obtener más detalles.

Frecuencia de los eventos del webhook

El enrutamiento de eventos del webhook ocurre cada 30 segundos; comienza 15 minutos antes del retiro o entrega. Todos los demás eventos del webhook se producen tan pronto como tiene lugar el evento.

Webhook event_categorydelivery.statusdelivery.dasher_statusevent_data
delivery_createdscheduledunassigned
dasher_confirmedassignedaccepted
enroute_to_pickup
driver_batchedassigned
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_pickupassignedenroute_to_pickup
dasher_confirmed_store_arrivalassignedarrived_at_store
dasher_picked_uppicked_uppicked_up
enroute_to_dropoff
dasher_enroute_to_dropoffpicked_upenroute_to_dropoff
dasher_confirmed_consumer_arrivalpicked_uparrived_at_consumer
dasher_dropped_offdelivereddropped_off
delivery_pending_returnpending_returnpending_return
dasher_enroute_to_returnpending_returnenroute_to_return
dasher_confirmed_return_arrivalpending_returnarrived_at_return
dasher_dropped_off_returnreturneddropped_off_return
delivery_cancelledcancelledunassignedreason
reason_comments
delivery_attemptedcould_not_delivercould_not_deliver
dasher_supplied_parking_detailsassignedarrived_at_store
delivery_post_tip_receiveddelivereddropped_offpost_tip_amount
post_tip_received_time
delivery_refundedse aplican todos los estadosse aplican todos los estadosreason
reason_comments
amount
currency code
amount details

Motivos del reembolso

El motivo y los comentarios del motivo se envían como secuencia

MotivoComentarios del motivo
canceled_order_by_doordashOrden cancelada por DoorDash
canceled_order_by_merchant_requestOrden cancelada por la tienda
canceled_order_by_customer_requestOrden cancelada por el cliente
delivered_lateOrden entregada con demora
delivered_earlyOrden entregada con antelación
never_deliveredLa orden no llegó
missing_or_incorrect_itemsLa orden tiene artículos faltantes o incorrectos
poor_food_qualityComida de mala calidad
delivery_qualityLa calidad de la orden no coincide con las expectativas del cliente
health_safety_concernLa calidad de la orden no coincide con las expectativas del cliente
adjust_tipEl cliente modificó la propina
special_instructions_not_followedNo se siguieron las instrucciones especiales
otherOtro

Asignación de moneda y código de país

PaísMoneda
EE. UU.USD
CanadáCAD
AustraliaAUD

Carga de ejemplo

{
"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"
}
}