Amazon Services Japan
Amazonマーケットプレイス Web サービス (Amazon MWS) ドキュメント
Amazon MWS ドキュメント

Amazon MWSレポートAPIセクションについて知っておくべきこと

AmazonマーケットプレイスWebサービス(Amazon MWS) APIのレポートAPIセクションでは、Amazonでの出品ビジネスをサポートする様々なレポートをリクエストできます。レポートの種類は、ReportTypes列挙子を使用して指定します。

重要: Amazonは、新しいフィールドとフィールド値を定期的にレポートに追加します。Amazon MWSアプリケーション内には、このようなレポートの更新を適切に処理できるレポートパーサーを構築してください。詳しくは、Building robust Amazon MWS applicationsを参照してください。

レポート処理を開始するには、レポートリクエストを作成します。次に、レポートリクエストIDとリクエストした各レポートのステータスを示す、レポートリクエストのリストを取得します。最後に、このリストのレポートリクエストIDを使用して、実際のレポートを取得します。処理の手順は以下のとおりです。

  1. RequestReportオペレーションを使用して、レポートリクエストを送信します。これは、Amazon MWSに特定のレポートを生成するためのリクエストです。また、ManageReportScheduleオペレーションを使用して、定期的に送信される注文やAmazonプロダクトアドレポートリクエストをスケジュールすることもできます。
  2. GetReportRequestListオペレーションを使用してリクエストを送信し、レポートリクエストのリストおよび各レポートリクエストのステータスとIDを取得します。 Amazon MWS は、リクエストした各レポートのReportRequestIdを返します。Amazon MWSによってレポートリクエストのステータスが_DONE_に設定されているレポートを取得できます。一部のレポートでは、GeneratedReportIdが作成されます。これは、GetReportオペレーションに渡すことができます(手順4を参照)。レポートリクエストをキャンセルする場合は、CancelReportRequestsオペレーションを使用します。
  3. GeneratedReportIdが作成されない場合は、GetReportListオペレーションを使ってリクエストを送信します。取得するレポートのReportRequestIdを含めます。オペレーションがReportIdを返します。これは、GetReportオペレーションに渡すことができます(手順4を参照)。
  4. 特定のレポートを取得するには、GetReportオペレーションを使用してリクエストを送信します。受信するレポートのGeneratedReportIdまたはReportIdをリクエストに含めます。次に、レポートが送信中に破損していないことを確認するために、Content-MD5ヘッダーを処理します。Content-MD5ヘッダでの作業の詳細については、Amazon MWS開発者ガイドを参照してください。

次のフローチャートは、レポートのリクエストの送受信のプロセスを表しています。

ManageReportScheduleオペレーションを使用して、レポートのリクエストをスケジュールし、定期的に送信できます。Schedule列挙子を使用して、レポートリクエストを送信する時間や期間を指定できます。また、GetReportScheduleListオペレーションを使用して、スケジュールしたレポートリクエストのリストを取得することもできます。

次のフローチャートはスケジュールしたレポートリクエストの送受信のプロセスを表しています。

レポートAPIセクションのオペレーション

レポートAPIセクションには、以下のオペレーションが含まれています。

オペレーション 説明 利用可否
RequestReport レポートリクエストを作成し、リクエストをAmazon MWSに送信します。 すべてのマーケットプレイス
GetReportRequestList レポートのReportRequestIdを取得するときに使用できる、レポートリクエストのリストを返します。 すべてのマーケットプレイス
GetReportRequestListByNextToken NextTokenを使用してレポートリクエストのリストを返します。NextTokenは、前回のGetReportRequestListByNextTokenまたはGetReportRequestListのリクエストでHasNextの値がtrueのときに発行されます。 すべてのマーケットプレイス
GetReportRequestCount 処理のためにAmazon MWSに送信されたレポートリクエストの数を返します。 すべてのマーケットプレイス
CancelReportRequests 1件以上のレポートリクエストをキャンセルします。 すべてのマーケットプレイス
GetReportList 過去90日間に作成されたレポートのリストを返します。 すべてのマーケットプレイス
GetReportListByNextToken NextTokenを使用してレポートのリストを返します。NextTokenは、前回のGetReportListByNextTokenまたはGetReportListのリクエストでHasNextの値がtrueのときに発行されます。 すべてのマーケットプレイス
GetReportCount 過去90日間に作成され、ステータスが_DONE_でダウンロード可能なレポート数を返します。 すべてのマーケットプレイス
GetReport レポート内容および返されたレポート本文に対するContent-MD5ヘッダを返します。 すべてのマーケットプレイス
ManageReportSchedule 指定したレポートタイプのレポートリクエストのスケジュールを作成、更新、または削除します。 すべてのマーケットプレイス
GetReportScheduleList 処理のためにAmazon MWSへの送信がスケジュールされている注文レポートリクエストのリストを返します。 すべてのマーケットプレイス
GetReportScheduleListByNextToken GetReportScheduleListオペレーションは100件以上の結果を返すことができないので、現時点でこのオペレーションが呼び出されることはありません。このオペレーションは、将来の互換性のために含められています。 すべてのマーケットプレイス
GetReportScheduleCount Amazon MWSへの送信がスケジュールされている、注文レポートリクエストの数を返します。 すべてのマーケットプレイス
UpdateReportAcknowledgements 1件以上のレポートの確認ステータスを更新します。 すべてのマーケットプレイス