簡介
「進階集成可見性」帳號訂閱專為「進階集成可見性」的訂戶而設,讓他們能夠管理以帳號為基礎的「進階集成可見性」項目,並可利用API端點執行與項目相關的操作,例如編輯或檢視詳情。
請注意:
- 對於已啟用此API的API項目,您必須擁有管理員存取權限。
- 如需進一步了解「進階集成可見性」及其功能,請參閱「進階集成可見性」說明文件頁面。
「進階集成可見性」帳號訂閱的優勢
「進階集成可見性」帳號訂閱的優勢包括:
- 您可使用API端點,輕鬆更新及管理「進階集成可見性」項目。
- 此API讓您透過單一 API 交易,將多個帳戶關聯至您的項目,無需逐個選擇帳戶。
「進階集成可見性」帳號訂閱的運作方式
使用以下端點來管理您的「進階集成可見性」項目:
更新「進階集成可見性」項目
使用此端點更新貴組織名下任何「進階集成可見性」項目的詳情。
此請求的輸入資料為:
- requestType:指明更新請求的類型。
- ADD_ACCOUNTS:如組織的所有帳戶均已與「進階集成可見性」項目相關聯,請使用此選項來為現有項目新增帳戶。
- DELETE_ACCOUNTS:使用此選項來從項目中刪除任何帳戶。
- UPDATE_ALL:使用此選項進行常規項目更新。
備註:此乃可選元素,如用戶未有指明,則預設選擇為 UPDATE_ALL。 - category:指明您想為項目更新之功能的類別。例子:RETRY_POLICY、PROOF_OF_DELIVERY 等。
- subCategories:指明所選功能類別的個別功能。例子:BASIC_HRS、PPOD、SPOD、SHIP、TRAN 等。
對此請求的成功回應將傳回訂閱 ID,這是已為組織所有帳戶更新該項目的指標,另外亦會傳回已更新項目的時間戳記。
檢索項目詳情
使用此端點,以頁碼標註格式檢索指定「進階集成可見性」項目的項目詳情。
此請求的必須輸入資料為:
- authorization:指明授權令牌。
- subscriptionId:指明「進階集成可見性」項目的訂閱ID以檢索詳情。
對此請求的成功回應將以頁碼標註格式生成指定 Webhook 項目的詳情;如有任何失敗情況,將傳回警示或錯誤詳情。
業務規則
- 每個指定請求最多可為一個「進階集成可見性」項目關聯30,000個託運帳號。
Response