Sign in

v1

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

getReport

Returns report details (including the reportDocumentId, if available) for the report that you specify.

Usage Plan:

Rate (requests per second)Burst
215

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/{reportId}

Path parameters

reportIdstring required

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

Response

Success.

marketplaceIdsstring[]

A list of marketplace identifiers for the report.

reportIdstring required

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

reportTypestring required

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

dataStartTimestring date-time

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

dataEndTimestring date-time

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

reportScheduleIdstring

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

createdTimestring date-time required

The date and time when the report was created.

processingStatus'CANCELLED' | 'DONE' | 'FATAL' | 'IN_PROGRESS' | 'IN_QUEUE' required

The processing status of the report.

processingStartTimestring date-time

The date and time when the report processing started, in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date time format.

processingEndTimestring date-time

The date and time when the report processing completed, in <a href='https://developer-docs.amazon.com/sp-api/docs/iso-8601'>ISO 8601</a> date time format.

reportDocumentIdstring

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.