---
title: Reports
url: ja/amazon-pay-api-v2/ja-reports.html
---

Amazon Payのトランザクションおよび決済に関するデータをレポートで取得することが可能です。
これらのレポートの管理および取得は、セラーセントラルで行うことができますが、これに加えてAmazon Payではレポートの管理および取得用のAPIを提供しています。
概要は *[インテグレーションの準備をする](../amazon-pay-reports/ja-getting-started.html)* をご確認ください。

<div markdown="span" class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note:</b> Sandboxは決済レポート（reportType = _GET_FLAT_FILE_OFFAMAZONPAYMENTS_SANDBOX_SETTLEMENT_DATA_）のみ利用可能です。その他のレポートはSandboxを利用できません。</div>

サポートされている操作:

<div style="display:none" class="environmentSpecificKeys">
<ul id="profileTabs" class="nav nav-tabs">
  <li class="nav-item"><a class="active nav-link noExtIcon" href="#ustab" data-toggle="tab">US</a></li>
  <li class="nav-item"><a class="nav-link noExtIcon" href="#eutab" data-toggle="tab">EU / UK</a></li>
  <li class="nav-item"><a class="nav-link noExtIcon" href="#jptab" data-toggle="tab">JP</a></li>
</ul>
<div class="tab-content">
<div role="tabpanel" class="tab-pane active" id="ustab" markdown="block">   
<div markdown="block">
* **Get Reports** - GET https://pay-api.amazon.com/:version/reports
* **Get Report By Id** - GET https://pay-api.amazon.com/:version/reports/:reportdId
* **Create Report** - POST https://pay-api.amazon.com/:version/reports
* **Get Report Document** - GET https://pay-api.amazon.com/:version/report-documents/:reportDocumentId
* **Get Report Schedules** - GET https://pay-api.amazon.com/:version/report-schedules
* **Get Report Schedule By Id** - GET https://pay-api.amazon.com/:version/report-schedules/:reportScheduleId
* **Create Report Schedule** - POST https://pay-api.amazon.com/:version/report-schedules
* **Cancel Report Schedule** - DELETE https://pay-api.amazon.com/:version/report-schedules/:reportScheduleId
</div>
</div>
  <div role="tabpanel" class="tab-pane" id="eutab" markdown="block">
<div markdown="block">
* **Get Reports** - GET https://pay-api.amazon.eu/:version/reports
* **Get Report By Id** - GET https://pay-api.amazon.eu/:version/reports/:reportdId
* **Create Report** - POST https://pay-api.amazon.eu/:version/reports
* **Get Report Document** - GET https://pay-api.amazon.eu/:version/report-documents/:reportDocumentId
* **Get Report Schedules** - GET https://pay-api.amazon.eu/:version/report-schedules
* **Get Report Schedule By Id** - GET https://pay-api.amazon.eu/:version/report-schedules/:reportScheduleId
* **Create Report Schedule** - POST https://pay-api.amazon.eu/:version/report-schedules
* **Cancel Report Schedule** - DELETE https://pay-api.amazon.eu/:version/report-schedules/:reportScheduleId
</div>
  </div>
  <div role="tabpanel" class="tab-pane" id="jptab" markdown="block">
<div markdown="block">
* **Get Reports** - GET https://pay-api.amazon.jp/:version/reports
* **Get Report By Id** - GET https://pay-api.amazon.jp/:version/reports/:reportdId
* **Create Report** - POST https://pay-api.amazon.jp/:version/reports
* **Get Report Document** - GET https://pay-api.amazon.jp/:version/report-documents/:reportDocumentId
* **Get Report Schedules** - GET https://pay-api.amazon.jp/:version/report-schedules
* **Get Report Schedule By Id** - GET https://pay-api.amazon.jp/:version/report-schedules/:reportScheduleId
* **Create Report Schedule** - POST https://pay-api.amazon.jp/:version/report-schedules
* **Cancel Report Schedule** - DELETE https://pay-api.amazon.jp/:version/report-schedules/:reportScheduleId
</div>
  </div>
</div>
</div>
<div style="display:none" class="notEnvironmentSpecificKeys">
<ul id="profileTabs" class="nav nav-tabs">
  <li class="nav-item"><a class="active nav-link noExtIcon" href="#ustabNESK" data-toggle="tab">US</a></li>
  <li class="nav-item"><a class="nav-link noExtIcon" href="#eutabNESK" data-toggle="tab">EU / UK</a></li>
  <li class="nav-item"><a class="nav-link noExtIcon" href="#jptabNESK" data-toggle="tab">JP</a></li>
