現在の注文ステータス値は？

現在の注文ステータス値には、IGLOBAL_FRAUD_REVIEW、IGLOBAL_ORDER_IN_PROCESS、IGLOBAL_ORDER_ON_HOLD、IGLOBAL_ORDER_CANCELLED、VENDOR_PREPARING_ORDER、VENDOR_SHIPMENT_READY、VENDOR_LABELS_PRINTED_DATE、VENDOR_CANCELLATION_REQUEST、VENDOR_END_OF_DAY_COMPLETEが含まれます。

updateVendorOrderStatus APIエンドポイントのHTTPSリクエスト形式は？

HTTPSリクエストには、HTTPメソッド、エンドポイントURL、プロトコル、メッセージ形式、Accept HTTPヘッダー、Content-Type HTTPヘッダーが含まれます。リクエスト本文のJSONキー/値ペアにはorderId、orderStatus、secret、storeが含まれます。

取り得るエラーHTTPレスポンスは？

取り得るエラーHTTPレスポンスには、406 - Not Acceptable、415 - Unsupported media type、およびさまざまなエラーメッセージ付きの200レスポンスが含まれます。

Checkout•

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

注文ステータスの更新

Q: updateVendorOrderStatus APIエンドポイントの目的は？

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

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

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を更新できません。

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
エンドポイントURL	`https://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 必須 Zonos注文IDは、ストアIDとハイフンを付けて渡すことも、付けずに渡すこともできます（例：123-45678または45678）。注文完了と支払いが完了すると、お客様はお客様のドメインでホストされている注文完了/サンクスページにリダイレクトされます。URLには、この値を含むクエリ文字列パラメータorderIDが含まれます。integer / string

orderStatus 必須このフィールドは、注文の新しいステータスでZonosシステムを更新するために使用します。このAPIで設定可能な注文ステータスは以下の通りです。- VENDOR_PREPARING_ORDER

フィールド↕	備考↕
`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が提供するストアIDinteger |

HTTPSレスポンス

メッセージ形式: JSON

1{

2 "success": "Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"

3}

エラーHTTPレスポンス

HTTPレスポンスコード↕	レスポンス本文の例/説明↕
406 - Not Acceptable	HTMLエンティティ。HTTP “Accept”ヘッダーが無効です。
415 - Unsupported media type	HTMLエンティティ。HTTP “Content-Type”ヘッダーが無効です。
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定義

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

デモを予約する