Three lines

Uber

Developers

Courier Update Webhook

WEBHOOK: POSThttps://<YOUR_WEBHOOK_URI> event_type: event.courier_update

event.courier_update のタイプの Webhook は、配達パートナーが割り当てられた瞬間(つまり配達の status が「ピックアップ」に移行したとき)から 20 秒ごとに送信されます。この Webhook のペイロードには latlong が格納され、配達パートナーの最新の位置情報をアプリケーションに提供します。

delivery_status イベントと同様に、courier_update イベントにも配達に関するすべての情報の最新のコピーを含むデータオブジェクトが格納されます。

Webhook のサンプル

ステータスや状況によってフィールドは異なります。正確なフィールド定義のため、ご自身で「フィールドの定義」を参照し、確認してください。

{
  "created": "2023-07-06T05:09:07.173Z",
  "data": {
    "batch_id": "bat_ISjTutXjV3GhWp_bRn_iPA",
    "complete": false,
    "courier": {
      "img_href": "https://d1w2poirtb3as9.cloudfront.net/default.jpeg",
      "location": {
        "lat": 40.71093,
        "lng": -74.0119
      },
      "location_description": "",
      "name": "Cori R.",
      "phone_number": "+11111111111",
      "rating": "5.00",
      "vehicle_color": "white",
      "vehicle_make": "Toyota",
      "vehicle_model": "Prius",
      "vehicle_type": "car",
      "unmarked_location_description": "I'm parked next to the large evergreen tree next to the UPS truck",
      "public_phone_info": {
        "formatted_phone_number": "+15555555557,48023618",
        "phone_number": "+15555555557",
        "pin_code": "48023618"
      },
      "vehicle_license_plate": "**E54Q"
    },
    "courier_imminent": false,
    "created": "2023-07-06T05:06:02.411Z",
    "currency": "usd",
    "deliverable_action": "deliverable_action_meet_at_door",
    "dropoff": {
      "address": "231 Hudson St, New York, NY 10013",
      "detailed_address": {
        "street_address_1": "231 Hudson St",
        "street_address_2": "",
        "city": "New York",
        "state": "NY",
        "zip_code": "10013",
        "country": "US"
      },
      "location": {
        "lat": 40.724533,
        "lng": -74.00839
      },
      "name": "DROPOFF T.",
      "notes": "",
      "phone_number": "+15555555556",
      "verification": {
        "barcodes": [
          {
            "scan_result": {
              "outcome": "SUCCESS",
              "timestamp": "2023-07-06T06:49:05.154Z"
            },
            "type": "CODE39",
            "value": "123"
          }
        ],
        "picture": {
          "image_url": "https://tb-static.uber.com/prod/file-upload/uploads/direct-image-capture/bb530825-891d-482a-8f05-6288235d7120"
        },
        "pin_code": {
          "entered": "9999"
        },
        "signature": {
          "image_url": "https://tb-static.uber.com/prod/file-upload/uploads/courier-task-platform/signatures/3e030abc-87d7-4f8d-a458-e0f27b489f0b",
          "signer_name": "Sam",
          "signer_relationship": "self"
        }
      },
      "verification_requirements": {
        "barcodes": [
          {
            "type": "CODE39",
            "value": "123"
          }
        ],
        "picture": true,
        "pincode": {
          "enabled": true,
          "value": "9999"
        },
        "signature": true,
        "signatureRequirement": {
          "collect_signer_name": true,
          "collect_signer_relationship": true,
          "enabled": true
        }
      }
    },
    "dropoff_deadline": "2023-07-06T05:56:08Z",
    "dropoff_eta": "2023-07-06T05:20:00.098Z",
    "dropoff_ready": "2023-07-06T05:06:02Z",
    "external_id": "",
    "fee": 9200,
    "id": "del_y_aY8RuTQ0CRKu2aFXe8qQ",
    "kind": "delivery",
    "live_mode": false,
    "manifest": {
      "description": "1 X Small Box\n",
      "total_value": 0
    },
    "manifest_items": [
      {
        "dimensions": {
          "depth": 40,
          "height": 40,
          "length": 40
        },
        "must_be_upright": false,
        "name": "Small Box",
        "price": 0,
        "quantity": 1,
        "size": "large"
      }
    ],
    "pickup": {
      "address": "175 Greenwich St, New York, NY 10007",
      "detailed_address": {
        "street_address_1": "175 Greenwich St",
        "street_address_2": "",
        "city": "New York",
        "state": "NY",
        "zip_code": "10007-2438",
        "country": "US"
      },
      "location": {
        "lat": 40.71093,
        "lng": -74.0119
      },
      "name": "Coffee Shop",
      "notes": "",
      "phone_number": "+15555555555"
    },
    "pickup_action": "default",
    "pickup_deadline": "2023-07-06T05:26:02Z",
    "pickup_eta": "2023-07-06T05:10:27.161Z",
    "pickup_ready": "2023-07-06T05:06:02Z",
    "quote_id": "dqt_y_aY8RuTQ0CRKu2aFXe8qQ",
    "route_id": "rte_THoz2XrARG-JBNW15eRecg",
    "status": "pickup",
    "tracking_url": "https://www.ubereats.com/tw/orders/cbf698f1-1b93-4340-912a-ed9a1577bca9",
    "undeliverable_action": "",
    "undeliverable_reason": "",
    "updated": "2023-07-06T05:08:25.53Z",
    "uuid": "CBF698F11B934340912AED9A1577BCA9"
  },
  "delivery_id": "del_y_aY8RuTQ0CRKu2aFXe8qQ",
  "id": "evt_WNjLziAJT4eiOKgPsLNtbw",
  "kind": "event.courier_update",
  "live_mode": true,
  "location": {
    "lat": 40.71093,
    "lng": -74.0119
  }
}