</ul>
<div class="tab-content">
  <div role="tabpanel" class="tab-pane active" id="ustabNESK" markdown="block">   
<div markdown="block">
* **Get Reports** - GET https://pay-api.amazon.com/:environment/:version/reports
* **Get Report By Id** - GET https://pay-api.amazon.com/:environment/:version/reports/:reportdId
* **Create Report** - POST https://pay-api.amazon.com/:environment/:version/reports
* **Get Report Document** - GET https://pay-api.amazon.com/:environment/:version/report-documents/:reportDocumentId
* **Get Report Schedules** - GET https://pay-api.amazon.com/:environment/:version/report-schedules
* **Get Report Schedule By Id** - GET https://pay-api.amazon.com/:environment/:version/report-schedules/:reportScheduleId
* **Create Report Schedule** - POST https://pay-api.amazon.com/:environment/:version/report-schedules
* **Cancel Report Schedule** - DELETE https://pay-api.amazon.com/:environment/:version/report-schedules/:reportScheduleId
</div>
  </div>
  <div role="tabpanel" class="tab-pane" id="eutabNESK" markdown="block">
<div markdown="block">
* **Get Reports** - GET https://pay-api.amazon.eu/:environment/:version/reports
* **Get Report By Id** - GET https://pay-api.amazon.eu/:environment/:version/reports/:reportdId
* **Create Report** - POST https://pay-api.amazon.eu/:environment/:version/reports
* **Get Report Document** - GET https://pay-api.amazon.eu/:environment/:version/report-documents/:reportDocumentId
* **Get Report Schedules** - GET https://pay-api.amazon.eu/:environment/:version/report-schedules
* **Get Report Schedule By Id** - GET https://pay-api.amazon.eu/:environment/:version/report-schedules/:reportScheduleId
* **Create Report Schedule** - POST https://pay-api.amazon.eu/:environment/:version/report-schedules
* **Cancel Report Schedule** - DELETE https://pay-api.amazon.eu/:environment/:version/report-schedules/:reportScheduleId
</div>
  </div>
  <div role="tabpanel" class="tab-pane" id="jptabNESK" markdown="block">
<div markdown="block">
* **Get Reports** - GET https://pay-api.amazon.jp/:environment/:version/reports
* **Get Report By Id** - GET https://pay-api.amazon.jp/:environment/:version/reports/:reportdId
* **Create Report** - POST https://pay-api.amazon.jp/:environment/:version/reports
* **Get Report Document** - GET https://pay-api.amazon.jp/:environment/:version/report-documents/:reportDocumentId
* **Get Report Schedules** - GET https://pay-api.amazon.jp/:environment/:version/report-schedules
* **Get Report Schedule By Id** - GET https://pay-api.amazon.jp/:environment/:version/report-schedules/:reportScheduleId
* **Create Report Schedule** - POST https://pay-api.amazon.jp/:environment/:version/report-schedules
* **Cancel Report Schedule** - DELETE https://pay-api.amazon.jp/:environment/:version/report-schedules/:reportScheduleId
</div>
  </div>
</div>
</div>

<!-- prettier-ignore-start -->
* TOC
{:toc}
{::options toc_levels="3" /}

***
<!-- prettier-ignore-end -->

### オブジェクトの定義

#### Get Reports レスポンス

<table width="100%" border="1">
    <colgroup>
        <col width="30%" />
        <col width="70%" />
    </colgroup>
    <thead>
        <tr class="header">
            <th>パラメータ</th>
            <th>詳細</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td markdown="span">reports
            <br>Type: list&lt;Report&gt;<br /></td>
            <td markdown="span">検索条件にマッチするレポートオブジェクトの一覧</td>
        </tr>
        <tr>
            <td markdown="span">nextToken  
            <br>Type: string<br /></td>
            <td markdown="span">検索結果が`pageSize` で指定した値よりも多い場合に返されます。続きの結果を取得する場合は、このnextTokenだけをパラメータで指定してgetReportsを再度実行します。</td>
        </tr>
    </tbody>
</table>

#### Report オブジェクト

