Reports
Reports allow you to retrieve consolidated data about Amazon Pay transactions and settlements. In addition to managing and downloading reports using Seller Central, Amazon Pay offers APIs to manage and retrieve your reports. For a general overview, please visit the Getting started with Reports section of the guide.
- Object definitions and Enums
- 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
- Error codes
Object definitions and Enums
Get Reports Response
Parameter | Description |
---|---|
reports Type: list<Report> |
A list of report objects matching the search criteria. |
nextToken Type: string |
Returned when the number of results exceeds pageSize. To get the next page of results, call getReports with this token as the only parameter. |
Report object
Parameter | Description |
---|---|
reportId Type: string |
The report identifier. |
reportType Type: ReportTypes |
The type of the report. |
startTime Type: dateTime |
Time from which the transactions are included in the report. |
endTime Type: dateTime |
Time to which the transactions are included in the report. |
createdTime Type: dateTime |
Time at which the request to create the report was received. |
processingStatus Type: ProcessingStatus |
The processing status of the report. |
processingStartTime Type: dateTime |
Time at which the request to create report was processed (started processing). |
processingEndTime Type: dateTime |
Time at which the report request was completed and the report was generated. |
reportDocumentId Type: string |
The report document identifier. |
Report Document object
Parameter | Description |
---|---|
reportDocumentId Type:string |
The report document identifier. |
url Type:string |
The url to download the report. Valid for 30 seconds. |
compressionAlgorithm Type:string |
Algorithm used to compress the report content. At this time always "N/A" |
Enum: ProcessingStatus
Value | Description |
---|---|
IN_PROGRESS Type: string |
The report is being processed. |
COMPLETED Type: string |
The report has completed processing. |
FAILED Type: string |
The report was aborted due to a fatal error. |
CANCELLED Type: string |
The report was cancelled. There are two ways a report can be cancelled: an explicit cancellation request before the report starts processing, or an automatic cancellation if there is no data to return. |
Enum: ReportTypes
Value | Description |
---|---|
_GET_FLAT_FILE_OFFAMAZONPAYMENTS_SETTLEMENT_DATA_ Type: string |
Amazon Pay Settlement Report. Automatically created with each settlement. |
_GET_FLAT_FILE_OFFAMAZONPAYMENTS_SANDBOX_SETTLEMENT_DATA_ Type: string |
Amazon Pay Settlement Report based on sandbox transactions. Needs to be manually created. |
_GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATA_ Type: string |
Transaction report listing all orders of a period. |
_GET_FLAT_FILE_OFFAMAZONPAYMENTS_BILLING_AGREEMENT_DATA_ Type: string |
Transaction report listing all recurring contracts of a period. |
_GET_FLAT_FILE_OFFAMAZONPAYMENTS_AUTHORIZATION_DATA_ Type: string |
Transaction report listing all payment authorizations of a period. |
_GET_FLAT_FILE_OFFAMAZONPAYMENTS_CAPTURE_DATA_ Type: string |
Transaction report listing all charges of a period. Note: This report type is currently not available via API. |
_GET_FLAT_FILE_OFFAMAZONPAYMENTS_REFUND_DATA_ Type: string |
Transaction report listing all refunds of a period. |
Get Report Schedules Response Object
Parameter | Description |
---|---|
reportSchedules Type: list<ReportSchedule> |
A list of report schedule objects matching the search criteria. |
Report Schedule Object
Parameter | Description |
---|---|
reportScheduleId Type: string |
The report schedule identifier. |
reportType Type: ReportTypes |
The type of the scheduled report. |
scheduleFrequency Type: ScheduleFrequency |
Frequency defining the interval between report creations. |
nextReportCreationTime Type: dateTime |
Time when the next report will be created. |
Enum: ScheduleFrequency
Value | Description |
---|---|
PT5M Type: string |
Every 5 minutes. |
PT15M Type: string |
Every 15 minutes. |
PT30M Type: string |
Every 30 minutes. |
PT1H Type: string |
Every hour. |
PT2H Type: string |
Every 2 hours. |
PT4H Type: string |
Every 4 hours. |
PT8H Type: string |
Every 8 hours. |
PT12H Type: string |
Every 12 hours. |
PT84H Type: string |
Every 84 hours. |
P1D Type: string |
Every day. |
P2D Type: string |
Every 2 days. |
P3D Type: string |
Every 3 days. |
P7D Type: string |
Every 7 days. |
P14D Type: string |
Every 14 days. |
P15D Type: string |
Every 15 days. |
P18D Type: string |
Every 18 days. |
P30D Type: string |
Every 30 days. |
Operations
Get Reports
Returns report details for the reports that match the filters that you specify.
Request
Request parameters
Name | Location | Description |
---|---|---|
reportTypes (optional) Type: string (comma-separated list of ReportTypes) |
Query Parameter | List of types of reports requested. |
processingStatuses (optional) Type: string (comma-separated list of ProcessingStatus) |
Query Parameter | A list of processing statuses used to filter reports. |
createdSince (optional) Type: string (date-time ISO 8601) |
Query Parameter | The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. Reports are retained for a maximum of 90 days. Default: 90 days |
createdUntil (optional) Type: string (date-time ISO 8601) |
Query Parameter | The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. Reports are retained for a maximum of 90 days. Default: now |
pageSize (optional) Type: number |
Query Parameter | The number of reports per page to return. Minimum: 1 Maximum: 100 Default: 10 |
nextToken (optional) Type: string |
Query Parameter | A string token returned in the response to your previous request. nextToken is returned when the number of results exceeds the specified pageSize value. To get the next page of results, call the getReports operation and include this token as the only parameter. Specifying nextToken with any other parameters will cause the request to fail. |
Response
Returns HTTP 200 status response code if the operation was successful.
{
"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
Returns report details for the given reportId
.
Request
Request parameters
Name | Location | Description |
---|---|---|
reportId (required) Type: string |
Path Parameter | Report identifier |
Response
Returns HTTP 200 status response code if the operation was successful.
{
"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
Submits a request to generate a report based on the reportType
and date range specified.
Request
Request body
{
"reportType": "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_SANDBOX_SETTLEMENT_DATA_",
"startTime": "2022-08-04T00-00-00Z",
"endTime": "2022-08-04T23-59-59Z"
}
Request parameters
Name | Location | Description |
---|---|---|
reportType (required) Type: ReportType |
Body | Type of report to be created. |
startTime (required) Type: string (date-time ISO 8601) |
Body | Time from which the transactions are included in the report. |
endTime (required) Type: string (date-time ISO 8601) |
Body | Time until which the transactions are included in the report. |
Response
Returns HTTP 201 status response code if the operation was successful.
{
"reportId": "A08439021T39K6DTX4JS8",
}
Get Report Document
Returns the pre-signed S3 URL for the report. The report can be downloaded using this URL.
url
with the same precautions as you treat sensitive data itself.Request
Request parameters
Name | Location | Description |
---|---|---|
reportDocumentId (required) Type: string |
Path Parameter | Report Document identifier |
Response
Returns HTTP 200 status response code if the operation was successful.
{
"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
Returns report schedule details that match the filters criteria specified.
Request
Request parameters
Name | Location | Description |
---|---|---|
reportTypes (optional) Type: string (comma-separated list of ReportType) |
Query Parameter | List of report types |
Response
Returns HTTP 200 status response code if the operation was successful.
{
"reportSchedules": [
{
"reportScheduleId" : "68973459224",
"reportType" : "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATA_",
"scheduleFrequency" : "P1D",
"nextReportCreationTime": "20221118T150630Z"
}
]
}
Get Report Schedule By ID
Returns the report schedule details that match the given ID.
Request
Request parameters
Name | Location | Description |
---|---|---|
reportScheduleId (required) Type: string |
Path Parameter | Id of the report schedule |
Response
Returns HTTP 200 status response code if the operation was successful.
{
"reportScheduleId" : "68973459224",
"reportType" : "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATA_",
"scheduleFrequency" : "P1D",
"nextReportCreationTime": "20221118T150630Z"
}
Create Report Schedule
Creates a report schedule for the given reportType
. Only one schedule per report type allowed.
Request
Request parameters
Name | Location | Description |
---|---|---|
deleteExistingSchedule (optional) Type: boolean |
Query Parameter | If true deletes an existing report schedule for the given report type. The API returns an array, if a schedule for the given report type already exists and set to false .
Default: false |
reportType (required) Type: ReportType |
Body | Type of the report for the schedule |
scheduleFrequency (required) Type: ScheduleFrequency |
Body | Frequency in which the report shall be created. |
nextReportCreationTime (required) Type: string (date-time ISO 8601) |
Body | ISO 8601 time defining the next report creation time |
Request body
{
"reportType": "_GET_FLAT_FILE_OFFAMAZONPAYMENTS_ORDER_REFERENCE_DATA_",
"scheduleFrequency": "P1D",
"nextReportCreationTime": "2022-08-06T23-59-59Z"
}
Response
Returns HTTP 201 status response code if the operation was successful.
{
"reportScheduleId": "68973459224",
}
Cancel Report Schedule
Cancels the report schedule with the given reportScheduleId
.
Request
Request parameters
Name | Location | Description |
---|---|---|
reportScheduleId (required) Type: string |
Path Parameter | Report schedule identifier |
Response
Returns HTTP 200 status response code if the operation was successful.
Error codes
Generic errors can be found here.
HTTP status code | Description |
---|---|
400 BAD_REQUEST | Request has missing or invalid parameters and cannot be parsed. |
403 FORBIDDEN | Indicates access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature. |
404 NOT_FOUND | The specified resource does not exist. |
429 TOO_MANY_REQUESTS | The frequency of requests was greater than allowed. |
500 INTERNAL_SERVER_ERROR | An unexpected condition occurred that prevented the server from fulfilling the request. |