端點
訂單編號
檢索訂單編號清單。
訂單詳細資訊
檢索訂單的詳細資訊。
檢索訂單 API 端點使用
使用這些端點有兩種常見方式。
- (第 1 部分 + 第 2 部分)– 在您的網域上使用自訂訂單確認/成功頁面來觸發您的系統呼叫
orderDetail端點並匯入已完成的訂單。此外,定期呼叫orderNumbers端點以協調 Zonos 系統中未匯入至您系統的任何訂單。 - (僅第 2 部分)– 使用 Zonos 基本訂單確認/成功頁面或您網域上的靜態頁面向客戶指示訂單完成。安排您的系統定期呼叫
orderNumbers端點,以確定何時新訂單已準備好匯入至您的系統。找到未完成訂單時,呼叫orderDetail端點以取得這些訂單上的數據。
第 1 部分:您網域上的成功頁面
每當買家在 Zonos Checkout 中完成訂單時,他們會立即被重新導向至訂單成功頁面 URL。已完成訂單 ID 將作為查詢字串附加到重新導向 URL。訂單成功頁面的 URL 應提供給 Zonos。建立 Zonos 系統中的暫時購物車時,URL 也可以作為參數傳遞至 createTempCart 端點。
Example: http://www.examplestore.com/internationalThankYou?orderId=999-99999
當客戶被重新導向至此頁面時,您的系統需要從 URL 中解析 orderId 的值。然後,您將使用 orderId 呼叫 orderDetail 端點以檢索訂單數據。
第 2 部分:使用排定的工作
除了在觸發成功頁面時呼叫訂單詳細資訊外,我們建議您為所有訂單及其詳細資訊設定排定的呼叫作為捕捉所有呼叫。這樣,您可以檢索 Zonos 系統中尚未匯入至您系統的任何已完成訂單。
此程式應為排定的工作/指令碼,例如 Cron 工作,每小時/班次/天等執行一次(根據您的業務流程的需要進行排定)。指令碼應呼叫自上次訂單呼叫以來發生的所有訂單及其詳細資訊。orderNumbers 端點允許您檢索訂單 sinceOrderId 或 sinceDate,如位於此處的 API 測試 GUI 所示。通過此排定呼叫檢索到的所有訂單應針對每次觸發成功頁面時插入至您系統的訂單進行協調。任何尚未在您系統中的訂單應被插入至您系統中並視為合法訂單。
初始訂單狀態
IGLOBAL_ORDER_IN_PROCESS 或 IGLOBAL_FRAUD_REVIEW
呼叫 orderDetail 端點時,我們建議您的系統首先檢查訂單數據的 orderStatus 屬性。
不需要詐騙審查的訂單將初始化為 orderStatus : IGLOBAL_ORDER_IN_PROCESS。這種狀態的訂單已準備好進行處理和發送。
需要詐騙審查的訂單將初始化為 orderStatus : IGLOBAL_FRAUD_REVIEW。這種狀態的訂單目前正在進行篩選和審查以防止可疑詐騙。我們建議您將此訂單置於您系統中的審查或保留狀態,並繼續呼叫 orderDetail 端點,直到訂單超越 Zonos 詐騙審查流程。
Zonos 詐騙篩選流程完成後,訂單將移至以下狀態之一:
-
訂單通過詐騙篩選
- 訂單將移至
orderStatus:IGLOBAL_ORDER_IN_PROCESS並可繼續發送。
- 訂單將移至
-
訂單未通過詐騙篩選
- 訂單將移至
orderStatus:IGLOBAL_ORDER_CANCELLED,應在您的系統中取消。
- 訂單將移至
API 測試 GUI
請 聯絡支援 以取得您的帳戶認證。
檢索訂單
檢索訂單編號清單或有關訂單的詳細資訊。
此「檢索訂單」API 端點用於檢索 Zonos 系統內已完成訂單的數據。回應將包含 JSON 物件,代表訂單的所有可用資訊,包括帳單和運輸地址、運輸方法、訂單總計和狀態。