<table>
  <colgroup>
    <col width="30%" />
    <col width="70%" />
  </colgroup>
  <thead>
    <tr class="header">
      <th>パラメータ</th>
      <th>説明</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td markdown="span">reportId<br /><br /> Type:string</td>
      <td markdown="span">レポートを特定するID</td>
    </tr>
    <tr>
      <td markdown="span">reportType<br /><br /> Type: <a href="#enum-reporttypes">ReportTypes</a></td>
      <td markdown="span">レポートの種類</td>
    </tr>
      <tr><td markdown="span">startTime<br /><br /> Type:dateTime</td>
      <td markdown="span">レポートに含めるトランザクションの日時From</td>
    </tr>
    <tr>
      <td markdown="span">endTime<br /><br /> Type:dateTime</td>
      <td markdown="span">レポートに含めるトランザクションの日時To</td>
    </tr>
    <tr>
      <td markdown="span">createdTime<br /><br /> Type:dateTime</td>
      <td markdown="span">レポート作成リクエストを受信した日時</td>
    </tr>
    <tr>
      <td markdown="span">processingStatus<br /><br /> Type:<a href="#enum-processingstatus">ProcessingStatus</a></td>
      <td markdown="span">レポートの処理ステータス</td>
    </tr>
    <tr>
      <td markdown="span">processingStartTime<br /><br /> Type:dateTime</td>
      <td markdown="span">レポート作成リクエスト処理を開始した日時.</td>
    </tr>
    <tr>
      <td markdown="span">processingEndTime<br /><br /> Type:dateTime</td>
      <td markdown="span">レポート作成リクエスト処理を完了した日時</td>
    </tr>
    <tr>
      <td markdown="span">reportDocumentId<br /><br /> Type:string</td>
      <td markdown="span">レポートドキュメントのID</td>
    </tr>

  </tbody>
</table>

#### Report Document オブジェクト

<table>
  <colgroup>
    <col width="30%" />
    <col width="70%" />
  </colgroup>
  <thead>
    <tr class="header">
      <th>パラメータ</th>
      <th>説明</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td markdown="span">reportDocumentId<br /><br /> Type:string</td>
      <td markdown="span">レポートドキュメントのID</td>
    </tr>
    <tr>
      <td markdown="span">url<br /><br /> Type:string</td>
      <td markdown="span">レポートをダウンロードするためのURL。30秒間のみ有効</td>
    </tr>
      <tr><td markdown="span">compressionAlgorithm<br /><br /> Type:string</td>
      <td markdown="span">レポートの圧縮処理で使用したアルゴリズム。ただし、現仕様では常に"N/A"となる。</td>
    </tr>
    
  </tbody>
</table>

#### _Enum_: ProcessingStatus

<table>
  <colgroup>
    <col width="30%" />
    <col width="70%" />
  </colgroup>
  <thead>
    <tr class="header">
      <th>Value</th>
      <th>説明</th>
    </tr>
  </thead>
  <tbody>
  <tr>
      <td markdown="span">IN_PROGRESS<br /><br /> Type: string</td>
      <td markdown="span">レポート処理中</td>
    </tr>
    <tr>
      <td markdown="span">COMPLETED<br /><br /> Type: string</td>
      <td markdown="span">レポート処理完了</td>
    </tr>
    <tr>
      <td markdown="span">FAILED<br /><br /> Type: string</td>
      <td markdown="span">致命的なエラーのためレポート処理を中止</td>
    </tr>
    <tr>
      <td markdown="span">CANCELLED<br /><br /> Type: string</td>
      <td markdown="span">レポートキャンセル<br /> キャンセルになるケース:レポート処理を開始する前にキャンセル処理を行なった場合、または、レポートに含めるデータがないために自動的にキャンセルされた場合</td>
    </tr>
  </tbody>
</table>

#### _Enum_: ReportTypes

<table>
  <colgroup>
    <col width="40%" />
    <col width="60%" />
  </colgroup>
  <thead>
    <tr class="header">
      <th>Value</th>
      <th>説明</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td markdown="span">\_GET_FLAT_FILE_OFFAMAZONPAYMENTS_SETTLEMENT_DATA\_<br /><br /> Type: string</td>
      <td markdown="span">Amazon Pay決済レポート<br />決済の都度自動で生成</td>
    </tr>
    <tr>
      <td markdown="span">\_GET_FLAT_FILE_OFFAMAZONPAYMENTS_SANDBOX_SETTLEMENT_DATA\_<br /><br /> Type: string</td>
      <td markdown="span">Amazon Pay決済レポート（Sandboxデータ）<br /> 手動で作成</td>
    </tr>
    <tr>
      <td markdown="span">\_GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATA\_<br /><br /> Type: string</td>
      <td markdown="span">指定された期間内の全てのOrder Referenceを一覧化したトランザクションレポート</td>
    </tr>
    <tr>
      <td markdown="span">\_GET_FLAT_FILE_OFFAMAZONPAYMENTS_BILLING_AGREEMENT_DATA\_<br /><br /> Type: string</td>
      <td markdown="span">指定された期間内の全ての継続支払い (Recurring)を一覧化したトランザクションレポート</td>
    </tr>
    <tr>
      <td markdown="span">\_GET_FLAT_FILE_OFFAMAZONPAYMENTS_AUTHORIZATION_DATA\_<br /><br /> Type: string</td>
      <td markdown="span">指定された期間内の全ての決済オーソリを一覧化したトランザクションレポート</td>
    </tr>
    <tr>
      <td markdown="span">\_GET_FLAT_FILE_OFFAMAZONPAYMENTS_CAPTURE_DATA\_<br /><br /> Type: string</td>
      <td markdown="span">指定された期間内の全ての売上請求を一覧化したトランザクションレポート</td>
    </tr>
    <tr>
      <td markdown="span">\_GET_FLAT_FILE_OFFAMAZONPAYMENTS_REFUND_DATA\_<br /><br /> Type: string</td>
      <td markdown="span">指定された期間の全ての返金を一覧化したトランザクションレポート</td>
    </tr>
  </tbody>
