getReports - Amazon SP API

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

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, 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

Query Params

reportTypes

array[string]

optional

>= 1 items<= 10 items

Example:

["FEE_DISCOUNTS_REPORT,GET_AFN_INVENTORY_DATA"]

processingStatuses

array[string]

optional

>= 1 items

Allowed values:

CANCELLEDDONEFATALIN_PROGRESSIN_QUEUE

Example:

["IN_QUEUE,IN_PROGRESS"]

marketplaceIds

array[string]

optional

>= 1 items<= 10 items

Example:

[""]

pageSize

integer

optional

>= 1<= 100

Default:

createdSince

string <date-time>

optional

createdUntil

string <date-time>

optional

nextToken

string

optional

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

The response for the `getReports` operation.

reports

array[object (Report) {11}]

required

A list of reports.

marketplaceIds

array[string]

optional

A list of marketplace identifiers for the report.

reportId

string

required

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

reportType

string

required

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

dataStartTime

string <date-time>

optional

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

dataEndTime

string <date-time>

optional

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

reportScheduleId

string

optional

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

createdTime

string <date-time>

required

The date and time when the report was created.

processingStatus

enum<string>

required

The processing status of the report.

Allowed values:

CANCELLEDDONEFATALIN_PROGRESSIN_QUEUE

processingStartTime

string <date-time>

optional

The date and time when the report processing started, in ISO 8601 date time format.

processingEndTime

string <date-time>

optional

The date and time when the report processing completed, in ISO 8601 date time format.

reportDocumentId

string

optional

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.

nextToken

string

optional

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

Example

{
    "reports": [
        {
            "marketplaceIds": [
                "string"
            ],
            "reportId": "string",
            "reportType": "string",
            "dataStartTime": "2019-08-24T14:15:22Z",
            "dataEndTime": "2019-08-24T14:15:22Z",
            "reportScheduleId": "string",
            "createdTime": "2019-08-24T14:15:22Z",
            "processingStatus": "CANCELLED",
            "processingStartTime": "2019-08-24T14:15:22Z",
            "processingEndTime": "2019-08-24T14:15:22Z",
            "reportDocumentId": "string"
        }
    ],
    "nextToken": "string"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠415415

🟠429429

🔴500Server Error

🔴503Service Unavailable