フィールドの定義

フィールド 説明
created イベントがいつ生成されたかを示すタイムスタンプ。
delivery_id イベントが適用される配達の一意の識別子。
id このイベントインスタンスの一意の識別子。
kind イベントの種類の詳細(event.courier_update)。
data Webhook の詳細。詳細については「データオブジェクトの定義」を参照してください。
live_mode イベントがライブ配達とテスト配達のどちらに適用されるかを示すフラグ。
location.lat 配達パートナーの所在地を示す緯度。
location.lng 配達パートナーの所在地を示す経度。

データオブジェクトの定義

データオブジェクトには、Webhook に関する詳細情報が含まれます。
フィールド 説明
id イベントが適用される配達の一意の識別子。
status イベントが参照する配達のステータス。
created 配達が作成された日時。
updated 配達の最終更新日時。
pickup_eta 配達パートナーがピックアップ場所に到着する予定時間。
pickup_ready 配達品のピックアップの準備がいつ整うか。ここでピックアップウィンドウが開始します。
pickup_deadline 配達品をいつまでにピックアップする必要があるか。ここでピックアップウィンドウが終了します。
dropoff_eta 配達パートナーが受け渡し場所に到着する予定時間。
dropoff_ready 配達の受け渡しの準備がいつ完了するか。ここで受け渡しウィンドウが開始します。
dropoff_deadline 配達の受け渡しをいつ行う必要があるか。ここで受け渡しウィンドウが終了します。
quote_id 配達見積もりの一意の識別子。この配達の作成時に指定されていた場合。
fee この配達が作成された場合に請求される金額(セント単位、通貨単位の 100 分の 1)。例:10.99  ドル => 1099。
currency 小文字 3 文字の ISO 通貨コード。
​​tip 配達パートナーにチップとして支払われる金額(セント単位、通貨単位の 100 分の 1)。
manifest.reference 積荷目録を特定する参照。
manifest.description [廃止予定] 配達パートナーが配達する物の詳細な説明。ManifestItem.name の各商品の説明をご使用になることをお勧めします。
manifest.total_value 配達に含まれる商品の金額(セント単位、通貨単位の 100 分の 1)。例:10.99  ドル => 1099。
manifest_items.name 商品の説明。
manifest_items.quantity 商品の数量。
manifest_items.size 商品のおおよそのサイズ。選択肢は S、M、L、XL。
指定がない場合はデフォルトで S が適用されます。
manifest_items.dimensions.length 長さ(cm)。
manifest_items.dimensions.height 高さ(cm)。
manifest_items.dimensions.depth 奥行き(cm)。
manifest_items.price 料金(セント単位、通貨単位の 100 分の 1)。例:10.99  ドル => 1099。
manifest_items.weight 重量(グラム)。
注:dimensions を使用する場合、weight フィールドは必須です。
pickup 配達のピックアップの詳細。詳細については配達情報の定義テーブル を参照してください。
dropoff 配達の受け渡しの詳細。詳細については配達情報の定義テーブル を参照してください。
return 配達品の返送の詳細。詳細については配達情報の定義テーブル を参照してください。
courier.name 配達パートナーの氏名のイニシャル。
courier.rating [廃止予定] 配達パートナーの評価(1.0 ~ 5.0 点)。
courier.vehicle_type 配達パートナーが使用している車両の種類。現在、自転車、車、バン、トラック、スクーター、バイク、徒歩に対応しています。
courier.phone_number 配達パートナーの電話番号。この電話番号はマスクされており、受け渡し先の電話番号からの通話または SMS のみ受信できます。
courier.location.lat 配達パートナーの位置を示す緯度。
courier.location.lng 配達パートナーの位置を示す経度。
courier.unmarked_location_description 配達パートナーアプリでの入力内容に基づいて調整された、配達パートナーの位置に関するマークなしの説明を含むフィールド。このフィールドは、配達パートナーがマークなしの地点にいることを確認した場合にのみ返されます。
courier.img_href 配達パートナーのプロフィール画像の URL。
courier.public_phone_info.formatted_phone_number 所定のフォーマットに変換した配達パートナーの電話番号の画像。
courier.public_phone_info.phone_number 配達パートナーの匿名化された電話番号。
courier.public_phone_info.pin_code 配達パートナーの匿名化された電話番号に対応する暗証番号。
courier.vehicle_license_plate 配達パートナーの車両のナンバープレート番号の末尾 4 桁。
live_mode 配達がライブモードかテストモードかを示すフラグ。
related_deliveries.id 関連する配達は、同じ関連付けを共有する他のジョブを説明するコレクションです。
配達の一意の識別子です。
related_deliveries.relationship related_deliveries で特定される配達の性質を示すフラグ。配達の往路は「original」、返送は「returned」になります。
tracking_url 配達中の配達パートナーを追跡する URL。
courier_imminent 配達パートナーがピックアップ場所または受け渡し場所にあと 1 分で到着するときに true に設定されるフラグ。
undeliverable_reason このフィールドには、配達を完了できなかった場合の理由が格納されます。
undeliverable_action このフィールドには、完了できなかった配達に対して配達パートナーが最終的に選択したアクションが格納されます。
complete 配達が進行中かどうかを示すフラグ。
kind 記述されるオブジェクトの種類(例:配達)。
uuid 代替の配達識別子。識別の目的には必ず「id」フィールドを使用する必要があります。「uuid」フィールドの値も一意ですが、コンテキスト情報が失われます(この識別子の中に、これが配達に関連するものであることを示す情報はありません)。「id」フィールドとは異なり、「uuid」では大字と小文字が区別されます。「uuid」フィールドの値は UUID v4 で、「-」は削除されます(例:41B2E8C22C0740CF9BE1EF1898E64D3B)。
batch_id 複数注文者への配達の場合、この一意の識別子(接頭辞は bat_)はこの配達が属するバッチを示します。同じ配達パートナーが一括で行う配達を特定するために使用できます。
**重要:**配達パートナーがピックアップ場所への移動中に配達をキャンセルした場合、Uber はその配達を別の配達パートナーに割り当てるため、batch_id が変更されます。
route_id 配達パートナーが移動するルートの一意の識別子(接頭辞は rte_)。
cancelation_reason.primary_reason 値は常に #Uber になります。
cancelation_reason.secondary_reason 値は COURIER_CANCELMERCHANT_CANCELUBER_CANCEL のいずれかになります。
pickup_action ピックアップ時に実行する必要のあるアクションを指定します。

