ログイン

Reports

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

Note: Sandboxは決済レポート（reportType = GET_FLAT_FILE_OFFAMAZONPAYMENTS_SANDBOX_SETTLEMENT_DATA）のみ利用可能です。その他のレポートはSandboxを利用できません。

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

オブジェクトの定義
Get Reports
Get Report By Id
Create Report
Get Report Document
Get Report Schedules
Get Report Schedule By ID
Create Report Schedule
Cancel Report Schedule
エラーコード

オブジェクトの定義

Get Reports レスポンス

パラメータ	詳細
reports Type: list<Report>	検索条件にマッチするレポートオブジェクトの一覧
nextToken Type: string	検索結果が`pageSize` で指定した値よりも多い場合に返されます。続きの結果を取得する場合は、このnextTokenだけをパラメータで指定してgetReportsを再度実行します。

Report オブジェクト

パラメータ	説明
reportId Type:string	レポートを特定するID
reportType Type: ReportTypes	レポートの種類
startTime Type:dateTime	レポートに含めるトランザクションの日時From
endTime Type:dateTime	レポートに含めるトランザクションの日時To
createdTime Type:dateTime	レポート作成リクエストを受信した日時
processingStatus Type:ProcessingStatus	レポートの処理ステータス
processingStartTime Type:dateTime	レポート作成リクエスト処理を開始した日時.
processingEndTime Type:dateTime	レポート作成リクエスト処理を完了した日時
reportDocumentId Type:string	レポートドキュメントのID

Report Document オブジェクト

パラメータ	説明
reportDocumentId Type:string	レポートドキュメントのID
url Type:string	レポートをダウンロードするためのURL。30秒間のみ有効
compressionAlgorithm Type:string	レポートの圧縮処理で使用したアルゴリズム。ただし、現仕様では常に"N/A"となる。

Enum: ProcessingStatus

Value	説明
IN_PROGRESS Type: string	レポート処理中
COMPLETED Type: string	レポート処理完了
FAILED Type: string	致命的なエラーのためレポート処理を中止
CANCELLED Type: string	レポートキャンセルキャンセルになるケース:レポート処理を開始する前にキャンセル処理を行なった場合、または、レポートに含めるデータがないために自動的にキャンセルされた場合

Enum: ReportTypes

Value	説明
_GET_FLAT_FILE_OFFAMAZONPAYMENTS_SETTLEMENT_DATA_ Type: string	Amazon Pay決済レポート決済の都度自動で生成
_GET_FLAT_FILE_OFFAMAZONPAYMENTS_SANDBOX_SETTLEMENT_DATA_ Type: string	Amazon Pay決済レポート（Sandboxデータ）手動で作成
_GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATA_ Type: string	指定された期間内の全てのOrder Referenceを一覧化したトランザクションレポート
_GET_FLAT_FILE_OFFAMAZONPAYMENTS_BILLING_AGREEMENT_DATA_ Type: string	指定された期間内の全ての継続支払い (Recurring)を一覧化したトランザクションレポート
_GET_FLAT_FILE_OFFAMAZONPAYMENTS_AUTHORIZATION_DATA_ Type: string	指定された期間内の全ての決済オーソリを一覧化したトランザクションレポート
_GET_FLAT_FILE_OFFAMAZONPAYMENTS_CAPTURE_DATA_ Type: string	指定された期間内の全ての売上請求を一覧化したトランザクションレポート
_GET_FLAT_FILE_OFFAMAZONPAYMENTS_REFUND_DATA_ Type: string	指定された期間の全ての返金を一覧化したトランザクションレポート

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

パラメータ	説明
reportSchedules Type: list<ReportSchedule>	検索条件にマッチしたレポートスケジュールの一覧

Report Schedule オブジェクト

パラメータ	説明
reportScheduleId Type: string	レポートスケジュールのID
reportType Type: ReportTypes	レポートの種類
scheduleFrequency Type: ScheduleFrequency	レポート作成頻度
nextReportCreationTime Type: dateTime	次回のレポート作成日時

Enum: ScheduleFrequency

Value	説明
PT5M Type: string	5分毎
PT15M Type: string	15分毎
PT30M Type: string	30分毎
PT1H Type: string	1時間毎
PT2H Type: string	2時間毎
PT4H Type: string	4時間毎
PT8H Type: string	8時間毎
PT12H Type: string	12時間毎
PT84H Type: string	84時間毎
P1D Type: string	日次
P2D Type: string	2日毎
P3D Type: string	3日毎
P7D Type: string	7日毎
P14D Type: string	14日毎
P15D Type: string	15日毎
P18D Type: string	18日毎
P30D Type: string	30日毎

オペレーション

Get Reports

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

リクエスト


curl "https://pay-api.amazon.jp/:version/reports"

-X GET 

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"

-H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"


curl "https://pay-api.amazon.jp/:environment/:version/reports"

-X GET 

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"

-H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"

リクエストパラメータ

名前	ロケーション	説明
reportTypes (任意) Type: string (comma-seperated list of ReportTypes)	Query Parameter	レポートの種類
processingStatuses (任意) Type: string (comma-seperated list of ProcessingStatus)	Query Parameter	レポートの処理ステータス
createdSince (任意) Type: string (date-time ISO 8601)	Query Parameter	検索対象に含めるレポートの作成日時From。ISO8601形式での協定世界時（UTC）日時。作成されたレポートは最長90日間のみ保持されます。デフォルト: 90 日前
createdUntil (任意) Type: string (date-time ISO 8601)	Query Parameter	検索対象に含めるレポートの作成日時To。ISO8601形式での協定世界時（UTC）日時。作成されたレポートは最長90日間のみ保持されます。デフォルト: 現在
pageSize (任意) Type: number	Query Parameter	ページ毎に返すレポートの数。最小: 1 最大: 100 デフォルト: 10
nextToken (任意) Type: string	Query Parameter	直前のリクストに対するレスポンスで返ってくる `nextToken` の値を指定します。直前のリクエストを実行した際に `pageSize` で指定した値よりも多い結果が存在する場合にnextTokenが返ります。続きの結果を取得する場合は、このnextTokenのみをパラメータで指定してgetReportsを再度実行します。 `nextToken` を指定してAPI実行する際に、他のパラメータも一緒に指定するとエラーが発生します。

