v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB
Reports v2021-06-30

getReports

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

Usage Plan:

Rate (requests per second)Burst
0.022210

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.

get/reports/2021-06-30/reports

Query parameters

reportTypesstring[]

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.

processingStatusesstring[]

A list of processing statuses used to filter reports.

marketplaceIdsstring[]

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

pageSizeinteger

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

createdSincestring date-time

The earliest report creation date and time for reports to include in the response, in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date time format. The default is 90 days ago. Reports are retained for a maximum of 90 days.

createdUntilstring date-time

The latest report creation date and time for reports to include in the response, in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date time format. The default is now.

nextTokenstring

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

Success.

nextTokenstring

Returned when the number of results exceeds pageSize. To get the next page of results, call getReports with this token as the only parameter.