注文を取得

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

エンドポイント 

注文番号

注文番号のリストを取得します。

注文の詳細

注文に関する詳細情報を取得します。

注文を取得するAPIエンドポイントの使用法

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

1. (パート1 + パート2) – ドメイン上のカスタム注文確認/成功ページを使用して、システムがorderDetailエンドポイントを呼び出し、完了した注文をインポートするようにトリガーします。さらに、定期的にorderNumbersエンドポイントを呼び出して、Zonosシステム内でインポートされていない注文を照合します。
2. (パート2のみ) – Zonosの基本的な注文確認/成功ページまたはドメイン上の静的ページを使用して、顧客に注文の完了を示します。システムを定期的にorderNumbersエンドポイントを呼び出すようにスケジュールし、新しい注文がシステムにインポートされる準備ができているかを確認します。未処理の注文が見つかった場合は、その注文のデータを取得するためにorderDetailエンドポイントを呼び出します。

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

購入者がZonos Checkoutで注文を完了するたびに、すぐに注文成功ページのURLにリダイレクトされます。完了した注文IDは、リダイレクトURLにクエリ文字列として追加されます。注文成功ページのURLはZonosに提供する必要があります。このURLは、Zonosシステム内で一時カートを作成する際にcreateTempCartエンドポイントのパラメータとしても渡すことができます。

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

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

パート2: スケジュールされたジョブを使用

成功ページがトリガーされたときに注文の詳細を呼び出すことに加えて、すべての注文とその詳細のためにスケジュールされた呼び出しを設定することをお勧めします。これにより、Zonosシステム内でまだインポートされていない完了した注文を取得できます。

このプロセスは、1時間/シフト/日などの頻度で実行されるスケジュールされたジョブ/スクリプト（ビジネスプロセスに必要な頻度でスケジュール）であるべきです。スクリプトは、最後の注文呼び出し以降に発生したすべての注文とその詳細を呼び出す必要があります。orderNumbersエンドポイントを使用すると、sinceOrderIdまたはsinceDateで注文を取得できます。すべての注文は、成功ページがトリガーされるたびにシステムに挿入された注文と照合されるべきです。システムにまだ存在しない注文は、システムに挿入され、正当な注文として扱われるべきです。

初期注文ステータス

IGLOBAL_ORDER_IN_PROCESSまたは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

アカウントの資格情報についてはサポートに連絡してください。