</table>

#### Get Report Schedules レスポンスオブジェクト

<table border="1">
  <colgroup>
    <col width="30%" />
    <col width="70%" />
  </colgroup>
  <thead>
    <tr class="header">
      <th>パラメータ</th>
      <th>説明</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td markdown="span">reportSchedules<br /><br /> Type: list&lt;<a href="#report-schedule-オブジェクト">ReportSchedule</a>&gt;</td>
      <td markdown="span">検索条件にマッチしたレポートスケジュールの一覧</td>
    </tr>
  </tbody>
</table>

#### Report Schedule オブジェクト

<table border="1">
  <colgroup>
    <col width="30%" />
    <col width="70%" />
  </colgroup>
  <thead>
    <tr class="header">
      <th>パラメータ</th>
      <th>説明</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td markdown="span">reportScheduleId<br /><br /> Type: string</td>
      <td markdown="span">レポートスケジュールのID</td>
    </tr>
    <tr>
      <td markdown="span">reportType<br /><br /> Type: <a href="#enum-reporttypes">ReportTypes</a></td>
      <td markdown="span">レポートの種類</td>
    </tr>
      <tr><td markdown="span">scheduleFrequency<br /><br /> Type: <a href="#enum-schedulefrequency">ScheduleFrequency</a></td>
      <td markdown="span">レポート作成頻度</td>
    </tr>
    <tr>
      <td markdown="span">nextReportCreationTime<br /><br /> Type: dateTime</td>
      <td markdown="span">次回のレポート作成日時</td>
    </tr>
  </tbody>
</table>

#### _Enum_: ScheduleFrequency

<table border="1">
  <colgroup>
    <col width="40%" />
    <col width="60%" />
  </colgroup>
  <thead>
    <tr class="header">
      <th>Value</th>
      <th>説明</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td markdown="span">PT5M<br /><br /> Type: string</td>
      <td markdown="span">5分毎</td>
    </tr>
    <tr>
      <td markdown="span">PT15M<br /><br /> Type: string</td>
      <td markdown="span">15分毎</td>
    </tr><tr>
      <td markdown="span">PT30M<br /><br /> Type: string</td>
      <td markdown="span">30分毎</td>
    </tr>
    <tr>
      <td markdown="span">PT1H<br /><br /> Type: string</td>
      <td markdown="span">1時間毎</td>
    </tr>
    <tr>
      <td markdown="span">PT2H<br /><br /> Type: string</td>
      <td markdown="span">2時間毎</td>
    </tr>
    <tr>
      <td markdown="span">PT4H<br /><br /> Type: string</td>
      <td markdown="span">4時間毎</td>
    </tr>
    <tr>
      <td markdown="span">PT8H<br /><br /> Type: string</td>
      <td markdown="span">8時間毎</td>
    </tr>
    <tr>
      <td markdown="span">PT12H<br /><br /> Type: string</td>
      <td markdown="span">12時間毎</td>
    </tr>
    <tr>
      <td markdown="span">PT84H<br /><br /> Type: string</td>
      <td markdown="span">84時間毎</td>
    </tr>
    <tr>
      <td markdown="span">P1D<br /><br /> Type: string</td>
      <td markdown="span">日次</td>
    </tr>
    <tr>
      <td markdown="span">P2D<br /><br /> Type: string</td>
      <td markdown="span">2日毎</td>
    </tr>
    <tr>
      <td markdown="span">P3D<br /><br /> Type: string</td>
      <td markdown="span">3日毎</td>
    </tr>
     <tr>
      <td markdown="span">P7D<br /><br /> Type: string</td>
      <td markdown="span">7日毎</td>
    </tr>
     <tr>
      <td markdown="span">P14D<br /><br /> Type: string</td>
      <td markdown="span">14日毎</td>
    </tr>
     <tr>
      <td markdown="span">P15D<br /><br /> Type: string</td>
      <td markdown="span">15日毎</td>
    </tr>
     <tr>
      <td markdown="span">P18D<br /><br /> Type: string</td>
      <td markdown="span">18日毎</td>
    </tr>
     <tr>
      <td markdown="span">P30D<br /><br /> Type: string</td>
      <td markdown="span">30日毎</td>
    </tr>
  </tbody>
