端點
POST | https://api.iglobalstores.com/v1/updateMerchantOrderId
HTTPS 請求
| 欄位↕ | 備註↕ |
|---|---|
| HTTP 方法 | POST |
| 端點 URL | https://api.iglobalstores.com/v1/updateMerchantOrderId |
| 協定 | HTTPS |
| 訊息格式 | JSON |
| Accept 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":"could not parse input" |
| 200 | "error":"Parameter orderId is required to processUpdateMerchantOrderId" |
| 200 | "error":"Parameter merchantOrderId is required to updateMerchantOrderId." |
| 200 | "error":"orderId: 999-99999 is not a valid orderId" |
| 200 | "error":"Could not retrieve order to updateMerchantOrderId for orderId: 999-99999" |
| 200 | "error":"Could not process update merchant order id." |
| 200 | "error":"Invalid security credentials" |
回應 JSON 定義
| 訊息↕ | 定義↕ |
|---|---|
error | 此參數僅在發生錯誤時才會出現在回應中，並將包含原因的描述。string |
success | 此參數將包含更新的摘要。string |
更新訂單編號
了解更新訂單編號的端點如何運作。updateMerchantOrderId端點用於使用您的商店訂單 ID 更新 Zonos 系統中的訂單，以便更好地進行對帳、通訊和審計。