Refund Notification
WEBHOOK: POSThttps://<YOUR_WEBHOOK_URI> event_type: event.refund_request
event.refund_request
のタイプの Webhook は、注文の返金がリクエストされた際に送信されます。
¶ Webhook のサンプル
ステータスや状況によってフィールドは異なります。正確なフィールド定義のため、ご自身で「フィールドの定義」を参照し、確認してください。
{
"created": "2023-07-06T05:09:07.173Z",
"data": {
"created_at": "2023-07-06T05:09:07.173Z",
"currency_code": "GBP",
"id": "6817a070-115e-4ca9-8266-c245fe18a2d6",
"refund_fees": [
{
"category": "DELIVERY",
"fee_code": "UBER_DELIVERY_FEE",
"value": 7500
},
{
"category": "DELIVERY",
"fee_code": "PARTNER_FEE",
"value": 0
},
{
"category": "TAX",
"fee_code": "PARTNER_TAX",
"value": 0
}
],
"refund_order_items": [
{
"partner_refund_amount": 4000,
"party_at_fault": "UBER",
"reason": "UBER_DAMAGED_ITEM",
"refund_items": [
{
"name": "Donuts",
"quantity": 1
}
],
"uber_refund_amount": 4000
}
],
"total_partner_refund": 4000,
"total_uber_refund": 11500
},
"delivery_id": "del_G_8_eeo4Q5WrYpYkATt6SA",
"external_id": "",
"external_store_id": "Store abc",
"id": "evt_nyNh-zBTR-uxdQjq5kYxhg",
"kind": "event.refund_request",
"live_mode": true
}
¶ フィールドの定義
フィールド | 説明 |
---|---|
created |
イベントがいつ生成されたかを示すタイムスタンプ。 |
delivery_id |
イベントが適用される配達の識別子。 |
data |
Webhook の詳細。詳細については「データオブジェクトの定義」を参照してください。 |
id |
このイベントインスタンスの一意の識別子。 |
kind |
イベントの種類の詳細(event.courier_update)。 |
live_mode |
イベントがライブの配達とテスト配達のどちらに適用されるかを示すフラグ。 |
external_store_id |
店舗または場所を参照するためにパートナーが使用する一意の識別子。 |
external_id |
配達を参照するためにパートナーが使用する一意の識別子。 |
¶ データオブジェクトの定義
データオブジェクトには、Webhook に関するより詳しい情報が格納されます。
フィールド | 説明 |
---|---|
id |
返金リクエストの一意の識別子。 |
created_at |
返金の Webhook が作成された日時。 |
currency_code |
大文字 3 文字の ISO 通貨コード(例:USD)。 |
total_partner_refund |
パートナーが注文者に対して責任を負う合計金額(セント単位、通貨単位の 100 分の 1)。例:1234。 |
total_uber_refund |
Uber が請求の詳細レポートと請求書に対して調整を行う合計金額(セント単位、通貨単位の 100 分の 1)。例:1834。 |
refund_fees.fee_code |
UBER_DELIVERY_FEE :この特定の注文について Uber Direct がパートナーから受け取る手数料。PARTNER_FEE :この特定の注文についてパートナーが注文者から受け取る手数料。PARTNER_TAX :この特定の注文についてパートナーが注文者から受け取る税金。 |
refund_fees.value |
特定のカテゴリの返金手数料の金額。 |
refund_fees.category |
DELIVERY :配達関連の手数料。TAX :税金関連の手数料。 |
refund_order_items.refund_items.name |
商品の名前。 |
refund_order_items.refund_items.quantity |
商品の数量。 |
refund_order_items.party_at_fault |
値は UBER または PARTNER になります。 |
refund_order_items.partner_refund_amount |
パートナーが注文者に対して責任を負う商品の金額(セント単位、通貨単位の 100 分の 1)。例:10.99 ドル => 1099。 |
refund_order_items.uber_refund_amount |
Uber が請求の詳細レポートと請求書に対して調整を行う商品の金額(セント単位、通貨単位の 100 分の 1)。例:10.99 ドル => 1099。 |
refund_order_items.reason |
返金理由について事前に定義された文字列。使用できる値には以下が含まれます。PARTNER_NEVER_RECEIVED_ORDER PARTNER_ENTIRE_ORDER_WRONG PARTNER_MISSING_ITEMS PARTNER_DAMAGED_ITEM PARTNER_ORDER_DELIVERED_LATE PARTNER_HAD_TO_PREPARE_ORDER_AGAIN PARTNER_RETURN_TRIP_ISSUE PARTNER_NEVER_PICK_UP PARTNER_SAFETY_ISSUE UBER_NEVER_RECEIVED_ORDER UBER_ENTIRE_ORDER_WRONG UBER_MISSING_ITEMS UBER_DAMAGED_ITEM UBER_ORDER_DELIVERED_LATE UBER_HAD_TO_PREPARE_ORDER_AGAIN UBER_RETURN_TRIP_ISSUE UBER_NEVER_PICK_UP UBER_SAFETY_ISSUE REFUND_REJECTED |