</table>

## オペレーション

### Get Reports

指定した検索条件にマッチするレポートの詳細を返します。

#### リクエスト

<div style="display:none" class="environmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.jp/:version/reports"<br />
-X GET <br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
-H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"<br />
</code>
</div>
<div style="display:none" class="notEnvironmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.jp/:environment/:version/reports"<br />
-X GET <br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
-H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"<br />
</code>

</div>

#### リクエストパラメータ

<table>
    <colgroup>
        <col width="30%" />
        <col width="20%" />
        <col width="50%" />
    </colgroup>
    <thead>
        <tr class="header">
            <th>名前</th>
            <th>ロケーション</th>
            <th>説明</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td markdown="span">reportTypes<br />(任意)<br /><br />Type: string (comma-seperated list of <a href="../amazon-pay-api-v2/ja-reports.md#enum-reporttypes">ReportTypes</a>)</td>
            <td markdown="span">Query Parameter</td>
            <td markdown="span">レポートの種類</td>
        </tr>
        <tr>
            <td markdown="span">processingStatuses<br />(任意)<br /><br />Type: string (comma-seperated list of <a href="../amazon-pay-api-v2/ja-reports.md#enum-processingstatus">ProcessingStatus</a>)</td>
            <td markdown="span">Query Parameter</td>
            <td markdown="span">レポートの処理ステータス</td>
        </tr>
        <tr>
            <td markdown="span">createdSince<br />(任意)<br /><br />Type: string (date-time ISO 8601)</td>
            <td markdown="span">Query Parameter</td>
            <td markdown="span">検索対象に含めるレポートの作成日時From。ISO8601形式での協定世界時（UTC）日時 。作成されたレポートは最長90日間のみ保持されます。<br /><br />デフォルト: *90 日前*</td>
        </tr>
        <tr>
            <td markdown="span">createdUntil<br />(任意)<br /><br />Type: string (date-time ISO 8601)</td>
            <td markdown="span">Query Parameter</td>
            <td markdown="span">検索対象に含めるレポートの作成日時To。ISO8601形式での協定世界時（UTC）日時 。作成されたレポートは最長90日間のみ保持されます。<br /><br />デフォルト: *現在*</td>
        </tr>
        <tr>
            <td markdown="span">pageSize<br />(任意)<br /><br />Type: number</td>
            <td markdown="span">Query Parameter</td>
            <td markdown="span">ページ毎に返すレポートの数。<br />最小: *1*<br />最大: *100*<br /><br />デフォルト: *10*</td>
        </tr>
        <tr>
            <td markdown="span">nextToken<br />(任意)<br /><br />Type: string</td>
            <td markdown="span">Query Parameter</td>
            <td markdown="span">直前のリクストに対するレスポンスで返ってくる `nextToken` の値を指定します。<br />直前のリクエストを実行した際に `pageSize` で指定した値よりも多い結果が存在する場合にnextTokenが返ります。<br />続きの結果を取得する場合は、このnextTokenのみをパラメータで指定してgetReportsを再度実行します。<br />`nextToken` を指定してAPI実行する際に、他のパラメータも一緒に指定するとエラーが発生します。</td>
        </tr>
    </tbody>
</table>


#### レスポンス

処理が成功した場合、<a href="https://restfulapi.net/http-status-200-ok" target="_blank" rel="noopener noreferrer">HTTP 200</a> ステータスコードを返します。

```
{
     "nextToken" : "nt-50c2d472-2c4f-2d48-3b38-1116b37e0404",
     "reports": [{
        "reportId": "A08439021T39K6DTX4JS8",
        "reportType": "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_SETTLEMENT_DATA_",
        "startTime":"20221118T150630Z",
        "endTime":"20221202T150350Z",
        "createdTime":"20221207T170826Z",
        "processingStatus": "COMPLETED",
        "processingStartTime":"20221207T170826Z",
        "processingEndTime":"20221207T170826Z",
        "reportDocumentId": "amzn1.tortuga.3.45ee712dc-3512-6cbd-ad71-ab3cb4cffef7.T3FKJJI01Y1E32"
     }]
}
```



