「進階集成可見性webhook」的類型
透過「進階集成可見性webhook」,FedEx能夠將近乎實時的安全查詢事件資料推送至與特定FedEx帳戶號碼相關聯的貨件目的地網址。
您可在FedEx Developer Portal上建立「進階集成可見性webhook」項目,然後根據您選擇的訂閱類型,將該webhook與一個或多個FedEx帳號或FedEx查詢號碼相關聯。
導覽至:
「進階集成可見性」帳號訂閱或「進階集成可見性」查詢號碼訂閱,以檢視建立相應「進階集成可見性webhook」的步驟。
FedEx「進階集成可見性」概覽
FedEx顧客可以訂閱帳號或查詢號碼,以接收近乎實時的運輸中貨件事件,從標籤建立到包裹送達證明等全都涵蓋在內,包括送達證明相片。
訂閱類型
FedEx顧客可透過下列選項訂閱「進階集成可見性」:
- 透過帳號—訂閱FedEx帳號,以接收與帳戶相符的貨件更新。
- 透過查詢號碼 — 訂閱FedEx查詢號碼,以透過API端點接收與指定查詢號碼相符的貨件更新。
請注意:目前訂閱必須以美國當地的FedEx 9位數字帳戶計費,顧客需根據查詢號碼的數量支付月費。如要深入了解「進階集成可見性」的價格,請參閱「進階集成可見性」概覽價格指南。
如以帳號訂閱,目前訂閱需要使用FedEx 9位數美國託運帳戶。
下表提供了帳號訂閱和「進階集成可見性」查詢號碼訂閱功能的資訊
| 功能 | 帳號訂閱 | 查詢號碼訂閱 |
|---|---|---|
| 回應 | 安全數據=個人識別資料(PII)數據 寄件人和收件人數據 簽收證明CDO (便利遞送選項)╱回應 | 匿名數據(包括貨件、運輸中更新,個人識別資料(PII)/回應除外) |
| 關聯 | 以帳號進行關聯 = 一次過關聯所有已連結的查詢號碼 | 查詢號碼的關聯 |
| 擁有權 | 帳號需由用戶自行擁有 | 查詢號碼無需由用戶擁有 |
| 篩選 | 能夠按進口、出口和第三方貨件篩選事件 |
無法篩選事件 |
| 整合 | 透過UI關聯帳號 | 透過API端點關聯查詢號碼 |
| 限制 | 最多可新增100個帳號 | 每項請求最多可新增1000個查詢號碼 |
| 合適的使用個案 | 第一方顧客—如果顧客擁有帳號 | 第三方顧客—如果顧客有屬於第一方顧客的查詢號碼 |
FedEx集成可見性–按訂閱類型的功能比較
| 功能/數據元素 | 查詢號碼訂閱 | 帳號訂閱 | 備註 |
|---|---|---|---|
| SPOD(簽收證明) | 不適用 | 可用(必須配置) | TIFF格式的簽名圖像,在數據中提供 |
| PPOD(送達證明) | 可用(必須配置) | 可用(必須配置) | 遞送地點的JPEG圖像,base64編碼 |
| PPODA(遞送嘗試圖片證明) | 可用(必須配置) | 可用(必須配置) | 適用於已嘗試遞送,提供JPEG圖像 |
| GPS坐標(gpsPodCoordinates) | 不適用 | 可選 | 以基於查詢的訂閱遮罩 |
| 聯絡資料(姓名、電話、公司) | 遮罩 | 可選 | 覆蓋寄件人、收件人、寄件地、目的地、清關代理人等 |
| 街道地址和郵區編號 | 遮罩 | 可選 | streetLines和postalCode以基於查詢的數據遮罩 |
| 帳號 | 遮罩 | 可選 | 包括付款人、寄件人和收件人帳戶值 |
| 包裹財務資料(例如declaredValue、codAmount) | 遮罩 | 可選 | 海關、貨到付款和申報值已遮罩 |
| 查詢和回件詳情(查詢代碼、回件原因) | 遮罩 | 可選 | 僅向基於帳戶的訂戶顯示完整詳情 |
| 商品和內容數據 | 遮罩 | 可選 | 包括零件代碼、說明、數量 |
| 員工ID(例如事件人員) | 遮罩 | 不適用 | 出於私隱原因,在兩種情況下均已遮罩 |
| 事件通知和EDD/EDTW | 可選 | 可選 | 兩者均支援預計送達日期/時間功能 |
| 多包裹貨件(MPS) | 可選 | 可選 | 連其他查詢資料 |
| 預計送達信心與風險分數 | 可選 | 可選 | 僅限高級級別 |
「進階集成可見性」查詢號碼訂閱的遮罩數據欄位
摘要
如客戶透過「進階集成可見性」查詢號碼訂閱訂閱貨件查詢更新,而非使用「進階集成可見性」帳號訂閱,特定的數據欄位會被遮罩,以保障客戶私隱,並遵守數據安全政策。
此遮罩機制可確保敏感資料(例如個人聯絡資料、地址和財務金額)僅限獲授權方能夠存取。使用「進階集成可見性」查詢號碼訂閱的顧客將看到下列遮罩欄位顯示為「XXXXX」,即使這些數據在「進階集成可見性」查詢號碼訂閱中原本為可供查閱。
此遮罩機制造成的影響包括:
- 對寄件地/目的地詳情和相關方的可見性受限制。
- 無法顯示個人識別資料(例如姓名、電話號碼)及財務或海關相關數據。
- 專門保障專屬或敏感貨件資料的安全與監管合規性。
如顧客因營運或業務用途而須存取這些遮罩欄位,建議改用帳號訂閱。
「進階集成可見性」查詢號碼訂閱中的遮罩數據點包括:
掃描事件
- scanEvent/location/locationContactAndAddress/address/streetLines
- scanEvent/location/locationContactAndAddress/contact/phoneNumber
- scanEvent/location/locationContactAndAddress/contact/companyName
- scanEvent/location/locationContactAndAddress/contact/personName
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/address/streetLines
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/contact/phoneNumber
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/contact/companyName
- scanEvent/previousEvents/[Array]/location/locationContactAndAddress/contact/personName
寄件人資料
- trackResult/shipperInfo/contactAndAddress/address/postalCode
- trackResult/shipperInfo/contactAndAddress/address/streetLines
- trackResult/shipperInfo/contactAndAddress/contact/phoneNumber
- trackResult/shipperInfo/contactAndAddress/contact/companyName
- trackResult/shipperInfo/contactAndAddress/contact/personName
- trackResult/shipperInfo/account/value
收件人資料
- trackResult/recipientInfo/contactAndAddress/address/postalCode
- trackResult/recipientInfo/contactAndAddress/address/streetLines
- trackResult/recipientInfo/account/value
- trackResult/recipientInfo/contactAndAddress/contact/phoneNumber
- trackResult/recipientInfo/contactAndAddress/contact/companyName
- trackResultecipientInfo/contactAndAddress/contact/personName
寄件地及目的地的地點
- trackResult/originLocation/locationDetail/locationContactAndAddress/contact/personName
- trackResult/originLocation/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/originLocation/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/originLocation/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/originLocation/locationDetail/locationContactAndAddress/address/postalCode
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/contact/personName
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/destinationLocation/locationDetail/locationContactAndAddress/address/postalCode
遞送和地址更改詳細資料
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/address/postalCode
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/address/gpsPodCoordinates
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/contact/personName
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/actualDeliveryAddress/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/address/postalCode
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/contact/personName
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/addressChangeRequested/locationDetail/locationContactAndAddress/contact/companyName
清關代理人資訊
- trackResult/broker/locationDetail/locationContactAndAddress/contact/phoneNumber
- trackResult/broker/locationDetail/locationContactAndAddress/contact/companyName
- trackResult/broker/locationDetail/locationContactAndAddress/contact/personName
- trackResult/broker/locationDetail/locationContactAndAddress/address/streetLines
- trackResult/broker/locationDetail/locationContactAndAddress/address/postalCode
包裹和財務詳細資料
- trackResult/packageDetail/customsValue/value
- trackResult/packageDetail/declaredValue/value
- trackResult/packageDetail/originalTransportationCharge/value
- trackResult/codDetail/codAmount/value
查詢和商品資料
- trackResult/inquiries/[Array]/categoryCode
- trackResult/inquiries/[Array]/code
- trackResult/inquiries/[Array]/createTime
- trackResult/inquiries/[Array]/statusCode
- trackResult/commodityInfo/[Array]/description
- trackResult/commodityInfo/[Array]/code
包裹內容和退回原因
- trackResult/contents/[Array]/partNumber
- trackResult/contents/[Array]/partCode
- trackResult/contents/[Array]/description
- trackResult/contents/[Array]/quantity
- trackResult/returnReason/[Array]/code
- trackResult/returnReason/[Array]/description
付款資料
- trackResult/billToParties/[Array]/billToParty/accountNumber
顧客可享受的益處:
- 透過主動通知運輸中貨件的預計送達日期和預計送達時間範圍變更,讓收件人更加放心無憂。
- 提供FedEx送達證明相片,以減少WISMO(我的訂單在哪裡)通話的顧客服務成本及遞送爭議。
- 提供近乎實時的貨件狀態通知,從而提升顧客體驗。
- 接收貨件的實時推送更新,而非持續輪詢以檢查所有貨件的查詢更新,從而提高營運效率。
功能和查詢事件
查詢事件
透過此功能可查詢貨件狀態,主動將有關貨件週期的不同更新資訊通知顧客。這樣,顧客便可選擇需接收通知/提示的確切貨件流程/事件階段。可用的託運事件包括:
- 託運:此選項會在已選擇的貨件事件發生時提供通知。例如:建立標籤、收件等
- 運送中:此選項會提供貨件運送事件的通知。例如:運送中、貨品暫存於派遞局等
- 遞送:此選項會提供貨件遞送事件的通知。例如:已在送件、已送達等
- 未能送達事故:此選項會提供未能送達事故的通知。例如:清關延誤等。
- 便利遞送選項:您可選擇此選項,以接收部分個人化查詢事件的通知。例如:已接受由服務站保管的請求。
有關可用貨件事件選項的更多資訊,請參閱「進階集成可見性」查詢事件的狀態代碼和狀態表。
送達證明
此功能用於確認訂單已成功送達目的地。當中包括:
- 相片送達證明(PPOD):PPOD能向顧客發送相片,以顯示包裹送達他們府上後的實際所在地點。
「進階集成可見性」會在JSON數據中以base64格式提供PPOD相片。圖像可轉換成JPEG格式。
請注意:
- PPOD 適用於美國、加拿大、波多黎各、中國香港、紐西蘭、英國和愛爾蘭。
- PPOD僅適用於FedEx Ground、FedEx Express,以及住宅包裹/地址。
- PPOD 適用於無需 SPOD 的合資格遞送。PPOD 和 SPOD 不能同時提供。
- PPOD 適用於不須簽名 (NSR) 遞送,並且不能直接交給顧客 (例如:遞送時直接交至顧客手上)。
- PPOD支援的圖片大小為14000至33000位元(適用於解像度為320x240的圖片)。
- 嘗試遞送證明圖像 (PPODA):如未能完成遞送,PPODA能向顧客發送相片,以顯示包裹原應送達的實際位置。「進階集成可見性」會在JSON數據中以base64格式提供PPODA相片。圖像可轉換成JPEG格式。
- PPODA適用於美國和波多黎各。
- PPODA僅適用於FedEx Ground、FedEx Express,以及住宅和商業包裹╱地址。
- PPODA相片可以是:
- 派遞通知單貼在門上的PPODA相片。
- 遞送位置障礙物的相片(例如:緊鎖的大門)。
- 包裹遞送至站點的PPOD相片。
- PPODA支援的圖片大小為14000至33000位元(適用於解像度為320x240)
- 簽收證明(SPOD):SPOD能向顧客發送相片,顯示收件人的簽名及其姓名、遞送日期、時間和地點。簽收證明資料將以位元數組形式呈現,而非圖片。位元數組是一組base64加密字串,應將其解密以取得PNG格式的最終簽名圖片
- 簽收證明適用於「進階集成可見性」查詢號碼訂閱。
- 簽收證明的圖片大小將為4000至6000位元(適用於解像度為400x95的圖片)。
- 簽收證明的圖片大小將為5000至8000位元(適用於解像度為230x150的圖片)。
- GPS送達證明(GPSPOD):
- GPS送達證明讓顧客能夠接收遞送地點的地理座標。
請注意:GPSPOD預設適用於「進階集成可見性」帳號訂閱。
- GPS送達證明讓顧客能夠接收遞送地點的地理座標。
預計送達日期及送達時間範圍的事件
此功能可提供貨件遞送的日期及/或時間範圍,以協助貨件收件人規劃日程安排。當中包括:
- 預計送達日期(EDD):此選項會提供貨件預計送達給收件人的日期。例如:20XX年11月20日。
- 預計送達時間範圍(EDTW):此選項會於實際遞送當天,為收件人提供貨件預計送達的時間範圍。範例:下午2時至下午6時。
以事件為基礎的篩選
此功能讓顧客能根據貨件的付款方式組織其Webhook項目。選項包括:
- 進口:如果貨件將會遞送給您,並由您以收件人的身份付款,可選擇此選項。
- 出口:如果貨件將會由您託運,並由您以寄件人的身份付款,可選擇此選項。
- 第三方:如果進口或出口貨件由您作為第三方付款人付款,可選擇此選項。
請注意:您需使用FedEx帳號付款或支付貨件費用。如果您是第三方付款人,便不是寄件人或收件人,但將會由您的FedEx帳號收取帳單。
重試政策
此功能可阻止FedEx在出現客戶端問題時傳送查詢事件資料。FedEx將會保留資料,並嘗試在5分鐘內重新傳送3次。
如果FedEx在已定義的時間範圍內未收到成功回應,便會停止為該特定事件重新遞送。不過,顧客可透過「進階集成可見性webhook」項目「詳細資訊」頁面上的手動「重試」按鈕,請求處理過去7天內錯過的事件。
有關重試政策的更多資訊,請參閱重試機制部分。
Response