getReports

get

https://api.business.amazon.com/reports/2021-09-30/reports

Returns detailed pdf reports that match your filter criteria.

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. The preceding table indicates the default rate and burst values for this operation. For questions about your usage plan, reach out to your Amazon Business technical contact.

📘
To test this API, populate each required input field with the pre-defined example values.

Query Params

reportTypes

array of strings

length between 1 and 10

A list of report types used to filter reports. 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 processing hasn't started. The system may be waiting for another report to complete.

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 as a response to the 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.

Responses

📘

200getReports request has been submitted.

400The request has missing or invalid parameters and can't be parsed.

401The request authorization header is formatted incorrectly or the token is invalid.

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

404The specified resource doesn't 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.

503The system is experiencing a temporary overloading or a system maintenance is ongoing.