### Get Report By Id

指定した`reportId`のレポート詳細を返します。

#### リクエスト

<div style="display:none" class="environmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.jp/:version/reports/:reportdId"<br />
-X GET <br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
</code>

</div>
<div style="display:none" class="notEnvironmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.jp/:environment/:version/reports/:reportdId"<br />
-X GET <br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
</code>

</div>

#### リクエストパラメータ

<table>
    <colgroup>
        <col width="30%" />
        <col width="20%" />
        <col width="50%" />
    </colgroup>
    <thead>
        <tr class="header">
            <th>名前</th>
            <th>ロケーション</th>
            <th>説明</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td markdown="span">reportId<br />**(必須)**<br /><br />Type: string</td>
            <td markdown="span">Path Parameter</td>
            <td markdown="span">レポートのID</td>
        </tr>
    </tbody>
</table>


#### レスポンス

処理が成功した場合、<a href="https://restfulapi.net/http-status-200-ok" target="_blank" rel="noopener noreferrer">HTTP 200</a> ステータスコードを返します。

```
{
      "reportId": "A08439021T39K6DTX4JS8",
      "reportType": "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_SETTLEMENT_DATA_",
      "startTime":"20221118T150630Z",
      "endTime":"20221202T150350Z",
      "createdTime":"20221207T170826Z",
      "processingStatus": "COMPLETED",
      "processingStartTime":"20221207T170826Z",
      "processingEndTime":"20221207T170826Z",
      "reportDocumentId": "amzn1.tortuga.3.45ee712dc-3512-6cbd-ad71-ab3cb4cffef7.T3FKJJI01Y1E32"
}
```


### Create Report

指定した `reportType` および 期間レポートに応じたレポートの作成リクエストを送ります。

#### リクエスト

<div style="display:none" class="environmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.jp/:version/reports"<br />
-X POST <br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
-H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"<br />
-d @request_body<br />
</code>

</div>
<div style="display:none" class="notEnvironmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.jp/:environment/:version/reports"<br />
-X POST <br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
-H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"<br />
-d @request_body<br />
</code>

</div>

#### リクエストボディ

```
{
    "reportType": "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATA_",
    "startTime": "20220804T000000Z",
    "endTime": "20220804T235959Z"
}
```

#### リクエストパラメータ

<table border="1">
    <colgroup>
        <col width="30%" />
        <col width="20%" />
        <col width="50%" />
    </colgroup>
    <thead>
        <tr class="header">
            <th>Name</th>
            <th>Location</th>
            <th>Description</th>
        </tr>
    </thead>
    <tbody>
         <tr>
            <td markdown="span">reportType<br />(必須)<br /><br />Type: <a href="#enum-reporttypes">ReportType</a></td>
            <td markdown="span">Body</td>
            <td markdown="span">レポートの種類</td>
        </tr>
        <tr>
            <td markdown="span">startTime<br />(必須)<br /><br />Type: string (date-time ISO 8601)</td>
            <td markdown="span">Body</td>
            <td markdown="span">レポートに含めるトランザクションの期間開始日時</td>
        </tr>
        <tr>
            <td markdown="span">endTime<br />(必須)<br /><br />Type: string (date-time ISO 8601)</td>
            <td markdown="span">Body</td>
            <td markdown="span">レポートに含めるトランザクションの期間終了日時</td>
        </tr>
    </tbody>
</table>


#### レスポンス

処理が成功した場合、<a href="https://restfulapi.net/http-status-201-created" target="_blank" rel="noopener noreferrer">HTTP 201</a> ステータスコードを返します。

```
{
     "reportId": "A08439021T39K6DTX4JS8",
}
```


### Get Report Document

レポートの署名済みS3 URLを返します。取得したURLを使ってレポートをダウンロードします。

<div markdown="span" class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note:</b> レポートにはセンシティブ情報が含まれる可能性があります。``url`` の取り扱いにおいては、通常のその他センシティブ情報取扱時と同様の予防措置をお願いいたします。</div>

#### リクエスト

<div style="display:none" class="environmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.jp/:version/report-documents/:reportDocumentId"<br />
-X GET <br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
</code>

</div>
<div style="display:none" class="notEnvironmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.jp/:environment/:version/report-documents/:reportDocumentId"<br />
-X GET <br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
</code>

</div>

#### リクエストパラメータ

