DOCS

注文ステータスの更新

注文ステータスの更新

注文ステータスを更新するエンドポイントの仕組みを学びます。

updateVendorOrderStatusエンドポイントは、Zonosシステム内の注文ステータスを更新するために使用します。注文の配送ステータスをプログラムで更新したり、キャンセルを要求したりします。

現在の注文ステータス値 

注文が取り得る現在の注文ステータス一覧です。

注意 - Zonosはいつでもステータスを追加する場合があります。システムは追加ステータスの存在に対応できるようにしてください。

本番のステータスは本番に残ります。Zonosが既存のステータスを削除することはありません。

ステータス説明設定者
IGLOBAL_FRAUD_REVIEW注文は現在iGlobalによる不正レビュー中です。Zonos
IGLOBAL_ORDER_IN_PROCESS注文は有効で処理準備ができています。Zonos
IGLOBAL_ORDER_ON_HOLD注文は現在一時的なステータス保留中です。Zonos
IGLOBAL_ORDER_CANCELLED注文はiGlobalシステムでキャンセルされました。Zonos
VENDOR_PREPARING_ORDERベンダーが注文を準備中とマークしました。Vendor
VENDOR_SHIPMENT_READYベンダーが注文を出荷準備完了とマークしました。Vendor
VENDOR_LABELS_PRINTED_DATEベンダーが配送ラベルを印刷しました。Vendor
VENDOR_CANCELLATION_REQUEST注文のキャンセルが要求されました。Vendor
VENDOR_END_OF_DAY_COMPLETE注文は確定し完了しています。Vendor

vendorOrderStatus cannot be updated by the vendor while the order is in one of the following order statuses:

IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE

HTTPSリクエスト

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

フィールドValue
HTTPメソッドPOST
エンドポイントURLhttps://api.iglobalstores.com/v1/updateVendorOrderStatus
プロトコルHTTPS
メッセージ形式JSON
Accept HTTPヘッダーAccept: application/json
Content-Type HTTPヘッダーContent-Type: application/json

リクエスト本文のJSONキー/値ペア

メッセージ形式: JSON

1{
2 "store": "999",
3 "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
4 "orderId": "999-9999",
5 "orderStatus": "VENDOR_END_OF_DAY_COMPLETE"
6}

リクエストJSON定義

フィールド備考
orderId 必須The Zonos order ID can be passed with or without your store ID and hyphen (Example: 123-45678 or 45678).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
orderStatus 必須This field is used to update the Zonos system with the new status of an order.The following order statuses are settable via this API.- VENDOR_PREPARING_ORDER
  • VENDOR_SHIPMENT_READY
  • VENDOR_LABELS_PRINTED
  • VENDOR_END_OF_DAY_COMPLETE
  • VENDOR_CANCELLATION_REQUEST``string | | secret 必須 | API secret GUID provided by Zonos.string | | store 必須 | Store ID provided by Zonosinteger |

HTTPSレスポンス

メッセージ形式: JSON

1{
2 "success": "Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"
3}

エラーHTTPレスポンス

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 required for updateVendorOrderStatus”
200“error”:“Parameter orderStatus required for updateVendorOrderStatus.”
200“error”:“orderId: 999-99999 is not a valid orderId”
200“error”:“Could not retrieve order to updateVendorOrderStatus from orderId: 999-99999”
200“error”:“OrderId: 999-99999 has already been cancelled and status cannot be updated.”
200“error”:“Cannot update order status to status: VENDOR_CANCELLATION_REQUEST”
200“error”:“Cannot update order status to invalid status: NEW_ORDER_STATUS”
200“error”:“OrderId: 999-99999 already has current status: VENDOR_SHIPMENT_READY”
200“error”:“OrderId: 999-99999 cannot be moved to order status: VENDOR_CANCELLATION_REQUEST while in status: VENDOR_END_OF_DAY_COMPLETE”
200“error”:“New Status: NEW_ORDER_STATUS is not a valid order status”
200“error”:“Could not process updateVendorOrderStatus.”
200“error”:“Invalid security credentials”

レスポンスJSON定義

メッセージ定義
successThis parameter will contain a summary of the update.string
errorThis parameter will only be present in the response when an error has occurred and will contain a description of the cause.string

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


このページでは: