端點
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
HTTPS 請求
| 欄位↕ | 備註↕ |
|---|---|
| HTTP 方法 | POST |
| 端點 URL | https://api.iglobalstores.com/v1/updateMerchantOrderId |
| 通訊協定 | HTTPS |
| 訊息格式 | JSON |
| 接受 HTTP 標題 | Accept: application/json |
| Content-Type HTTP 標題 | Content-Type: application/json |
請求本體中的 JSON 鍵/值對
1
{2
"store": "999",3
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",4
"orderId": "999-9999",5
"merchantOrderId": "12-34567"6
}請求 JSON 定義
| 欄位↕ | 備註↕ |
|---|---|
merchantOrderId 必需 | 此參數用於將您店舖的內部訂單 ID 傳遞至 Zonos 系統中的訂單。建議使用此參數以進行更好的帳務核對、通訊和稽核。string |
orderId 必需 | Zonos 訂單 ID - 可以透過或不透過您的店舖 ID 和連字號傳遞(示例:123-45678 或 45678)。注意:訂單完成並支付後,客戶將被重新導向至託管在您域名上的訂單完成/感謝訂購頁面。URL 將包含一個查詢字符串參數「orderId」,該參數將包含此值。integer / string |
secret 必需 | Zonos 提供的 API 秘密 GUID。string |
store 必需 | Zonos 提供的店舖 IDinteger |
HTTPS 回應
1
{2
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"3
}錯誤 HTTP 回應
| 錯誤代碼↕ | 定義↕ |
|---|---|
| 406 - Not Acceptable | HTML 實體。HTTP「Accept」標題無效。 |
| 415 - Unsupported media type | HTML 實體。HTTP「Content-Type」標題無效。 |
| 200 | 「error」:「無法解析輸入」 |
| 200 | 「error」:「需要參數 orderId 才能 processUpdateMerchantOrderId」 |
| 200 | 「error」:「需要參數 merchantOrderId 才能 updateMerchantOrderId。」 |
| 200 | 「error」:「orderId:999-99999 不是有效的 orderId」 |
| 200 | 「error」:「無法檢索訂單以 updateMerchantOrderId,orderId:999-99999」 |
| 200 | 「error」:「無法處理更新商家訂單 id。」 |
| 200 | 「error」:「無效的安全憑證」 |
回應 JSON 定義
| 訊息↕ | 定義↕ |
|---|---|
error | 此參數只在發生錯誤時出現在回應中,並將包含原因的描述。string |
success | 此參數將包含更新的摘要。string |
更新訂單編號
了解如何使用更新訂單編號的端點。updateMerchantOrderId端點用於使用您店舖的訂單編號來更新 Zonos 系統中的訂單,以便進行更好的帳務核對、通訊和稽核。