レスポンス

処理が成功した場合、HTTP 200 ステータスコードを返します。

{
     "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のレポート詳細を返します。

リクエスト


curl "https://pay-api.amazon.jp/:version/reports/:reportdId"

-X GET 

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"


curl "https://pay-api.amazon.jp/:environment/:version/reports/:reportdId"

-X GET 

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"

リクエストパラメータ

名前	ロケーション	説明
reportId (必須) Type: string	Path Parameter	レポートのID

レスポンス

処理が成功した場合、HTTP 200 ステータスコードを返します。

{
      "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 および期間レポートに応じたレポートの作成リクエストを送ります。

リクエスト


curl "https://pay-api.amazon.jp/:version/reports"

-X POST 

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"

-H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"

-d @request_body


curl "https://pay-api.amazon.jp/:environment/:version/reports"

-X POST 

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"

-H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"

-d @request_body

リクエストボディ

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

リクエストパラメータ

Name	Location	Description
reportType (必須) Type: ReportType	Body	レポートの種類
startTime (必須) Type: string (date-time ISO 8601)	Body	レポートに含めるトランザクションの期間開始日時
endTime (必須) Type: string (date-time ISO 8601)	Body	レポートに含めるトランザクションの期間終了日時

レスポンス

処理が成功した場合、HTTP 201 ステータスコードを返します。

{
     "reportId": "A08439021T39K6DTX4JS8",
}

Get Report Document

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

Note: レポートにはセンシティブ情報が含まれる可能性があります。url の取り扱いにおいては、通常のその他センシティブ情報取扱時と同様の予防措置をお願いいたします。

リクエスト


curl "https://pay-api.amazon.jp/:version/report-documents/:reportDocumentId"

-X GET 

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"


curl "https://pay-api.amazon.jp/:environment/:version/report-documents/:reportDocumentId"

-X GET 

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"

リクエストパラメータ

名前	ロケーション	説明
reportDocumentId (必須) Type: string	Path Parameter	レポートドキュメントのID

レスポンス

処理が成功した場合、HTTP 200 ステータスコードを返します。

{
      "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

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

リクエスト


curl "https://pay-api.amazon.jp/:environment/:version/report-schedules"

-X GET 

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"


curl "https://pay-api.amazon.jp/:environment/:version/report-schedules"

-X GET 

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"

リクエストパラメータ

Name	Location	Description
reportTypes (任意) Type: string (comma-seperated list of ReportType)	Query Parameter	レポートの種類リスト

レスポンス

処理が成功した場合、HTTP 200 ステータスコードを返します。

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

Get Report Schedule By ID

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

リクエスト


curl "https://pay-api.amazon.jp/:version/report-schedules/:reportScheduleId"

-X GET 

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"


curl "https://pay-api.amazon.jp/:environment/:version/report-schedules/:reportScheduleId"

-X GET 

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"

リクエストパラメータ

Name	Location	Description
reportScheduleId (required) Type: string	Path Parameter	レポートスケジュールのID

レスポンス

処理が成功した場合、HTTP 200 ステータスコードを返します。


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

Create Report Schedule

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

リクエスト


curl "https://pay-api.amazon.jp/:version/report-schedules"

-X POST 

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"

-H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"

-d @request_body


curl "https://pay-api.amazon.jp/:environment/:version/report-schedules"

-X POST 

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"

-H "x-amz-pay-idempotency-key:AVLo5tI10BHgEk2jEXAMPLEKEY"

-d @request_body

リクエストパラメータ

名前	ロケーション	説明
deleteExistingSchedule (任意) Type: boolean	Query Parameter	`true`を指定した場合は、指定した reportType の既存のレポートスケジュールを削除します。 `false`を指定して実行した際に当該 reportType のスケジュールがすでに存在している場合は、APIで配列を返します。デフォルト: `false`
reportType (必須) Type: ReportType	Body	スケジュールを作成したいレポートの種類
scheduleFrequency (必須) Type: ScheduleFrequency	Body	レポートを作成する頻度
nextReportCreationTime (必須) Type: string (date-time ISO 8601)	Body	ISO 8601形式での次回レポート作成日時

リクエストボディ

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

レスポンス

処理が成功した場合、HTTP 201 ステータスコードを返します。

{
     "reportScheduleId": "68973459224",
}

Cancel Report Schedule

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

リクエスト


curl "https://pay-api.amazon.jp/:version/report-schedules/:reportScheduleId" \

-X DELETE

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"


curl "https://pay-api.amazon.jp/:environment/:version/report-schedules/:reportScheduleId" 

-X DELETE

-H "authorization:Px2e5oHhQZ88vVhc0DO%2FsShHj8MDDg%3DEXAMPLESIGNATURE"

-H "x-amz-pay-date:20201012T235046Z"

リクエストパラメータ

名前	ロケーション	説明
reportScheduleId (必須) Type: string	Path Parameter	レポートスケジュールのID

レスポンス

処理が成功した場合、HTTP 200 ステータスコードを返します。

エラーコード

一般的なエラーコードはこちらを参照してください。

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