簡介
Advanced Integrated Visibility Account Number Subscription 專為 Advanced Integrated Visibility 訂閱者設計,可管理帳號型 Advanced Integrated Visibility 專案,並使用 API 端點執行專案相關操作,例如編輯或查看詳細資料。
附註:
- 您必須擁有啟用此 API 的 API 專案管理員存取權。
- 如需 Advanced Integrated Visibility 及其功能的詳細資訊,請造訪「Advanced Integrated Visibility 文件」頁面。
Advanced Integrated Visibility Account Number Subscription 的優勢
Advanced Integrated Visibility Account Number Subscription 的優勢為:
- 您可以使用 API 端點,輕鬆更新和管理 Advanced Integrated Visibility 專案。
- 此 API 可讓您在單一 API 交易中,將多個帳戶與專案建立關聯,不必逐一選取每個帳戶。
Advanced Integrated Visibility Account Number Subscription 的運作方式
使用以下端點管理 Advanced Integrated Visibility 專案:
更新 Advanced Integrated Visibility 專案
使用此端點更新您組織中任何 Advanced Integrated Visibility 專案的詳細資料。
此請求的輸入資訊包括:
- requestType:指定更新請求的類型。
- ADD_ACCOUNTS:如果組織已為所有帳戶建立與 Advanced Integrated Visibility 專案的關聯,使用此選項即可在現有專案中新增帳戶。
- DELETE_ACCOUNTS:使用此選項可從專案中刪除任何帳戶。
- UPDATE_ALL:此選項可用於定期更新專案。
注意:此選項僅供自由選用,若使用者未指定,系統在預設情形下會使用 UPDATE_ALL。 - category:指定您想針對專案更新的功能類別,例如 RETRY_POLICY、PROOF_OF_DELIVERY 等。
- subCategories:指定所選功能類別中的個別功能,例如 BASIC_HRS、PPOD、SPOD、SHIP、TRAN 等。
一旦系統成功回應此請求,便會傳回訂閱識別碼 (表示組織中的所有帳戶是否均已更新專案),以及已更新專案的時間戳記。
擷取專案詳細資料
使用此端點擷取指定 Advanced Integrated Visibility 專案的詳細資料,彙整成分頁格式。
執行此請求的必要輸入資訊包括:
- authorization:指定授權權杖。
- subscriptionId:指定 Advanced Integrated Visibility 專案的訂閱識別碼,以擷取詳細資料。
一旦系統成功回應此請求,便會以分頁格式產生指定 Webhook 專案的詳細資料;若回應失敗,則會傳回警示或錯誤詳細資料。
商務規則
- 一個請求中,最多可有 30,000 個託運帳號與 Advanced Integrated Visibility 專案建立關聯。
Response