Checkout•

注文番号の更新

注文番号を更新するエンドポイントの動作を学びましょう。

updateMerchantOrderIdエンドポイントは、より良い照合、コミュニケーション、および監査のために、あなたのストアの注文IDを使用してZonosシステム内の注文を更新するために使用されます。

エンドポイント

POST | https://api.iglobalstores.com/v1/updateMerchantOrderId

フィールド	ノート
HTTPメソッド	POST
エンドポイントURL	`https://api.iglobalstores.com/v1/updateMerchantOrderId`
プロトコル	HTTPS
メッセージフォーマット	JSON
Accept HTTPヘッダー	Accept: application/json
Content-Type HTTPヘッダー	Content-Type: application/json

例

{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "orderId": "999-9999",
  "merchantOrderId": "12-34567"
}

フィールド	ノート
`merchantOrderId` 必須	このパラメータは、Zonos システム内の注文にあなたの店舗の内部注文 ID を渡すために使用されます。これは、より良い調整、コミュニケーション、および監査のために推奨されます。`string`
`orderId` 必須	Zonos 注文 ID - あなたの店舗 ID とハイフンを付けて渡すことも、付けずに渡すこともできます（例：123-45678 または 45678）。注意：注文の完了と支払い後、顧客はあなたのドメインにホストされた注文完了 / 注文感謝ページにリダイレクトされます。URL には、この値を含むクエリ文字列パラメータ “orderId” が含まれます。`integer / string`
`secret` 必須	Zonos によって提供された API シークレット GUID。`string`
`store` 必須	Zonos によって提供された店舗 ID。`integer`

成功レスポンスの例

{
  "success": "Updated Order: 99999 with new merchantOrderId: 12-34567"
}

例外エラー応答

{
  "error": "Could not retrieve order to updateMerchantOrderId for orderId: 99999"
}

エラーコード	定義
406 - Not Acceptable	HTMLエンティティ。HTTP “Accept”ヘッダーが無効です。
415 - Unsupported media type	HTMLエンティティ。HTTP “Content-Type”ヘッダーが無効です。
200	“error”:”入力を解析できませんでした”
200	“error”:”Parameter orderIdはprocessUpdateMerchantOrderIdを処理するために必要です”
200	“error”:”Parameter merchantOrderIdはupdateMerchantOrderIdを更新するために必要です。”
200	“error”:”orderId: 999-99999は有効なorderIdではありません”
200	“error”:”orderId: 999-99999のupdateMerchantOrderIdを取得できませんでした”
200	“error”:”マーチャントオーダーIDの更新を処理できませんでした。”
200	“error”:”無効なセキュリティ資格情報”

メッセージ	定義
`error`	このパラメータはエラーが発生した場合にのみ応答に存在し、原因の説明を含みます。`string`
`success`	このパラメータは更新の概要を含みます。`string`

質問は？

Zonosを見る