Webhook のフィールド
API: Drive (classic)
このドキュメントでは、Drive（クラシック）API について説明しています。Drive API を使用している場合は、「Drive の Webhook のリファレンスガイド」をご覧ください。
配達の様々な段階における最新情報が必要な場合は、DoorDash チームに Webhook イベントの受信を希望する URL エンドポイントをお知らせください。サポートされているのは 1 つの URL エンドポイントのみです。
すべての Webhook イベントには、構成済みの値を持つ「Authorization（認証）」ヘッダーがあります。
Webhook の URL と認証ヘッダーの設定
DoorDash 開発者ポータルを使用すれば、Webhook エンドポイントと各 Webhook リクエストに付随する認証ヘッダーを設定できます。
注意: プロダクション Webhook エンドポイントを設定するには、まずプロダクションアクセスをリクエストする必要があります。
Webhook イベント
DoorDash は以下のイベントを送信します。イベントの説明
delivery_created: 配達が作成されました。dasher_confirmed: ダッシャーが配達の割り当てを受け入れました。driver_batched: ダッシャーにはその注文に加え、別の注文が割り当てられています。dasher_confirmed_store_arrival: ダッシャーが商品の受け取り場所に到着しました。dasher_picked_up: ダッシャーが配達する商品を受け取りました。dasher_confirmed_consumer_arrival: ダッシャーが配達先住所に到着しました。dasher_dropped_off: ダッシャーが目的地に商品を配達しました。delivery_pending_return: この配達の返品手続きが開始されました。dasher_confirmed_return_arrival: ダッシャーが返品のロケーションに到着しました。dasher_dropped_off_return: ダッシャーが商品をお店に返品しました。delivery_cancelled: 配達がキャンセルされました。delivery_attempted:ダッシャーがお客様との連絡を試みましたが、お客様が不在でダッシャーに会うことができませんでした。
以下のイベントは、あなたのビジネスで有効になっている場合にのみ送信されます。
dasher_supplied_parking_details: ダッシャーが、商品の受け取りまたは返品のために店舗にいるときに、駐車情報を提供しました。delivery_post_tip_received: 配達に対するチップが受け取られました。dasher_enroute_to_pickup: ダッシャーが配達する商品を受け取るために店舗に移動中です。dasher_enroute_to_dropoff: ダッシャーが配達先住所に向かって移動中です。dasher_enroute_to_return: ダッシャーが、商品を返品するために商品の受け取り場所へと引き返しています。delivery_refunded: 注文料金が払い戻されました。払い戻し額はペイロード内に指定されています。
注意: 配達シミュレーターで作成した配達では、すべてのイベントが送信されるわけではありません。詳しくは「配達シミュレーター」のセクションをご参照ください。
Webhook イベントの頻度
Enroute の Webhook イベントは 30 秒ごとに発生し、受け取り（テイクアウト）または配達（ドロップオフ）の 15 分前から始まります。 その他の Webhook イベントは、イベントが発生すると同時に発生します。
| 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 配達完了 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 | 配達完了 | 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 | キャンセル済み | unassigned | reason reason_comments |
| delivery_attempted | could_not_deliver | could_not_deliver | |
| dasher_supplied_parking_details | assigned | arrived_at_store | |
| delivery_post_tip_received | 配達完了 | dropped_off | post_tip_amount post_tip_received_time |
| delivery_refunded | すべてのステータスが適用可能 | すべてのステータスが適用可能 | reason reason_comments 金額 通貨コード アカウント情報 |
払い戻しの理由
理由と reason_commnents は文字列として送信されます
| 理由 | 理由に関するコメント |
|---|---|
| canceled_order_by_doordash | DoorDash によってキャンセルされた |
| canceled_order_by_merchant_request | 加盟店によってキャンセルされた |
| canceled_order_by_customer_request | お客様によってキャンセルされた |
| delivered_late | 注文の配達が遅れた |
| delivered_early | 注文が早く到着した |
| never_delivered | 商品が到着しなかった |
| missing_or_incorrect_items | 注文商品が不足している、または商品が正しくない |
| poor_food_quality | 商品の品質に問題があった |
| delivery_quality | 配達の品質がお客様の期待と一致しない |
| health_safety_concern | 配達の品質がお客様の期待と一致しない |
| adjust_tip | お客様がチップを調整した |
| special_instructions_not_followed | お店へのご要望が無視された |
| other | その他 |
国コードと通貨のマッピング
| 国 | 通貨 |
|---|---|
| USA | USD |
| カナダ | CAD |
| オーストラリア | AUD |
ペイロードの例
{
"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"
}
}