配達情報の定義

このテーブルはデータオブジェクトの pickup、return、dropoff のフィールドに適用されます。
フィールド 説明
name 参照ポイントにいる人の名前。
phone_number 参照ポイントの電話番号。
address 参照ポイントの住所。
detailed_address.street_address_1 参照ポイントの町名および番地の 1 行目。
detailed_address.street_address_2 参照ポイントの町名および番地の 2 行目(任意)。
detailed_address.city 参照ポイントの市区町村。
detailed_address.state 参照ポイントの都道府県。
detailed_address.zip_code 参照ポイントの郵便番号。
detailed_address.country 参照ポイントの国。
location.lat 参照ポイントの場所の緯度。
location.lng 参照ポイントの場所の経度。
notes 参照ポイントの場所についての追加指示。
verification.signature.image_url 参照ポイントで行われた署名の画像の URL。
verification.signature.signer_name 配達品に署名した人の名前。
verification.signature.signer_relationship 配達品に署名した人と受け取り予定の人との関係。
verification.barcodes.value バーコード内にエンコードされた文字列の値。
verification.barcodes.type バーコードの種類。有効な値:CODE39CODE39_FULL_ASCIICODE128QR
verification.barcodes.scan_result.outcome スキャンが成功したか失敗したかを示す文字列。
verification.barcodes.scan_result.timestamp イベントが生成された時間を示すタイムスタンプ。
verification.picture.image_url 参照ポイントで撮影された画像の URL。
verification.identification.min_age_verified 取得した身分証明書情報またはスキャン情報。ID の確認/スキャンが正常に完了した場合にフラグを設定します。
verification.pin_code.entered 暗証番号の確認で入力された値。
verification.completion_location.lat ジョブが完了した場所の緯度。
verification.completion_location.lng ジョブが完了した場所の経度。
verification_requirements.signature 参照ポイントで署名が必要かどうかを示すフラグ。
verification_requirements.signatureRequirement.collect_signer_name 参照ポイントで署名者の名前が必要かどうかを示すフラグ。
verification_requirements.signatureRequirement.collect_signer_relationship 参照ポイントで発送元と署名者の関係が必要かどうかを示すフラグ。
verification_requirements.signatureRequirement.enabled 参照ポイントで署名が必要かどうか。
verification_requirements.barcodes.type バーコード内にエンコードされた文字列の値。
verification_requirements.barcodes.value バーコードの種類。有効な値:CODE39CODE39_FULL_ASCIICODE128QR
verification_requirements.picture 参照ポイントで写真が必要かどうかを示すフラグ。
verification_requirements.pincode.enabled 参照ポイントで暗証番号が必要かどうかを示すフラグ。
verification_requirements.pincode.value 暗証番号の確認で入力された値。
courier_notes 配達証明として写真をリクエストされた場合、このフィールドには配達パートナーからのメモ(商品を置いた場所など)が表示されます。

Uber

Developers
© 2026 Uber Technologies Inc.