<table>
    <colgroup>
        <col width="30%" />
        <col width="20%" />
        <col width="50%" />
    </colgroup>
    <thead>
        <tr class="header">
            <th>名前</th>
            <th>ロケーション</th>
            <th>説明</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td markdown="span">reportDocumentId<br />**(必須)**<br /><br />Type: string</td>
            <td markdown="span">Path Parameter</td>
            <td markdown="span">レポートドキュメントのID</td>
        </tr>
    </tbody>
</table>


#### レスポンス

処理が成功した場合、<a href="https://restfulapi.net/http-status-200-ok" target="_blank" rel="noopener noreferrer">HTTP 200</a> ステータスコードを返します。

```
{
      "reportDocumentId" : "amzn1.tortuga.3.45ee712dc-3512-6cbd-ad71-ab3cb4cffef7.T3FKJJI01Y1E32",
      "url" : ""https://tortuga-[...].amazonaws.com/<reportDocumentId>?X-Amz-Algorithm=...&X-Amz-Signature=...",
      "compressionAlgorithm" : "N/A"
}
```


### Get Report Schedules

指定したパラメータにマッチしたレポートスケジュールの詳細を返します。

#### リクエスト

<div style="display:none" class="environmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.jp/:environment/:version/report-schedules"<br />
-X GET <br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
</code>

</div>
<div style="display:none" class="notEnvironmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.jp/:environment/:version/report-schedules"<br />
-X GET <br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
</code>

</div>

#### リクエストパラメータ

<table>
    <colgroup>
        <col width="30%" />
        <col width="20%" />
        <col width="50%" />
    </colgroup>
    <thead>
        <tr class="header">
            <th>Name</th>
            <th>Location</th>
            <th>Description</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td markdown="span">reportTypes<br />(任意)<br /><br />Type: string (comma-seperated list of <a href="../amazon-pay-api-v2/ja-reports.md#enum-reporttypes">ReportType</a>)</td>
            <td markdown="span">Query Parameter</td>
            <td markdown="span">レポートの種類リスト</td>
        </tr>
    </tbody>
</table>


#### レスポンス

処理が成功した場合、<a href="https://restfulapi.net/http-status-200-ok" target="_blank" rel="noopener noreferrer">HTTP 200</a> ステータスコードを返します。

```
{
      "reportSchedules": [
            {
                  "reportScheduleId" : "68973459224",
                  "reportType" : "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATA_",
                  "scheduleFrequency" : "P1D",
                  "nextReportCreationTime": "20221118T150630Z"
            }
      ]
}
```


### Get Report Schedule By ID

指定したIDにマッチしたレポートスケジュールの詳細を返します。

#### リクエスト

<div style="display:none" class="environmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.jp/:version/report-schedules/:reportScheduleId"<br />
-X GET <br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
</code>

</div>
<div style="display:none" class="notEnvironmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.jp/:environment/:version/report-schedules/:reportScheduleId"<br />
-X GET <br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
</code>

</div>

#### リクエストパラメータ

<table border="1">
    <colgroup>
        <col width="30%" />
        <col width="20%" />
        <col width="50%" />
    </colgroup>
    <thead>
        <tr class="header">
            <th>Name</th>
            <th>Location</th>
            <th>Description</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td markdown="span">reportScheduleId<br />(required)<br /><br />Type: string</td>
            <td markdown="span">Path Parameter</td>
            <td markdown="span">レポートスケジュールのID</td>
        </tr>
    </tbody>
</table>


#### レスポンス

処理が成功した場合、<a href="https://restfulapi.net/http-status-200-ok" target="_blank" rel="noopener noreferrer">HTTP 200</a> ステータスコードを返します。

```

{
      "reportScheduleId" : "68973459224",
      "reportType" : "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATA_",
      "scheduleFrequency" : "P1D",
      "nextReportCreationTime": "20221118T150630Z"
}

```


### Create Report Schedule

指定した `reportType` のレポートスケジュールを作成します。設定できるスケジュールは、reportTypeごとに１つのみです。

#### リクエスト

<div style="display:none" class="environmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.jp/:version/report-schedules"<br />
-X POST <br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
-H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"<br />
-d @request_body<br />
</code>

</div>
<div style="display:none" class="notEnvironmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.jp/:environment/:version/report-schedules"<br />
-X POST <br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
-H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"<br />
-d @request_body<br />
</code>

</div>

#### リクエストパラメータ

