v1

latestOpenAPI 3.0.0Apache License 2.02026-07-263171,5614.1 MB

Reports v2021-06-30

getReportDocument

Returns the information required for retrieving a report document's contents.

Usage Plan:

Rate (requests per second)	Burst
0.0167	15

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/documents/{reportDocumentId}

Path parameters

reportDocumentIdstring required

The identifier for the report document.

Query parameters

enableContentEncodingUrlHeaderboolean

When true, the Content-Encoding header on the returned URL is set to gzip instead of the default identity when compressionAlgorithm is GZIP. This allows automatic decompression by HTTP clients.

Response

Success.

reportDocumentIdstring required

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

urlstring required

A presigned URL for the report document. If compressionAlgorithm is not returned, you can download the report directly from this URL. This URL expires after 5 minutes.

compressionAlgorithm'GZIP'

If the report document contents have been compressed, the compression algorithm used is returned in this property and you must decompress the report when you download. Otherwise, you can download the report directly. Refer to Step 2. Download the report in the use case guide, where sample code is provided.