DOCS

Update order status

/
Checkout•
ホームAPIリファレンス Checkout REST API 注文ステータスの更新

注文ステータスの更新

注文ステータスを更新するエンドポイントの動作を学びましょう。

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_SHIPMENT_READYベンダーは注文を出荷準備完了とマークしました。ベンダー
VENDOR_LABELS_PRINTED_DATEベンダーは配送ラベルを印刷しました。ベンダー
VENDOR_CANCELLATION_REQUEST注文のキャンセルがリクエストされました。ベンダー
VENDOR_END_OF_DAY_COMPLETE注文は最終化され、完了しました。ベンダー

vendorOrderStatus は、以下のいずれかの注文ステータスの間、ベンダーによって更新することはできません：

IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE

HTTPSリクエスト

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

フィールド値
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
3
4
5
6
{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "orderId": "999-9999",
  "orderStatus": "VENDOR_END_OF_DAY_COMPLETE"
}

リクエスト JSON 定義

フィールドノート
orderId 必須Zonos の注文 ID は、ストア ID とハイフンを含めることも含めないこともできます（例：123-45678 または 45678）。注文の完了と支払い後、顧客はあなたのドメインにホストされた注文完了 / 注文感謝ページにリダイレクトされます。URL には、orderID というクエリ文字列パラメータが含まれ、この値が含まれます。integer / string
orderStatus 必須このフィールドは、Zonos システムに注文の新しいステータスを更新するために使用されます。次の注文ステータスは、この API を介して設定可能です。- VENDOR_PREPARING_ORDER
  • VENDOR_SHIPMENT_READY
  • VENDOR_LABELS_PRINTED
  • VENDOR_END_OF_DAY_COMPLETE
  • VENDOR_CANCELLATION_REQUEST string | | secret 必須 | Zonos によって提供された API シークレット GUID。string | | store 必須 | Zonos によって提供されたストア ID。integer |

HTTPS レスポンス

メッセージ形式: JSON

成功レスポンスの例

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

例外エラー応答

1
2
3
{
  "error": "OrderId: 99999 cannot be moved to order status: VENDOR_PREPARING_ORDER while in status: IGLOBAL_FRAUD_REVIEW"
}

エラーHTTPレスポンス

HTTPレスポンスコードレスポンスボディの例/説明
406 - Not AcceptableHTMLエンティティ。HTTP “Accept”ヘッダーが無効です。
415 - Unsupported media typeHTMLエンティティ。HTTP “Content-Type”ヘッダーが無効です。
200“error”:“入力を解析できませんでした”
200“error”:“updateVendorOrderStatusに必要なパラメータorderId”
200“error”:“updateVendorOrderStatusに必要なパラメータorderStatus。”
200“error”:“orderId: 999-99999は有効なorderIdではありません”
200“error”:“orderId: 999-99999からupdateVendorOrderStatusを取得できませんでした”
200“error”:“OrderId: 999-99999はすでにキャンセルされており、ステータスを更新できません。”
200“error”:“ステータスをVENDOR_CANCELLATION_REQUESTに更新できません”
200“error”:“無効なステータス: NEW_ORDER_STATUSにステータスを更新できません”
200“error”:“OrderId: 999-99999は現在のステータス: VENDOR_SHIPMENT_READYを持っています”
200“error”:“OrderId: 999-99999はステータス: VENDOR_END_OF_DAY_COMPLETEの間にorder status: VENDOR_CANCELLATION_REQUESTに移動できません”
200“error”:“新しいステータス: NEW_ORDER_STATUSは有効なorder statusではありません”
200“error”:“updateVendorOrderStatusを処理できませんでした。”
200“error”:“無効なセキュリティ資格情報”

レスポンスJSON定義

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

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

Zonosを見る

ポリシーと契約
© 2024 Zonoszonos.com
このページには：