<table>
    <colgroup>
        <col width="30%" />
        <col width="20%" />
        <col width="50%" />
    </colgroup>
    <thead>
        <tr class="header">
            <th>名前</th>
            <th>ロケーション</th>
            <th>説明</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td markdown="span">deleteExistingSchedule<br />(任意)<br /><br />Type: boolean</td>
            <td markdown="span">Query Parameter</td>
            <td markdown="span">`true`を指定した場合は、指定した reportType の既存のレポートスケジュールを削除します。<br />
            `false`を指定して実行した際に当該 reportType のスケジュールがすでに存在している場合は、APIで配列を返します。
            <br /><br />デフォルト: `false`</td>
        </tr>
        <tr>
            <td markdown="span">reportType<br />(必須)<br /><br />Type: <a href="../amazon-pay-api-v2/ja-reports.md#enum-reporttypes">ReportType</a></td>
            <td markdown="span">Body</td>
            <td markdown="span">スケジュールを作成したいレポートの種類</td>
        </tr>
        <tr>
            <td markdown="span">scheduleFrequency<br />(必須)<br /><br />Type: <a href="../amazon-pay-api-v2/ja-reports.md#enum-schedulefrequency">ScheduleFrequency</a></td>
            <td markdown="span">Body</td>
            <td markdown="span">レポートを作成する頻度</td>
        </tr>
        <tr>
            <td markdown="span">nextReportCreationTime<br />(必須)<br /><br />Type: string (date-time ISO 8601)</td>
            <td markdown="span">Body</td>
            <td markdown="span">ISO 8601形式での次回レポート作成日時</td>
        </tr>
    </tbody>
</table>


#### リクエストボディ

```
{
    "reportType": "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATA_",
    "scheduleFrequency": "P1D",
    "nextReportCreationTime": "20220806T235959Z"
}
```


#### レスポンス

処理が成功した場合、<a href="https://restfulapi.net/http-status-201-created" target="_blank" rel="noopener noreferrer">HTTP 201</a> ステータスコードを返します。

```
{
     "reportScheduleId": "68973459224",
}
```


### Cancel Report Schedule

指定した `reportScheduleId` のレポートスケジュールをキャンセルします。

#### リクエスト

<div style="display:none" class="environmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.jp/:version/report-schedules/:reportScheduleId" \<br />
-X DELETE<br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
</code>

</div>
<div style="display:none" class="notEnvironmentSpecificKeys">
<code style="color:black">
curl "https://pay-api.amazon.jp/:environment/:version/report-schedules/:reportScheduleId" <br />
-X DELETE<br />
-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"<br />
-H "x-amz-pay-date:20201012T235046Z"<br />
</code>

</div>

#### リクエストパラメータ

<table>
    <colgroup>
        <col width="30%" />
        <col width="20%" />
        <col width="50%" />
    </colgroup>
    <thead>
        <tr class="header">
            <th>名前</th>
            <th>ロケーション</th>
            <th>説明</th>
        </tr>
    </thead>
    <tbody>
        <tr>
            <td markdown="span">reportScheduleId<br />**(必須)**<br /><br />Type: string</td>
            <td markdown="span">Path Parameter</td>
            <td markdown="span">レポートスケジュールのID</td>
        </tr>
    </tbody>
</table>


#### レスポンス

処理が成功した場合、<a href="https://restfulapi.net/http-status-200-ok" target="_blank" rel="noopener noreferrer">HTTP 200</a> ステータスコードを返します。

### エラーコード

一般的なエラーコードは<a href="../amazon-pay-api-v2/ja-error-handling.md" target="_blank" rel="noopener noreferrer">こちら</a>を参照してください。

<table>
  <colgroup>
    <col width="30%" />
    <col width="70%" />
  </colgroup>
  <thead>
    <tr class="header">
      <th>HTTP status code</th>
      <th>説明</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td markdown="span">400 BAD_REQUEST</td>
      <td markdown="span">パラメータが不足または無効です。</td>
    </tr>
    <tr>
      <td markdown="span">403 FORBIDDEN </td>
      <td markdown="span">リソースへのアクセスが許可されていません。理由の可能性として、Access Denied、Unauthorized、Expired Token、Invalid Signatureなどが考えられます。</td>
    </tr>
    <tr>
      <td markdown="span">404 NOT_FOUND</td>
      <td markdown="span">特定のリソースが存在しません。</td>
    </tr>
    <tr>
      <td markdown="span">429 TOO_MANY_REQUESTS</td>
      <td markdown="span">閾値よりも多くのリクエストが実行されました。</td>
    </tr>
    <tr>
      <td markdown="span">500 INTERNAL_SERVER_ERROR</td>
      <td markdown="span">想定外の状態が発生し、サーバー側でリクエストを実行できませんでした。</td>
    </tr>
  </tbody>
</table>