簡介
Advanced Integrated Visibility Tracking Number Subscription 專為 Advanced Integrated Visibility 訂閱者設計,可管理追蹤號碼型 Webhook 專案,並使用 API 端點執行專案相關操作,例如新增追蹤號碼、編輯或查看工作詳細資料。
附註:
- 您必須具有 Advanced Integrated Visibility 專案的管理員或貢獻者存取權
- 如需 Advanced Integrated Visibility 及其功能的詳細資訊,請造訪「Advanced Integrated Visibility 文件」頁面。
Advanced Integrated Visibility Tracking Number Subscription 的優勢
Advanced Integrated Visibility Tracking Number Subscription 的優勢為:
- 您可以使用 API 端點,輕鬆更新和管理 Advanced Integrated Visibility 專案的追蹤號碼。
- 此 API 可讓您在單一 API 交易中,將多筆追蹤號碼與專案建立關聯,不必逐一將每筆追號碼建立關聯。
- 您可以連續提交 API 請求,並查看這些請求成功/失敗的記錄詳細資料。
Advanced Integrated Visibility Tracking Number Subscription 的運作方式
使用以下端點管理 Advanced Integrated Visibility 專案:
僅可依上方螢幕截圖所示,透過專案總覽存取此 API。
Tracking Number Association
使用此端點觸發非同步工作,將一或多筆追蹤號碼與特定 Advanced Integrated Visibility 專案建立關聯。
執行此請求的必要輸入資訊包括:
- 動作 – 指定提交請求時要執行的動作。例如:ADD
- 追蹤號碼詳細資料 – 指定追蹤號碼
您可以在單一請求中與最多 1000 組追蹤號碼建立關聯。此請求的成功回應會傳回 jobID、目前工作狀態,以及建立工作和完成工作時間戳記。稍後可使用 jobID 來查看非同步工作的狀態。
Tracking Number Job Status
使用此端點取得非同步工作 (佇列中一或多個連續請求) 的狀態,或所有提交工作的狀態。
執行此請求的必要輸入資訊包括:
- 工作識別碼 – 指定您要擷取狀態的工作識別碼。
注意:工作識別碼是此端點的選填輸入資訊。如果您未指定工作識別碼,就會收到所有提交工作的狀態。
此請求的成功回應會傳回 jobID、目前工作狀態,以及建立工作和完成工作時間戳記。回應會顯示工作的目前狀態。此外,回應也會包含成功訊息、錯誤或警告,供使用者查看或疑難排解 (若適用)。
- 如果工作狀態顯示為 COMPLETED,表示成功驗證並處理所有追蹤號碼。
- COMPLETED 狀態表示成功驗證並處理追蹤號碼。不表示成功將所有追蹤號碼新增至 Advanced Integrated Visibility 專案。
- 如果嘗試將多組追蹤號碼建立關聯,只有部分追蹤號碼會建立關聯,其餘會失敗,即便工作狀態會更新為 COMPLETED。若要確認關聯請求中每組追蹤號碼的狀態,必須下載批次報告。
- 如果工作狀態顯示 FAILED,表示由於多個原因/硬體故障而無法處理請求,使用者必須重試。
附註:
下列為狀態及個別說明:
| 工作狀態 | 說明 |
|---|---|
SUBMITTED |
工作在完成所有基本驗證後提交至系統,系統將非同步處理。 |
ACCEPTED |
已接受工作,將排入佇列。 |
UNACCEPTED |
由於內部故障或無法使用系統而未接受工作,使用者必須重試。 |
QUEUED |
工作排入佇列以供處理,且隨時會開始處理。 |
進行中 |
已開始工作,正在進行中。 |
已完成 |
已完成工作,且匯入報告或匯出檔案可供使用者下載。 |
失敗 |
由於多個原因,工作失敗,使用者必須重試。 |
Tracking Number Job Details
使用此端點下載處於 COMPLETED 狀態之非同步工作的 JSON 報告。
與此請求相關的必要輸入資訊為:
- 工作識別碼 – 指定您要擷取狀態的工作識別碼。
附註:
- 工作識別碼是此端點的必要輸入資訊。
- 您可以一次只下載一個非同步工作的報告。
- 如果工作非 COMPLETED 狀態,且您嘗試下載報告,系統會顯示錯誤訊息。
此請求的成功回應會提供您 JSON 格式的工作報告。
商務規則
- 每個請求中,最多可有 1,000 組託運追蹤號碼與 Advanced Integrated Visibility 專案建立關聯。
- 可與特定 Advanced Integrated Visibility 專案建立關聯的追蹤號碼數量沒有上限。
- 關聯的追蹤號碼會在 40 天後與該 Advanced Integrated Visibility 專案取消關聯。
- 特定 Advanced Integrated Visibility 專案建立的工作識別碼狀態和詳細資料在 90 天後即無法取得。
- 將無法透過 Advanced Integrated Visibility Tracking Number Subscription 取得受保護的追蹤資訊,例如收件人地址和收件人簽名。
Response