getReportDocument

Pending

GET

/reports/2021-06-30/documents/{reportDocumentId}

Reports

Last modified:2024-12-13 05:22:02

Maintainer:Sarath S

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.

Request

Path Params

reportDocumentId

string

required

The identifier for the report document.

Example:

0356cf79-b8b0-4226-b4b9-0ee058ea5760

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://sandbox.sellingpartnerapi-na.amazon.com/reports/2021-06-30/documents/0356cf79-b8b0-4226-b4b9-0ee058ea5760'

Responses

🟢200OK

application/json

Success.

Headers

x-amzn-RateLimit-Limit

string

optional

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

x-amzn-RequestId

string

optional

Unique request reference identifier.

Body

Information required for the report document.

reportDocumentId

string

required

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

url

string

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

enum<string>

optional

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.

Allowed value:

GZIP

Example

{
    "reportDocumentId": "string",
    "url": "string",
    "compressionAlgorithm": "GZIP"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable

getReportSchedule

getOrderMetrics