getReports

get https://sellingpartnerapi-na.amazon.com/reports/2021-06-30/reports

Returns report details for the reports that match the filters that you specify.

Usage Plan:

Rate (requests per second)	Burst
0.0222	10

The x-amzn-RateLimit-Limit response header returns the usage plan rate limits that were applied to the requested operation, when available. The table above indicates the default rate and burst values for this operation. Selling partners whose business demands require higher throughput may see higher rate and burst values than those shown here. For more information, refer to Usage Plans and Rate Limits in the Selling Partner API.

Query Params

reportTypes

array of strings

length between 1 and 10

A list of report types used to filter reports. Refer to Report Type Values for more information. When reportTypes is provided, the other filter parameters (processingStatuses, marketplaceIds, createdSince, createdUntil) and pageSize may also be provided. Either reportTypes or nextToken is required.

reportTypes

processingStatuses

array of strings

length ≥ 1

A list of processing statuses used to filter reports.

Show Details

CANCELLED	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.
DONE	The report has completed processing.
FATAL	The report was aborted due to a fatal error.
IN_PROGRESS	The report is being processed.
IN_QUEUE	The report has not yet started processing. It may be waiting for another `IN_PROGRESS` report.

processingStatuses

marketplaceIds

array of strings

length between 1 and 10

A list of marketplace identifiers used to filter reports. The reports returned will match at least one of the marketplaces that you specify.

marketplaceIds

pageSize

integer

1 to 100

Defaults to 10

The maximum number of reports to return in a single call.

createdSince

date-time

The earliest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days.

createdUntil

date-time

The latest report creation date and time for reports to include in the response, in ISO 8601 date time format. The default is now.

nextToken

string

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.

200

Success.

Response body

object

reports

array of objects

required

A list of reports.

reports*

object

marketplaceIds

array of strings

A list of marketplace identifiers for the report.

marketplaceIds

reportId

string

required

The identifier for the report. This identifier is unique only in combination with a seller ID.

reportType

string

required

The report type. Refer to Report Type Values for more information.

dataStartTime

date-time

The start of a date and time range used for selecting the data to report.

dataEndTime

date-time

The end of a date and time range used for selecting the data to report.

reportScheduleId

string

The identifier of the report schedule that created this report (if any). This identifier is unique only in combination with a seller ID.

createdTime

date-time

required

The date and time when the report was created.

processingStatus

string

required

The processing status of the report.

CANCELLED DONE FATAL IN_PROGRESS IN_QUEUE

Show Details

CANCELLED	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.
DONE	The report has completed processing.
FATAL	The report was aborted due to a fatal error.
IN_PROGRESS	The report is being processed.
IN_QUEUE	The report has not yet started processing. It may be waiting for another `IN_PROGRESS` report.

processingStartTime

date-time

The date and time when the report processing started, in ISO 8601 date time format.

processingEndTime

date-time

The date and time when the report processing completed, in ISO 8601 date time format.

reportDocumentId

string

The identifier for the report document. Pass this into the getReportDocument operation to get the information you will need to retrieve the report document's contents.

nextToken

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.

Headers

object

x-amzn-RateLimit-Limit

string

Your rate limit (requests per second) for this operation.

x-amzn-RequestId

string

Unique request reference identifier.

400

Request has missing or invalid parameters and cannot be parsed.

401

The request's Authorization header is not formatted correctly or does not contain a valid token.

403

Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404

The specified resource does not exist.

415

The request's Content-Type header is invalid.

429

The frequency of requests was greater than allowed.

500

An unexpected condition occurred that prevented the server from fulfilling the request.

503

Temporary overloading or maintenance of the server.

xxxxxxxxxx
curl --request GET \
     --url 'https://sellingpartnerapi-na.amazon.com/reports/2021-06-30/reports?reportTypes=&processingStatuses=CANCELLED&marketplaceIds=&pageSize=10' \
     --header 'accept: application/json'

xxxxxxxxxx
 
{
  "reports": [
    {
      "marketplaceIds": [
        "string"
      ],
      "reportId": "string",
      "reportType": "string",
      "dataStartTime": "2025-04-01T15:05:11.110Z",
      "dataEndTime": "2025-04-01T15:05:11.110Z",
      "reportScheduleId": "string",
      "createdTime": "2025-04-01T15:05:11.110Z",
      "processingStatus": "CANCELLED",
      "processingStartTime": "2025-04-01T15:05:11.110Z",
      "processingEndTime": "2025-04-01T15:05:11.110Z",
      "reportDocumentId": "string"
    }
  ],
  "nextToken": "string"
}

200Success.

400Request has missing or invalid parameters and cannot be parsed.

401The request's Authorization header is not formatted correctly or does not contain a valid token.

403Indicates that access to the resource is forbidden. Possible reasons include Access Denied, Unauthorized, Expired Token, or Invalid Signature.

404The specified resource does not exist.

415The request's Content-Type header is invalid.

429The frequency of requests was greater than allowed.

500An unexpected condition occurred that prevented the server from fulfilling the request.

503Temporary overloading or maintenance of the server.