Webhook のフィールド
API: Drive
このドキュメントでは、Drive API について説明しています。Drive(クラシック)API を使用している場合は、「Drive(クラシック)の Webhooks のリファレンスガイド」をご覧ください。
Webhook のレスポンスの詳細
Webhook のレスポンスには、以下のフィールドのいくつかが含まれます。値が空または null のフィールドはレスポンスで送信されません。
フィールド名 | 説明 | Webhook フィールドを使用できるイベント |
---|---|---|
created_at | Webhook が作成された時刻 | すべてのイベント |
event_name | Webhook をトリガーしたイベント(上記のリストを参照) | すべてのイベント |
external_delivery_id | 配達の作成時に提供された ID | すべてのイベント |
dasher_name | 注文を配達するダッシャーの氏名 | すべてのイベント |
dasher_phone_number | 注文を配達するダッシャーの電話番号 | すべてのイベント |
pickup_address | 配達商品を受け取る場所 | すべてのイベント |
pickup_phone_number | 受け取りに関して問題が発生した場合にダッシャーが電話する電話番号 | すべてのイベント |
pickup_reference_tag | ダッシャーが受け取る正しい配達商品を特定するのに役立つ情報 | すべてのイベント |
pickup_instructions | ダッシャーが注文商品の受け取り時に従わなければならない指示 | すべてのイベント |
dropoff_address | 配達する商品の配達先住所 | すべてのイベント |
dropoff_phone_number | 受け取りに関して問題が発生した場合にダッシャーが電話する電話番号 | すべてのイベント |
dropoff_instructions | ダッシャーが注文の商品を届ける際に従わなければならない指示 | すべてのイベント |
dropoff_contact_given_name | 連絡先の名前 | すべてのイベント |
dropoff_contact_family_name | 連絡先の名字 | すべてのイベント |
dropoff_contact_send_notifications | 連絡先がこの配達について DoorDash から通知を受け取るかどうか(デフォルトは false で、更新はできません) | すべてのイベント |
pickup_time_estimated | 配達商品の受け取り予定時刻 | すべてのイベント |
pickup_time_actual | 配達商品を受け取った時刻 | DASHER_PICKED_UP 以降のすべてのイベント |
pickup_verification_image_url | ダッシャーが受け取った注文内容の画像(ピアツーピアの注文のみ) | DASHER_PICKED_UP 以降のすべてのイベント |
dropoff_time_estimated | 配達商品の配達予定時刻 | すべてのイベント |
dropoff_time_actual | 配達商品を配達した時刻 | DASHER_DROPPED_OFF 以降のすべてのイベント |
dropoff_verification_image_url | ダッシャーが届けた注文内容の画像 | DASHER_DROPPED_OFF 以降のすべてのイベント |
currency | 「order_value 」、「fee 」および「tip 」の金額の通貨(以下のリストを参照) | すべてのイベント |
order_value | 注文に含まれるすべての商品の金額 | すべてのイベント |
fee | DoorDash が請求する配達料金 | すべてのイベント |
tip | ダッシャーへのチップの金額 | すべてのイベント |
support_reference | この注文について DoorDash サポートに問い合わせる場合に使用できる ID | すべてのイベント |
tracking_url | 配達の追跡に使用できる DoorDash Drive ポータルの URL | すべてのイベント |
contactless | 非接触型配達か通常配達か | すべてのイベント |
cancellation_reason | 注文がキャンセルされた理由 | 「DELIVERY_CANCELLED 」イベントのみ |
国コードと通貨のマッピング
国 | 通貨 |
---|---|
USA | USD |
カナダ | CAD |
オーストラリア | AUD |
ペイロードの例
{
"created_at": "2022-02-01T23:18:22.791883Z",
"event_name": "DASHER_DROPPED_OFF",
"external_delivery_id": "c19a5d37-e457-4247-9a67-921ec0134125",
"dasher_name": "TAS-DASHER-02 TAS",
"dasher_phone_number": "+16504379788",
"pickup_address": "1000 4th Avenue, Seattle, WA 98104",
"pickup_phone_number": "+1(855)9731040",
"pickupReferenceTag": "reftag",
"pickup_instructions": "please take it to floor 21",
"dropoff_address": "1201 3rd Avenue, Seattle, WA 98101",
"dropoff_phone_number": "+1(855)9731040",
"dropoff_instructions": "please take it to floor 21",
"dropoff_contact_given_name": "John",
"dropoff_contact_family_name": "Doe",
"dropoff_contact_send_notifications": true,
"order_value": 5555,
"currency": "USD",
"pickup_time_estimated": "2022-02-01T23:32:06.000000Z",
"pickup_time_actual": "2022-02-01T23:17:20.521249Z",
"dropoff_time_estimated": "2022-02-01T23:56:06.000000Z",
"dropoff_time_actual": "2022-02-01T23:18:22.541773Z",
"fee": 975,
"tip": 230,
"support_reference": "1343593362",
"tracking_url": "https://doordash.com/drive/portal/track/53904a0b-18cd-4308-b6dc-1d83932d7990",
"contactless": false
}