注文の取得

この「注文の取得」APIエンドポイントは、Zonosシステム内の完了済み注文データを取得するために使用します。レスポンスには、請求・配送先住所、配送方法、注文合計、ステータスなど、注文の利用可能なすべての情報を表すJSONオブジェクトが含まれます。

エンドポイント 

注文番号

注文番号の一覧を取得します。

注文詳細

注文の詳細情報を取得します。

注文取得APIエンドポイントの使い方

これらのエンドポイントの一般的な使い方は2つあります。

1. （パート1 + パート2）– 自社ドメインのカスタム注文確認/成功ページでシステムにorderDetailエンドポイントを呼び出させ、完了済み注文をインポートします。さらに、orderNumbersエンドポイントを定期呼び出しし、システム未インポートのZonosシステム注文を照合します。
2. （パート2のみ）– Zonosの基本注文確認/成功ページ、または自社ドメインの静的ページで顧客に注文完了を示します。orderNumbersエンドポイントを定期呼び出しするようスケジュールし、システムへインポート可能な新規注文を検知します。未処理注文が見つかったら、orderDetailエンドポイントでその注文データを取得します。

パート1: 自社ドメインの成功ページ

買い手がZonos Checkoutで注文を完了するたびに、注文成功ページURLへ即座にリダイレクトされます。完了した注文IDはクエリ文字列としてリダイレクトURLに付与されます。注文成功ページのURLはZonosに提供してください。Zonosシステムで一時カート作成時にcreateTempCartエンドポイントのパラメータとしても渡せます。

例: http://www.examplestore.com/internationalThankYou?orderId=999-99999

顧客がこのページへリダイレクトされたら、システムはURLからorderIdの値を解析する必要があります。その後、そのorderIdでorderDetailエンドポイントを呼び出し、注文データを取得します。

パート2: スケジュール済みジョブの使用

成功ページ起動時の注文詳細取得に加え、すべての注文とその詳細を対象にしたスケジュール呼び出しをキャッチオールとして設定することを推奨します。これにより、まだシステムへインポートされていないZonosシステムの完了済み注文を取得できます。

このプロセスは、Cronジョブなどのスケジュール済みジョブ/スクリプトとして、1時間/シフト/日ごとなどに実行します（業務プロセスに必要な頻度でスケジュールしてください）。スクリプトは前回の注文取得以降に発生したすべての注文とその詳細を取得する必要があります。orderNumbersエンドポイントでは、APIテストGUIで示されるようにsinceOrderIdまたはsinceDateで注文を取得できます。このスケジュール呼び出しで取得した注文は、成功ページ起動時にシステムへ挿入された注文と照合してください。まだシステムにない注文は挿入し、正当な注文として扱います。

初期注文ステータス

IGLOBAL_ORDER_IN_PROCESS or IGLOBAL_FRAUD_REVIEW

orderDetailエンドポイントを呼び出す際は、まず注文データのorderStatusプロパティを確認することを推奨します。

不正レビューが不要な注文はorderStatus : IGLOBAL_ORDER_IN_PROCESSで初期化されます。このステータスの注文は処理・出荷の準備ができています。

不正レビューが必要な注文はorderStatus : IGLOBAL_FRAUD_REVIEWで初期化されます。このステータスの注文は不正の疑いでスクリーニング・レビュー中です。システムではレビューまたは保留ステータスにし、Zonosの不正レビューを通過するまでorderDetailエンドポイントを呼び出し続けることを推奨します。

Zonosの不正スクリーニングが完了すると、注文は次のいずれかの状態に移行します:

• 注文が不正スクリーニングに合格

  • 注文はorderStatus : IGLOBAL_ORDER_IN_PROCESSへ移行し、出荷へ進めます。

• 注文が不正スクリーニングに不合格

  • 注文はorderStatus : IGLOBAL_ORDER_CANCELLEDへ移行し、システムでキャンセルしてください。

APIテストGUI

アカウント認証情報についてはサポートにお問い合わせください。