エンドポイント
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 必須 | The Zonos order ID - can be passed with or without your store ID and hyphen (Example: 123-45678 or 45678).Note: After order completion and payment, the customer will be redirected to an Order Completion / Order Thank You page hosted on your domain. The URL will contain a querystring parameter “orderId” that will contain this value.integer / string |
secret 必須 | API secret GUID provided by Zonos.string |
store 必須 | Store ID provided by Zonosinteger |
HTTPSレスポンス
1
{2
"success": "Updated Order: 99999 with new merchantOrderId: 12-34567"3
}エラーHTTPレスポンス
| エラーコード↕ | 定義↕ |
|---|---|
| 406 - Not Acceptable | HTML Entity. HTTP “Accept” header is invalid. |
| 415 - Unsupported media type | HTML Entity. HTTP “Content-Type” header is invalid. |
| 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 | This parameter will only be present in the response when an error has occurred and will contain a description of the cause.string |
success | このパラメータには更新の要約が含まれます。string |
注文番号の更新
注文番号を更新するエンドポイントの仕組みを学びます。updateMerchantOrderIdエンドポイントは、照合・連絡・監査の改善のため、店舗の注文IDでZonosシステムの注文を更新するために使用します。