DOCS

注文番号の更新

注文番号を更新するエンドポイントの仕組みを学びます。

updateMerchantOrderIdエンドポイントは、照合・連絡・監査の改善のため、店舗の注文IDでZonosシステムの注文を更新するために使用します。

エンドポイント 

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

HTTPSリクエスト

フィールド↕備考↕
HTTPメソッドPOST
エンドポイントURLhttps://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が提供するストアIDです。integer

HTTPSレスポンス

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

エラーHTTPレスポンス

エラーコード↕定義↕
406 - Not AcceptableHTML Entity. HTTP “Accept” header is invalid.
415 - Unsupported media typeHTML 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このパラメータは、エラーが発生した場合にのみレスポンスに含まれ、その原因の説明が記載されます。string
successこのパラメータには更新の要約が含まれます。string

このページは役に立ちましたか?


このページでは: